Package: tcllib, Version: CVS HEAD
docidx_lang_syntax -
docidx language syntax
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.
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.
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 | defsAt last a rule we were unable to capture in the EBNF syntax, as it is about the arguments of the markup commands, something which is not modeled here.
docidx_intro, docidx_lang_intro, docidx_lang_cmdref, docidx_lang_faq
markup, semantic markup, docidx markup, docidx language, docidx syntax, docidx commands