Skip to main content
  • Log in
  • Manage Cookies
projects.eclipse.org
Download
  • Projects
  • Working Groups
  • Members
  • Community
    • Marketplace
    • Events
    • Planet Eclipse
    • Newsletter
    • Videos
    • Blogs
  • Participate
    • Report a Bug
    • Forums
    • Mailing Lists
    • Wiki
    • IRC
    • Research
  • Eclipse IDE
    • Download
    • Learn More
    • Documentation
    • Getting Started / Support
    • How to Contribute
    • IDE and Tools
    • Newcomer Forum
  • More
      • Community

      • Marketplace
      • Events
      • Planet Eclipse
      • Newsletter
      • Videos
      • Blogs
      • Participate

      • Report a Bug
      • Forums
      • Mailing Lists
      • Wiki
      • IRC
      • Research
      • Eclipse IDE

      • Download
      • Learn More
      • Documentation
      • Getting Started / Support
      • How to Contribute
      • IDE and Tools
      • Newcomer Forum
    • Search

  1. Home
  2. Projects
  3. AsciiDoc®
  4. AsciiDoc Language
  5. Governance

AsciiDoc Language

Primary tabs

  • Overview
  • Downloads
  • Who's Involved
  • Developer Resources
  • Governance(active tab)
  • Contact Us
Scope: 

The AsciiDoc language project defines and maintains the AsciiDoc Language Specification and Technology Compatibility Kit (TCK), its artifacts, and the corresponding language and API documentation. The AsciiDoc Language Specification describes the syntax and grammar, Abstract Semantic Graph (ASG), Document Object Model (DOM), referencing system, and APIs for processing, converting, and extending the language. The TCK is used to verify and certify that an AsciiDoc processor implementation is compatible with this specification.

Specifically, the project scope includes the:

  • AsciiDoc language syntax and grammar (e.g., EBNF, PEG, ANTLR4, etc.)
    • doctype-specific structures and required elements
    • designated extension points
  • ASG: an encoded form of the parsed document for use in developing a language-agnostic TCK (e.g., JSON)
  • TCK: Technology Compatibility Kit for verifying compliance of an AsciiDoc language processor
  • DOM API: in-memory semantic representation of the encoded information in the AsciiDoc document
  • Processor API (load, convert)
    • Converter API
  • Extension API
    • Extended syntax processors (e.g., custom block or macro)
    • Resolvers (e.g., path and attribute resolvers, ID generator)
    • Parse events and lifecycle interceptors (e.g., input processor, output processor, tree processor)
    • Integration adapters: syntax highlighter, STEM, bibliography, docinfo
  • Expected converter behaviors (e.g., toc, ID generation, icon type, safe mode)
  • Internal and external referencing system: (e.g., xrefs, includes, images)
  • Reference converter and output format (e.g., HTML with reference stylesheet and/or DocBook)
  • Built-in attributes and reserved attribute namespaces
  • AsciiDoc media type (MIME) and .adoc file extension

The project also provides the:

  • AsciiDoc language documentation for writers
  • AsciiDoc API documentation
Reviews: 
NameDate
Creation Review2020-06-29
Patent License: 
Implementation Patent License
For more information about the patent licenses, view the Eclipse IP Policy page.

Project Links

  • Proposal
Incubating - AsciiDoc Language

Related Projects

Project Hierarchy:

  • AsciiDoc®
  • AsciiDoc Language

Tags

Technology Types
  • Language
  • Specification

Eclipse Foundation

  • About Us
  • Contact Us
  • Sponsor
  • Members
  • Governance
  • Code of Conduct
  • Logo and Artwork
  • Board of Directors
  • Careers

Legal

  • Privacy Policy
  • Terms of Use
  • Copyright Agent
  • Eclipse Public License
  • Legal Resources

Useful Links

  • Report a Bug
  • Documentation
  • How to Contribute
  • Mailing Lists
  • Forums
  • Marketplace

Other

  • IDE and Tools
  • Projects
  • Working Groups
  • Research@Eclipse
  • Report a Vulnerability
  • Service Status

Copyright © Eclipse Foundation. All Rights Reserved.

Back to the top