Polygen-Docs

• https://github.com/tajmone/polygen-docs

Welcome to polygen-docs, the "Polygen Documentation Revival" project.

---

Table of Contents

• The Documents
• Project Contents
• About
• License
• Acknowledgments
• Credits
• What's New
  • August/September 2020
  • January/February 2018
• Links

---

The Documents

The Polygen Meta Language Spec (Live HTML preview links):

• polygen-spec_EN.html — English
• polygen-spec_IT.html — Italian

Project Contents

• /archived/ — archived copies of every document release.
• /docs-src/ — markdown source files and build toolchain.
• CONTRIBUTING.md — Contributors' Guidelines.
• LICENSE — GNU GPLv2 license.
• polygen-spec_EN.html — latest version of PML Spec (English).
• polygen-spec_IT.html — latest version of PML Spec (Italian).
• validate.sh — (for contributors) validates code styles consistency of source files (requires EClint).

About

The goal of this project is to gather all Polygen related documentation into a centralized repository for easier maintainance. All documents are written in markdown and converted to HTML through a customized toolchain leveraging pandoc, PP macros, Highlight and pandoc-crossref.

The pre-existing Polygen manual has been republished under the new title Polygen Meta Language Spec. The translation of the English manual is now complete, and both the Italian and English documents have been revised for this new edition.

This project is maintained by Tristano Ajmone and Polygen's author Alvise Spanò.

License

• LICENSE

The manuals are released under the same license of Polygen: GNU GPL version 2 (or above).

Acknowledgments

Many thanks to Riccardo Bastianini for his great contribution in revising the text of the English edition and pointing out problematic code examples.

Credits

The toolchain for the creation of Polygen documents reuses some third party resources, all comptabile with the GPLv2 license.

For a full list of credits, and their licenses, see:

• /docs-src/CREDITS.md
• /docs-src/assets/LICENSE

What's New

This section resumes the latest changes to the repository structure and its toolchain. For a Changelog of the PML Spec documents, see archived/README.md.

August/September 2020

In preparation for the v1.1.1 release of the documents, we've polished the repository and carried out some improvements:

• Documentation toolchain:
  • Updated the third party dependencies to their latest versions:
    • pandoc v2.10.1.
    • pandoccrossref v0.3.7.0a.
    • PP v2.14.1.
    • Highlight v3.57.
    • GitHub HTML5 Pandoc Template v2.2.
  • Switched from Ruby Sass to Dart Sass.
  • Replaced with onchange the defunct multiwatch tool.
  • Replaced the conv_EN.sh and conv_IT.sh scripts with convert.sh, a unified builder taking as parameter a supported locale (en|it) or all.
• Repository improvements:
  • Enforced code styles consistency via EditorConfig settings.
  • Enabled Travis CI code styles validation of every commit and PR via EClint.
  • Added Contributor's Guidelines.

January/February 2018

Creation of the repository and first release (v1.1.0) of the new PML Spec documents, ported from HTML to Markdown sources.

The following third party tools versions are used to build the HTML documents:

• pandoc v2.1.
• pandoc-crossref v0.3.0.0.
• PP v2.2.2.
• Highlight v3.42.
• GitHub HTML5 Pandoc Template v2.0.

---

Links

• Polygen repository
• Polygen Website
• Polygen Wiki in English
• Polygen Wiki in Italian