Difference between revisions of "Mapping language processing"

From TEIWiki
Jump to navigation Jump to search
(Input parameters)
Line 7: Line 7:
 
==Input parameters==
 
==Input parameters==
  
The Guidelines Makefile provides the following set of parameters related to language processing when building the Guidlines:
+
The Guidelines Makefile originally provided the following set of parameters related to language processing when building the Guidelines:
  
 
  - ALLLANGUAGES=en
 
  - ALLLANGUAGES=en
  - LANGUAGE=en
+
  - LANGUAGE=en (now deleted)
 
  - INPUTLANGUAGE=en
 
  - INPUTLANGUAGE=en
  - DOCUMENTATIONLANGUAGE=en
+
  - DOCUMENTATIONLANGUAGE=en (now deleted)
  
 
ALLLANGUAGES is a parameter which can take multiple values, space-separated; for each of those values, a separate version of the Guidelines will be built in its own folder by using the ant macro <code>buildweb</code>. This calls the Stylesheets <code>utilties/Guidelines.xsl</code>, passing the current value of the language in all three of the following parameters:
 
ALLLANGUAGES is a parameter which can take multiple values, space-separated; for each of those values, a separate version of the Guidelines will be built in its own folder by using the ant macro <code>buildweb</code>. This calls the Stylesheets <code>utilties/Guidelines.xsl</code>, passing the current value of the language in all three of the following parameters:
Line 21: Line 21:
  
 
(These will be documented later.) This parameter is automatically set to the following list of languages for a number of Makefile targets, including <code>teiwebsiteguidelines</code>.
 
(These will be documented later.) This parameter is automatically set to the following list of languages for a number of Makefile targets, including <code>teiwebsiteguidelines</code>.
 
LANGUAGE is an apparently unused parameter; it appears in both the P5/Makefile and the P5/Test/Makefile, but is never used in either. ''We recommend deleting this confusing parameter.''
 
  
 
INPUTLANGUAGE governs which source tree for the Guidelines specifically is used; it governs the name of the source file,[1] setting the variable DRIVER to this file. As far as we can tell, the only effect of this is to copy the Images directory from the language subdirectory to the output directory.
 
INPUTLANGUAGE governs which source tree for the Guidelines specifically is used; it governs the name of the source file,[1] setting the variable DRIVER to this file. As far as we can tell, the only effect of this is to copy the Images directory from the language subdirectory to the output directory.
 
DOCUMENTATIONLANGUAGE does not get used at all as far as we can see. ''We recommend deleting this confusing parameter.''
 
  
 
[1]:P5/Source/en/Guidelines-en.xml or P5/Source/fr/Guidelines-fr.xml are the only two available right now, and the French chapter points only to English source files anyway, because the French header chapter is out of date and will not build.
 
[1]:P5/Source/en/Guidelines-en.xml or P5/Source/fr/Guidelines-fr.xml are the only two available right now, and the French chapter points only to English source files anyway, because the French header chapter is out of date and will not build.

Revision as of 19:06, 20 November 2020

This page follows the model of Mapping ODD Processing in trying to provide a clear general introduction to the way that different language inputs are processed in the building of Guidelines/documentation.

TEI Guidelines

This section deals with the Guidelines build process specifically.

Input parameters

The Guidelines Makefile originally provided the following set of parameters related to language processing when building the Guidelines:

- ALLLANGUAGES=en
- LANGUAGE=en (now deleted)
- INPUTLANGUAGE=en
- DOCUMENTATIONLANGUAGE=en (now deleted)

ALLLANGUAGES is a parameter which can take multiple values, space-separated; for each of those values, a separate version of the Guidelines will be built in its own folder by using the ant macro buildweb. This calls the Stylesheets utilties/Guidelines.xsl, passing the current value of the language in all three of the following parameters:

- lang
- doclang
- documentationLanguage

(These will be documented later.) This parameter is automatically set to the following list of languages for a number of Makefile targets, including teiwebsiteguidelines.

INPUTLANGUAGE governs which source tree for the Guidelines specifically is used; it governs the name of the source file,[1] setting the variable DRIVER to this file. As far as we can tell, the only effect of this is to copy the Images directory from the language subdirectory to the output directory.

[1]:P5/Source/en/Guidelines-en.xml or P5/Source/fr/Guidelines-fr.xml are the only two available right now, and the French chapter points only to English source files anyway, because the French header chapter is out of date and will not build.