Skip to content

Commit

Permalink
polishing language documentation sources, creation scripts and presen…
Browse files Browse the repository at this point in the history
…tation

git-svn-id: https://slps.svn.sourceforge.net/svnroot/slps@779 ab42f6e0-554d-0410-b580-99e487e6eeb2
  • Loading branch information
grammarware committed Feb 28, 2010
1 parent 92b3557 commit afbdd89
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 21 deletions.
23 changes: 12 additions & 11 deletions shared/xsd/ldf.xsd
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<xsd:documentation> <xsd:documentation>
The ``title page'' can in reality be rendered as several pages, but it contains the basic The ``title page'' can in reality be rendered as several pages, but it contains the basic
information that helps to identify this particular language definition and to distinguish information that helps to identify this particular language definition and to distinguish
it from similar documents. From our experience, language standards are either marked as it from similar documents. In our experience, language standards are either marked as
organisation-created or person-authored ones. In the former case, the document must contain organisation-created or person-authored ones. In the former case, the document must contain
the name of the organisation and the standard reference number within it (e.g, ISO 10279). the name of the organisation and the standard reference number within it (e.g, ISO 10279).
In the latter case, one or more authors are specified. It is also possible to mark some sections In the latter case, one or more authors are specified. It is also possible to mark some sections
Expand Down Expand Up @@ -494,8 +494,9 @@
<xsd:annotation> <xsd:annotation>
<xsd:documentation> <xsd:documentation>
Such an informal introduction to the language is not present in all standards. Such an informal introduction to the language is not present in all standards.
However, some specifications contain a not claimed to be complete list of However, some specifications contain a list of language concepts with their
language concepts with their definitions and perhaps even some examples. definitions and perhaps even some examples.
The list is usually not claimed to be exhaustive.
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
</xsd:element> </xsd:element>
Expand All @@ -506,8 +507,8 @@
<xsd:annotation> <xsd:annotation>
<xsd:documentation> <xsd:documentation>
Sections describing lexical structure tend to be shorter, less structured inside, Sections describing lexical structure tend to be shorter, less structured inside,
and very limited in scope: there is usually one on whitespace, one on tokens, and very limited in scope: there is usually one lexical section dedicated to whitespace,
one on literals, one on comments, etc. one lexical section about tokens, one about literals, one about comments, etc.
</xsd:documentation> </xsd:documentation>
<xsd:documentation> <xsd:documentation>
See the section on grammar notation for more details about how broad even the smallest See the section on grammar notation for more details about how broad even the smallest
Expand Down Expand Up @@ -640,9 +641,9 @@
<xsd:element name="references" type="ldf:simpleList"> <xsd:element name="references" type="ldf:simpleList">
<xsd:annotation> <xsd:annotation>
<xsd:documentation> <xsd:documentation>
Hardbound standards have been trying to be more hypertext Even hardbound standards contain hypertext-like elements.
for decades. One of the ways was to attach a list of links One of them is attaching a list of links
and backlinks to every section --- that way, one can easily and backlinks to every section---that way, one can easily
find any related language constructs when learning the find any related language constructs when learning the
language or debugging a particular feature. language or debugging a particular feature.
</xsd:documentation> </xsd:documentation>
Expand Down Expand Up @@ -695,7 +696,7 @@
<xsd:annotation> <xsd:annotation>
<xsd:documentation> <xsd:documentation>
Normative sections form the core of the language standard: for each core section they belong to, Normative sections form the core of the language standard: for each core section they belong to,
they define the purpose of the language construct, provide a description, some syntax definition, they define the purpose of the language construct, provide a description, a syntax definition,
list use constraints and other semantic details, etc. list use constraints and other semantic details, etc.
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
Expand All @@ -705,8 +706,8 @@
<xsd:documentation> <xsd:documentation>
A separate subsection named ``purpose'' is only encountered in some 4GL A separate subsection named ``purpose'' is only encountered in some 4GL
language manuals (e.g., JCL). However, it is quite common for the first language manuals (e.g., JCL). However, it is quite common for the first
paragraph of any new section of any language document to relay short word paragraph of any new section of any language document to briefly introduce
about the purpose of the language construct that is about to be introduced. the purpose of the language construct that is about to be described.
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
</xsd:element> </xsd:element>
Expand Down
2 changes: 1 addition & 1 deletion shared/xsd/xbgf.xsd
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
BGF transformation operator suite BGF transformation operator suite
</xsd:documentation> </xsd:documentation>
<xsd:documentation> <xsd:documentation>
This chapter describes the transformational suite for BGF and all the details about it. This chapter describes the transformational suite for BGF.
Most of the information present here is located in the XML Schema definition of the Most of the information present here is located in the XML Schema definition of the
language, part of the SLPS project. The rest was introduced by the language documentation language, part of the SLPS project. The rest was introduced by the language documentation
transformation commands in the process of automated generation of the manual in its transformation commands in the process of automated generation of the manual in its
Expand Down
4 changes: 2 additions & 2 deletions shared/xsd/xldf.xsd
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
<xsd:documentation> <xsd:documentation>
XLDF transformation suite does not include any sophisticated grammar XLDF transformation suite does not include any sophisticated grammar
manipulations, in that sense it complements XBGF rather than extends it. manipulations, in that sense it complements XBGF rather than extends it.
All grammar transformations are supposed to be be handled by XBGF either All grammar transformations in XBGF that did not take place beforehand, can be
prior to language document transformations or as a part of them. executed as a part of language document transformations.
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
<xsd:choice> <xsd:choice>
Expand Down
6 changes: 3 additions & 3 deletions shared/xsl/ldf2tex.xslt
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
<xsl:apply-templates select="."/> <xsl:apply-templates select="."/>
<xsl:text>\end{lstlisting}\end{graybox} <xsl:text>\end{lstlisting}\end{graybox}


</xsl:text> \noindent </xsl:text>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:apply-templates select="."/> <xsl:apply-templates select="."/>
Expand Down Expand Up @@ -356,7 +356,7 @@
<xsl:apply-templates select="."/> <xsl:apply-templates select="."/>
<xsl:text>\end{lstlisting}\end{graybox} <xsl:text>\end{lstlisting}\end{graybox}


</xsl:text> \noindent </xsl:text>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:call-template name="process-text"> <xsl:call-template name="process-text">
Expand Down Expand Up @@ -453,7 +453,7 @@
<xsl:value-of select="."/> <xsl:value-of select="."/>
<xsl:text>\end{lstlisting}\end{graybox} <xsl:text>\end{lstlisting}\end{graybox}


</xsl:text> \noindent </xsl:text>
</xsl:template> </xsl:template>
<xsl:template match="code"> <xsl:template match="code">
<xsl:text>\texttt{</xsl:text> <xsl:text>\texttt{</xsl:text>
Expand Down
4 changes: 0 additions & 4 deletions topics/languedoc/ldf/xldf/beautify.xldf
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -93,8 +93,6 @@
<bgf:expression> <bgf:expression>
<plus> <plus>
<bgf:expression> <bgf:expression>
<marked>
<bgf:expression>
<selectable> <selectable>
<selector>part</selector> <selector>part</selector>
<bgf:expression> <bgf:expression>
Expand All @@ -111,8 +109,6 @@
</bgf:expression> </bgf:expression>
</selectable> </selectable>
</bgf:expression> </bgf:expression>
</marked>
</bgf:expression>
</plus> </plus>
</bgf:expression> </bgf:expression>
</choice> </choice>
Expand Down
7 changes: 7 additions & 0 deletions topics/languedoc/ldf/xldf/reorganise.xldf
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -170,5 +170,12 @@
<with>keyword</with> <with>keyword</with>
</xldf:combine> </xldf:combine>


<xldf:retitle>
<from>
<title>formula</title>
</from>
<to>Formul\ae</to>
</xldf:retitle>



</xldf:evolutionSequence> </xldf:evolutionSequence>
3 changes: 3 additions & 0 deletions topics/languedoc/xldf/xldf/dropXbgf.xldf
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@
<xldf:drop> <xldf:drop>
<section>unite</section> <section>unite</section>
</xldf:drop> </xldf:drop>
<xldf:drop>
<section>equate</section>
</xldf:drop>
<xldf:drop> <xldf:drop>
<section>abstractize</section> <section>abstractize</section>
</xldf:drop> </xldf:drop>
Expand Down

0 comments on commit afbdd89

Please sign in to comment.