Sublime PML

       

Sublime Text 4 syntax support for PML (Practical Markup Language).

• https://github.com/tajmone/Sublime-PML — source repository.
• https://tajmone.github.io/Sublime-PML — online user guide.

Created by Tristano Ajmone in March, 2021; released under MIT License.

---

Table of Contents

• About PML
• Installation Instructions
  • System Requirements
• Package Status
• Package Features
• License
• Credits
• Contributing
• Links

---

About PML

The Practical Markup Language (PML) is a new, free, advanced document markup language.

PML simplifies the process of writing technical and non-technical web articles and books that look good out-of-the-box and are highly customizable.

PML is still in its early days, but it is well suited for many kinds of web documents.

PML was designed by Christian Neumanns around 2019, and since February 2021 the full source code of the PML conversion tool is available on GitHub under GPLv2 license:

• https://github.com/pml-lang/pml-companion

Precompiled binaries of the PML converter for Windows and Linux can be downloaded from the official website.

For more information on how PML was born, and its advantages over other lightweight markup languages, see Christian Neumanns's article We need a new document markup language — here is why.

Installation Instructions

Currently there are no plans to submit this package to the official Package Control channel, so you'll need Git on you machine in order to install it and keep it updated.

The following instructions will allow you to install this package from GitHub using Sublime Text's native Package Control tool even though the package is not listed at the Package Control website/channel.

1. Open the Command Palette by pressing Ctrl+Shift+P (Windows and Linux) or ⌘+Shift+P (Mac).

2. Select the Package Control: Add Repository command (by clicking it with the mouse or pressing enter).

   • You'll see an input box appear at the bottom of the editor interface, next to a label stating "GitHub, GitLab or BitBucket Web URL...". Copy and paste in the input box the URL of this repository:

       https://github.com/tajmone/Sublime-PML
     

3. Open again the Command Palette and select the Package Control: Install Package command.

   • Now the Sublime-PML package will be listed among the packages available for installation: find it and select it to proceed with its installation.

After installation, the Sublime-PML package will be automatically updated whenever a new release is available.

System Requirements

In order to use this package, you'll need the following tools:

• Sublime Text 4 — older versions of Sublime Text will not be supported, this package will make use of the new features added in ST4.

• Git — required to install this package and keep it updated (i.e. until it's submitted to Package Control).

• PML binaries — required if you want to benefit from the package's build systems, and other features which depend on pmlc being available on the System PATH. In any case, why would anyone want to install the PML package if he/she doesn't have the PML tools in the first place?

  MAC USERS WARNING — At the time of this writing, precompiled PML binaries for the macOS are not yet available. Refer to the pml-lang/pml-companion source repository to compile them yourself.

Package Status

This package is still a work-in-progress Alpha project, moving toward the Beta stage; syntax scopes and features might be subject to frequent changes, as everything is still experimental right now. Other than that, the package is fully usable in production and offers decent support for PML editing and syntax highlighting.

For detailed info about the PML syntax elements implementation status and their roadmap, see PACKAGE_STATUS.md.

There are no guarantees that this package will ever be completed, and no plans to submit it to Package Control's official channel.

Package Features

For the full list of features currently available in Sublime PML see the online user guide:

• https://tajmone.github.io/Sublime-PML

License

• LICENSE

MIT License

Copyright (c) 2021-2023 Tristano Ajmone

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Credits

This repository uses the following third party assets:

• Relaxed Theme colour scheme, by Michael Kühnel (see schemes/README.md for full credits).

Contributing

• CONTRIBUTING.md

Contributions to this repository are most welcome, whether in the form of suggestions and bug reports via Issues and Discussions, or as actual repository contents submitted via Git.

All pull requests should be made against the dev branch. For more information, please refer to our Contributors' Guidelines.

Links

• www.pml-lang.dev — PML website:
  • PML Reference Manual
  • PML User Manual

Articles

Articles by Christian Neumanns:

• We need a new document markup language  — here is why
• The advantages of Document Markup Languages vs WYSIWYG editors

PML on GitHub

• @pml-lang — PML Lang organization:
  • pml-lang/pml-companion — source code repository of the PML to HTML Converter tool.
  • pml-lang/pml-userman — PML Reference Manual source repository.