Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jhellingman
jhellingman committed Jun 12, 2024
1 parent 5a8a671 commit c78decb
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 78 deletions.
118 changes: 79 additions & 39 deletions Wiki/Configuration.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,99 +6,139 @@ It is only necessary to specify those items that differ from the default in your

=== Current Status

The default configuration file is:
The default configuration file is given below. Its actual value can be found in the `modules/configuration.xsl`.

[source,xml]
----
<tei2html.config>
<debug>false</debug> <!-- Use debug mode. -->
<debug>false</debug> <!-- Use debug mode (uses CSS to color various elements in output HTML). -->
<logLevel>INFO WARNING ERROR DEBUG</logLevel> <!-- Log levels: DEBUG, INFO, WARNING, ERROR -->
<language>en-US</language> <!-- Main language of text (if not specified explicitly) -->
<defaultlanguage>en-US</defaultlanguage> <!-- Default language for localization -->
<debug.facsimile>false</debug.facsimile> <!-- Insert links to the PGDP proofing images in the right margin -->
<language>en-US</language> <!-- Main language of text (if not specified explicitly with the @lang attribute on the text element). -->
<defaultLanguage>en-US</defaultLanguage> <!-- Default language for localization. -->
<drama.inline.speaker>false</drama.inline.speaker> <!-- Inline the speaker (default the speaker is a separate paragraph) -->
<lb.preserve>true</lb.preserve> <!-- Preserve linebreaks indicate with the lb element. -->
<lb.hyphen.remove>false</lb.hyphen.remove> <!-- Remove hyphens before line-breaks. -->
<lb.removable.hyphen>&not;</lb.removable.hyphen> <!-- Character used for removable hyphen before line-break (DTA convention). -->
<lb.removable.hyphen>&not;</lb.removable.hyphen> <!-- Character used for removable hyphen before a line-break (DTA convention). -->
<lb.hyphen>-</lb.hyphen> <!-- Character used for non-removable hyphen before line-break. -->
<defaultStylesheet>style/arctic.css</defaultStylesheet> <!-- Stylesheet to include. -->
<useCommonStylesheets>true</useCommonStylesheets> <!-- Use the build-in stylesheets (for screen) -->
<useCommonPrintStylesheets>true</useCommonPrintStylesheets> <!-- Use the build-in stylesheets (for print media) -->
<inlineStylesheet>true</inlineStylesheet> <!-- use an inline (embedded in HTML) stylesheet; ignored for ePub. -->
<numberTocEntries>true</numberTocEntries> <!-- Provide numbers with TOC entries. -->
<toc.numberEntries>true</toc.numberEntries> <!-- Provide numbers with generated TOC entries. -->
<toc.defaultEntries>false</toc.defaultEntries> <!-- Use generic heads in entries in the TOC, if no head is present. -->
<pg.includeHeaders>false</pg.includeHeaders> <!-- Include Project Gutenberg headers and footers. -->
<pg.includeComments>false</pg.includeComments> <!-- Include references to Project Gutenberg in comments. -->
<pg.compliant>false</pg.compliant> <!-- Only use HTML and CSS constructs that are compliant with to Project Gutenberg guidelines. -->
<showParagraphNumbers>false</showParagraphNumbers> <!-- Output paragraph numbers, using the value of the @n attribute. -->
<includePGHeaders>false</includePGHeaders> <!-- Include Project Gutenberg headers and footers. -->
<includePGComments>false</includePGComments> <!-- Include references to Project Gutenberg in comments. -->
<includeAlignedDivisions>true</includeAlignedDivisions> <!-- Include divisions indicated by "align-with-document()" -->
<defaultTocEntries>false</defaultTocEntries> <!-- Use generic heads in entries in the TOC, if no head is present -->
<useRegularizedUnits>false</useRegularizedUnits> <!-- Use the regularized units specified in the measure-tag. (false: both are shown, the original in the text, the regularized units in a
pop-up; true: regularized in text, original in pop-up) -->
<outputExternalLinks>always</outputExternalLinks> <!-- Generate external links, possible values: always | never | colophon -->
<outputExternalLinksTable>false</outputExternalLinksTable> <!-- Place external links in a separate table in the colophon. -->
<useHangingPunctuation>false</useHangingPunctuation> <!-- Use hanging punctuation (by generating the relevant CSS classes). -->
<useFootnoteReturnArrow>true</useFootnoteReturnArrow> <!-- Place a small up-arrow at the end of a footnote to return to the source location in the text. -->
<xref.show>always</xref.show> <!-- Method used to generate external links, possible values:
- always: external links are active at the location in the text.
- never: external links are not shown (only the anchor text is).
- colophon: external links are active in the colophon (including in the external-links table, if generated).
-->
<xref.table>false</xref.table> <!-- Collect all external links in a separate table in the colophon. -->
<xref.exceptions>https://www.pgdp.net/; https://www.gutenberg.org/; pg:; music/; images/</xref.exceptions> <!-- Semicolon-separated list of external URLs than can be always be used. -->
<punctuation.hanging>false</punctuation.hanging> <!-- Use hanging punctuation (by generating the relevant CSS classes. This requires tweaking, depending on the font used). -->
<ditto.enable>true</ditto.enable> <!-- Use ditto marks in ditto or seg[@copyOf] elements. -->
<ditto.enable>true</ditto.enable> <!-- Use ditto marks in ditto (deprecated) or seg[@copyOf] elements. -->
<ditto.mark>,,</ditto.mark> <!-- The symbol to use as a ditto mark. May also be overridden by rend attribute ditto-mark() -->
<ditto.repeat>word</ditto.repeat> <!-- TODO: How often to use a ditto mark, possible values: word | segment. May also be overridden by rend attribute ditto-repeat() -->
<ditto.repeat>word</ditto.repeat> <!-- How often to use a ditto mark, possible values: word | segment. May also be overridden by rend attribute ditto-repeat() -->
<pageNumbers.show>true</pageNumbers.show> <!-- Show page numbers in the right margin -->
<pageNumbers.before>[</pageNumbers.before> <!-- String to place before the page number in the right margin -->
<pageNumbers.after>]</pageNumbers.after> <!-- String to place after the page number in the right margin -->
<pageNumbers.show>true</pageNumbers.show> <!-- Show page numbers in the right margin. -->
<pageNumbers.before>[</pageNumbers.before> <!-- String to place before the page number in the right margin. -->
<pageNumbers.after>]</pageNumbers.after> <!-- String to place after the page number in the right margin. -->
<facsimile.enable>false</facsimile.enable> <!-- Output section with and links to facsimile images if required information is present. -->
<facsimile.wrapper.enable>true</facsimile.wrapper.enable> <!-- Generate HTML wrapper files for the images, and link to these. -->
<facsimile.path>page-images</facsimile.path> <!-- Path where the wrapper files will be generated. -->
<facsimile.external>false</facsimile.external> <!-- TODO: Set to true if the URL points to an external location. -->
<facsimile.target></facsimile.target> <!-- TODO: Value of the target attribute of generated URLs (leave empty for default; _blank, _top, _parent, _self). -->
<facsimile.wrapper.enable>true</facsimile.wrapper.enable> <!-- Generate HTML wrapper files for the images, and link to these instead of to the image. -->
<facsimile.path>page-images</facsimile.path> <!-- Path where the HTML wrapper files will be generated. -->
<facsimile.target></facsimile.target> <!-- Value of the target attribute of generated links in HTML (leave empty for default; _blank, _top, _parent, _self). -->
<notes.apparatus.textMarker>&deg;</notes.apparatus.textMarker> <!-- Note marker used with text-critical notes (coded with place=apparatus) used at location in text. -->
<notes.apparatus.noteMarker>&deg;</notes.apparatus.noteMarker> <!-- Note marker used with text-critical notes (coded with place=apparatus) used before note, to return to text. -->
<notes.apparatus.format>block</notes.apparatus.format> <!-- How to format text-critical notes: as separate paragraphs or as a single block. Possible values: paragraphs | block -->
<notes.foot.returnArrow>true</notes.foot.returnArrow> <!-- Place a small up-arrow at the end of a footnote to return to the source location in the text. -->
<notes.foot.counter>chapter</notes.foot.counter> <!-- At what level to count footnotes, possible values: chapter or text. -->
<notes.apparatus.noteMarker>&deg;</notes.apparatus.noteMarker> <!-- Note marker used with text-critical notes (coded with place=apparatus) used at location in text. -->
<notes.apparatus.returnMarker>&deg;</notes.apparatus.returnMarker> <!-- Note marker used with text-critical notes (coded with place=apparatus) used before note, to return to text. -->
<notes.apparatus.format>block</notes.apparatus.format> <!-- How to format text-critical notes: as separate paragraphs or as a single block. Possible values: paragraphs | block. -->
<images.path></images.path> <!-- Prefix of path to images, relative to the HTML file -->
<images.include>true</images.include> <!-- Include images in the generated output. -->
<images.requireInfo>true</images.requireInfo> <!-- Require image-info to be present for an image (otherwise they won't be included in output) [TODO]. -->
<images.scale>1.0</images.scale> <!-- Image scale factor: 1.0 is normal size; 0.5 is half size; 2.0 is double size. -->
<images.maxSize>100</images.maxSize> <!-- Warn if image is larger than this number of kilobytes. -->
<images.maxWidth>720</images.maxWidth> <!-- Warn if image is wider than this number of pixels (after applying images.scale). -->
<images.maxHeight>720</images.maxHeight> <!-- Warn if image is taller than this number of pixels (after applying images.scale). -->
<audio.useControls>false</audio.useControls> <!-- Use controls for links to local audio (MP3, Midi, Ogg) formats (HTML5 only). -->
<text.parentheses>()[]{}</text.parentheses> <!-- Pairs of parentheses, first opening, then closing -->
<text.quotes>&ldquo;&rdquo;&lsquo;&rsquo;&laquo;&raquo;&bdquo;&rdquo;</text.quotes> <!-- Pairs of quotation marks, first opening, then closing -->
<text.insertQuotes>false</text.insertQuotes> <!-- Insert quotation marks around <q> markup [TODO] based on first four pairs in setting <text.quotes> -->
<text.parentheses>()[]{}</text.parentheses> <!-- Pairs of parentheses, first opening, then closing. -->
<text.quotes>&ldquo;&rdquo;&lsquo;&rsquo;&laquo;&raquo;&bdquo;&rdquo;</text.quotes> <!-- Pairs of quotation marks, first opening, then closing. -->
<text.curlyApos>true</text.curlyApos> <!-- Replace a plain apostrophe (') with a right single quote. -->
<text.spaceQuotes>true</text.spaceQuotes> <!-- Insert a hair space between consecutive quotation marks. -->
<text.useEllipses>true</text.useEllipses> <!-- Replace three consecutive periods with an ellipsis character. -->
<text.abbr>i.e.; I.e.; e.g.; E.g.; A.D.; B.C.; P.M.; A.M.</text.abbr> <!-- Common abbreviations, list separated by semi-colons. -->
<text.useIJLigature>false</text.useIJLigature> <!-- Replace ij with the ij-ligature (Dutch and letter-spaced text only). -->
<text.normalizeUnicode>true</text.normalizeUnicode> <!-- Normalize Unicode to NFC (may break Hebrew or Tibetan text in some rare cases) -->
<text.abbr>i.e.; I.e.; e.g.; E.g.; A.D.; B.C.; P.M.; A.M.</text.abbr> <!-- Common abbreviations, list separated by semicolons. -->
<css.support>2</css.support> <!-- Level of support for CSS: used to filter out newer features. Possible values: 2 | 3 -->
<table.classifyContent>false</table.classifyContent> <!-- Attempt to determine the content-type of cells in a table; add relevant classes in the HTML output. -->
<q.insertQuotes>false</q.insertQuotes> <!-- Insert quotation marks around <q> markup based on first two pairs in setting <text.quotes>. -->
<q.asDiv>true</q.asDiv> <!-- Render the <q> element with a div if true, as a span otherwise. -->
<beta.convert>false</beta.convert> <!-- Interpret beta-codes if the language is classical Greek (i.e., @xml:lang="grc"). -->
<beta.caseSensitive>false</beta.caseSensitive> <!-- Beta-code is case-sensitive (i.e., not using the * notation for capital letters) -->
<css.stylesheet>style/arctic.css</css.stylesheet> <!-- Default CSS stylesheet(s) to include; these are distributed with tei2html in the style directory. -->
<css.useCommon>true</css.useCommon> <!-- Use the build-in stylesheets (for screen) -->
<css.useCommonPrint>true</css.useCommonPrint> <!-- Use the build-in stylesheets (for print media) -->
<css.useCommonAural>false</css.useCommonAural> <!-- Use the build-in stylesheets (for aural support) -->
<css.inline>true</css.inline> <!-- use an inline (embedded in HTML) stylesheet; ignored for ePub. -->
<css.support>2</css.support> <!-- Level of support for CSS: used to filter out newer features. Possible values: 2 | 3. -->
<css.frakturFont>Walbaum-Fraktur</css.frakturFont> <!-- The font to use when font(fraktur) is specified. -->
<css.blackletterFont>UnifrakturMaguntia</css.blackletterFont> <!-- The font to use when font(blackletter) is specified. -->
<rendition.id.prefix></rendition.id.prefix> <!-- Prefix used for rendition IDs. -->
<colophon.showEditDistance>true</colophon.showEditDistance> <!-- Show the Levenshtein edit distance in the list of corrections made in the colophon. -->
<colophon.showCorrections>true</colophon.showCorrections> <!-- Show a list of corrections in the colophon. -->
<colophon.showSuggestedCorrections>false</colophon.showSuggestedCorrections> <!-- Show a list of suggested (but not applied) corrections in the colophon. -->
<colophon.showMinorCorrections>true</colophon.showMinorCorrections> <!-- Include minor corrections in the colophon. -->
<colophon.showAbbreviations>true</colophon.showAbbreviations> <!-- Show a list of abbreviations in the colophon. -->
<colophon.showExternalReferences>true</colophon.showExternalReferences> <!-- Show a section on external references in the colophon. -->
<colophon.maxCorrectionCount>20</colophon.maxCorrectionCount> <!-- Maximum number of indentical corrections that will be listed individually in the list of corrections. -->
<colophon.maxCorrectionCount>20</colophon.maxCorrectionCount> <!-- Maximum number of identical corrections that will be listed individually in the list of corrections. -->
<math.decimalSeparator>.</math.decimalSeparator>
<math.thousandsSeparator>,</math.thousandsSeparator>
<math.numberPattern>^[0-9]{1,3}(,[0-9]{3})*(\.[0-9]+)?$</math.numberPattern>
<math.label.position>right</math.label.position>
<math.label.before>(</math.label.before>
<math.label.after>)</math.label.after>
<math.keepTexInComment>true</math.keepTexInComment>
<math.filePath>formulas</math.filePath> <!-- Path where tei2html will write tex files and read SVG files. -->
<math.htmlPath>formulas</math.htmlPath> <!-- Path the generated HTML (and ePub) will use as location for included SVG or PNG files. -->
<math.mathJax.format>SVG+IMG</math.mathJax.format> <!-- Options: MathJax; MML; SVG; SVG+IMG -->
<math.mathJax.configuration>TeX-MML-AM_SVG</math.mathJax.configuration> <!-- Options for MathJax format, e.g.: TeX-MML-AM_SVG TeX-MML-AM_CHTML, see https://docs.mathjax.org/en/latest/config-files.html#common-configurations -->
<!-- Output format specific settings: these override the general settings defined above for a specific output format. Supported formats: "html" and "epub". -->
<!-- Output-format specific settings: these override the general settings defined above for a specific output format. Supported formats: "html", "html5" and "epub". -->
<output format="html">
<useMouseOverPopups>true</useMouseOverPopups> <!-- Use mouse-over pop-ups on various items (links, etc) -->
<useMouseOverPopups>true</useMouseOverPopups> <!-- Use mouse-over pop-ups on various items (links, etc). -->
</output>
<output format="html5">
<useMouseOverPopups>true</useMouseOverPopups>
</output>
<output format="epub">
<useMouseOverPopups>false</useMouseOverPopups>
<outputExternalLinks>always</outputExternalLinks>
<outputExternalLinksTable>true</outputExternalLinksTable>
<xref.show>always</xref.show>
<xref.table>true</xref.table>
<pageNumbers.show>false</pageNumbers.show>
<includeAlignedDivisions>false</includeAlignedDivisions>
<math.mathJax.format>MML</math.mathJax.format>
</output>
Expand Down
Loading

0 comments on commit c78decb

Please sign in to comment.