<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="5.0" xml:id="l10n.lang.value.rfc.compliant"> <refmeta> <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle> <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> </refmeta> <refnamediv> <refname>l10n.lang.value.rfc.compliant</refname> <refpurpose>Make value of lang attribute RFC compliant?</refpurpose> </refnamediv> <refsynopsisdiv> <src:fragment xml:id="l10n.lang.value.rfc.compliant.frag"> <xsl:param name="l10n.lang.value.rfc.compliant" select="1"/> </src:fragment> </refsynopsisdiv> <refsection><info><title>Description</title></info> <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC compliant<footnote><para>Section 8.1.1, <link xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that: <blockquote><para>[RFC1766] defines and explains the language codes that must be used in HTML documents.</para> <para>Briefly, language codes consist of a primary code and a possibly empty series of subcodes: <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout> </para> <para>And in RFC 1766, <link xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification of Languages</link>, the EBNF for "language tag" is given as: <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag ) Primary-tag = 1*8ALPHA Subtag = 1*8ALPHA</literallayout> </para> </blockquote> </para></footnote>. by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and replacing them with hyphen characters in output HTML files. For example, <literal>zh_CN</literal> in a source document becomes <literal>zh-CN</literal> in the HTML output form that source. <note> <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766 explicitly states that all "language tags" (as it calls them) "are to be treated as case insensitive".</para> </note> </para> </refsection> </refentry>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 26953 | Paul Allen | Move //guest/perforce_software/p4convert to //guest/perforce_software/p4convert/main | ||
//guest/perforce_software/p4convert/docs/docbook-xsl-ns-1.78.1/params/l10n.lang.value.rfc.compliant.xml | |||||
#2 | 14806 | Paul Allen | Update docs and add +w. | ||
#1 | 13920 | Paul Allen | copy part 2 (no errors) | ||
//guest/paul_allen/p4convert-maven/docs/docbook-xsl-ns-1.78.1/params/l10n.lang.value.rfc.compliant.xml | |||||
#1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/params/l10n.lang.value.rfc.compliant.xml | |||||
#1 | 12728 | eedwards |
Upgrade ANT doc build infrastructure to assemble PDFs: - remove non-namespaced DocBook source and add namespaced DocBook source. - add Apache FOP 1.1 - copy fonts, images, XSL into _build, establishing new asset structure. The original structure remains until all guides using it can be upgraded, and several other issues can be resolved. - updated build.xml to allow for per-target build properties. - upgraded the P4SAG to use the new infrastructure. - tweaked admonition presentation in PDFs to remove admonition graphics, and resemble closely the presentation used in the new HTML layout, including the same colors. With these changes, building PDFs involves using a shell, navigating into the guide's directory (just P4SAG for now), and executing "ant pdf". Issues still to be resolved: - PDF generation encounters several warnings about missing fonts (bold versions of Symbol and ZapfDingbats), and a couple of locations where the page content exceeds the defined content area. - Due to issues within Apache FOP, PDF generation emits a substantial amount of output that is not easily suppressed without losing important warning information. - Apache FOP's interface to ANT does not expose a way to set the font base directory. The current configuration does work under Mac OSX, but further testing on Windows will need to be done to determine if the relative paths defined continue to work. The workaround is for Windows users to customize the fop-config.xml to provide absolute system paths to the required fonts. - HTML generation needs further browser testing, and exhibits broken navigation on iOS browsers within the TOC sidebar. - A number of PDF and HTML presentation tweaks still need to be made, for example: sidebars, gui* DocBook tags, whitespace, section separation, etc. |