diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | README.md (renamed from README) | 50 |
2 files changed, 26 insertions, 26 deletions
diff --git a/Makefile.am b/Makefile.am index 8ae8ed8..b5d5ac4 100644 --- a/Makefile.am +++ b/Makefile.am @@ -42,3 +42,5 @@ ChangeLog: $(CHANGELOG_CMD) dist-hook: ChangeLog INSTALL + +EXTRA_DIST = README.md @@ -87,23 +87,27 @@ as including target document references in the various *.db files. These files are generated and installed while the documents are being build. This is what a Docbook/XML reference from docA to docB looks like (docA.xml): -<olink targetdoc='docB' targetptr='docBfragment'>Title</olink> + + <olink targetdoc='docB' targetptr='docBfragment'>Title</olink> This is what a non-chunked HTML reference from docA to docB looks like (docA.html): -<a href="docB.html#docBfragment" class="olink">Title</a> + + <a href="docB.html#docBfragment" class="olink">Title</a> This is what an HTML targetdoc for docB looks like (docB.html.db): -<div element="article" href="docB.html#docBfragment" number="" targetptr="docBfragment"> + + <div element="article" href="docB.html#docBfragment" number="" targetptr="docBfragment"> This is what an HTML reference from docA to docB looks like (docA.html) when the reference cannot be resolved: -<span class="olink">Title</span> + + <span class="olink">Title</span> This can be caused by one or more of the following: - docB may not longer contain the text (targetptr) docA is referring to. - docB.html.db file may not have been installed by docB package - - masterdb.html.xml is missing a <document/> entry for docB + - masterdb.html.xml is missing a `<document/>` entry for docB - masterdb.html.xml cannot be loaded so all refs are broken. - an XSLT processor which does not support xinclude is being used - docB.html.db was generated without --xinclude option for the processor @@ -112,8 +116,8 @@ This can be caused by one or more of the following: Some pitfalls ------------------------- -<book id="docA"> in docA.xml: the id must match the file basename. -In docs Makefile.am --stringparam current.docid="$(<:.xml=)" +`<book id="docA">` in docA.xml: the id must match the file basename. +In docs Makefile.am `--stringparam current.docid="$(<:.xml=)"` supplies docid for *.db. The document id must be unique across all documents. @@ -128,18 +132,20 @@ the reference to at least point to the top of the document. XSL toolchain ------------- The following minimum versions are needed for external references to work: -XSLT processor: 1.1.26 -libxml2: 2.7.6 -libxslt1.1: 1.1.26 + + XSLT processor: 1.1.26 + libxml2: 2.7.6 + libxslt1.1: 1.1.26 + The exact triplet may vary by distribution, sometimes a version is skipped. If you are close enough, try it. References ---------- -http://docbook.org/tdg/en/html/docbook.html -http://docbook.sourceforge.net/release/xsl/current/doc/html/ -http://docbook.sourceforge.net/release/xsl/current/doc/fo/ -http://www.sagehill.net/docbookxsl/OlinkPrintOutput.html + - https://tdg.docbook.org/ + - http://docbook.sourceforge.net/release/xsl/current/doc/html/ + - http://docbook.sourceforge.net/release/xsl/current/doc/fo/ + - http://www.sagehill.net/docbookxsl/OlinkPrintOutput.html ------------------------------------------------------------------------------- @@ -147,23 +153,15 @@ http://www.sagehill.net/docbookxsl/OlinkPrintOutput.html All questions regarding this software should be directed at the Xorg mailing list: - http://lists.freedesktop.org/mailman/listinfo/xorg - -Please submit bug reports to the Xorg bugzilla: - - https://bugs.freedesktop.org/enter_bug.cgi?product=xorg + https://lists.x.org/mailman/listinfo/xorg The master development code repository can be found at: - git://anongit.freedesktop.org/git/xorg/doc/xorg-sgml-doctools + https://gitlab.freedesktop.org/xorg/doc/xorg-sgml-doctools - http://cgit.freedesktop.org/xorg/doc/xorg-sgml-doctools +Please submit bug reports and requests to merge patches there. For patch submission instructions, see: - http://www.x.org/wiki/Development/Documentation/SubmittingPatches - -For more information on the git code manager, see: - - http://wiki.x.org/wiki/GitPage + https://www.x.org/wiki/Development/Documentation/SubmittingPatches |