articles · projects

Glyph Documentation

Table of Contents

  1. Introduction
    1. License
    2. Resources
  2. Acknowledgements
  3. Getting Started
    1. Creating your first Glyph Project
    2. Document Structure
    3. Project Configuration
  4. Authoring Documents
    1. .glyph files
    2. Introducing Glyph Macros
    3. Macro attributes
    4. Macro Composition
    5. Escaping and Quoting
    6. Sections and Headers
      1. Section Aliases
      2. Topics
    7. Links and Bookmarks
    8. Images and Figures
    9. Source Code
    10. Other HTML Elements
      1. Textile or Markdown
      2. XML Fallback
    11. Adding Stylesheets
    12. Content Reuse
    13. Conditional Macros
    14. Simple Programming and Code Evaluation
      1. Turing-completeness
      2. Lexically-scoped attribute assignment
      3. Evaluating Ruby code
  5. Generating Output Files
    1. Compiling a project
    2. Compiling single Glyph files
    3. Using Glyph programmatically
  6. Document Statistics
    1. Using the stats command
    2. Macro Statistics
    3. Snippet Statistics
    4. Bookmark Statistics
    5. Link Statistics
  7. Extending Glyph
    1. A quick look at Glyph's internals
    2. Defining Custom Macros
      1. Parameters and Attributes
      2. Bookmarks and Headers
      3. Using Placeholders
      4. Using Validators
      5. Interpreting Glyph Code
      6. Layouts
      7. Further Reading
    3. Defining Custom Commands and Tasks
      1. Defining Custom Tasks
      2. Defining Custom Commands
  8. Troubleshooting
    1. Generic Errors
    2. Parsing Errors
    3. Command Errors
    4. Macro Errors
  9. Command Reference
  10. Macro Reference
    1. Core Macros
    2. Block Macros
    3. Inline Macros
    4. Filter Macros
    5. Structure Macros
  11. Configuration Reference
    1. document.*
    2. filters.*
    3. options.*
    4. output.*
  12. Changelog

Web Site v9.1.0

© 2004—2018 • Fabio Cevasco

Unless stated otherwise, all the content published on this web site is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. The source code of this web site, such as its layout, stylesheets, custom min rules and code is licensed under the terms of the MIT License and it is available on GitHub.