docidx_lang_syntax - docidx language syntax
TABLE OF CONTENTS
DESCRIPTION
Fundamentals
Lexical definitions
Syntax
BUGS, IDEAS, FEEDBACK
SEE ALSO
KEYWORDS
COPYRIGHT
This document contains the formal specification of the syntax of the docidx markup language, version 1 in Backus-Naur-Form. This document is intended to be a reference, complementing the docidx language command reference. A beginner should read the much more informally written docidx language introduction first before trying to understand either this document or the command reference.
In the broadest terms possible the docidx markup language is like SGML and similar languages. A document written in this language consists primarily of markup commands, with text embedded into it at some places.
Each markup command is a just Tcl command surrounded by a matching pair of [ and ]. Which commands are available, and their arguments, i.e. syntax is specified in the docidx language command reference.
In this document we specify first the lexeme, and then the syntax, i.e. how we can mix text and markup commands with each other.
In the syntax rules listed in the next section
The rules listed here specify only the syntax of docidx documents. The lexical level of the language was covered in the previous section.
Regarding the syntax of the (E)BNF itself
index = defs INDEX_BEGIN contents INDEX_END { <WHITE> } defs = { INCLUDE | VSET | <WHITE> } contents = keyword { keyword } keyword = defs KEY ref { ref } ref = MANPAGE | URL | defs |
This document, will undoubtedly contain bugs and other problems. Please report such in the category doctools of the Tcllib SF Trackers. Please also report any ideas for enhancements you may have.
docidx_intro, docidx_lang_cmdref, docidx_lang_faq, docidx_lang_intro
docidx commands, docidx language, docidx markup, docidx syntax, markup, semantic markup
Copyright © 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>