Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2024-02-08Fix documentation build with older docbook-xslPeter Eisentraut
Commit b0f0a9432d0 backpatched some code from upstream DocBook XSL to our customization layer. It turned out that this failed to work with anything but the latest DocBook XSL upstream version (1.79.*), because the backpatched code references an XSLT parameter (autolink.index.see) that is not defined in earlier versions (because the feature it is used for did not exist yet). There is no way in XSLT to test whether a parameter is declared before the stylesheet processor tries and fails to access it. So the possibilities to fix this would be to either remove the code that uses the parameter (and thus give up on the feature it is used for) or declare the parameter in our customization layer. The latter seems easier, and with a few more lines of code we can backport the entire autolink.index.see feature, so let's do that. (If we didn't, then with older stylesheets the parameter will appear as on, but it won't actually do anything, because of the way the stylesheets are laid out, so it's less confusing to just make it work.) With this, the documentation build should work again with docbook-xsl versions 1.77.*, 1.78.*, and 1.79.* (which already worked before). Version 1.76.1 already didn't work before all this, so was not considered here. Reported-by: Peter Smith <smithpb2250@gmail.com> Discussion: https://www.postgresql.org/message-id/flat/9077b779-a9f8-09c8-6e85-da1ebfba15af@eisentraut.org
2024-01-22Make documentation builds reproduciblePeter Eisentraut
Currently, the documentation builds are not fully reproducible (in the sense of https://reproducible-builds.org/). A fix is available upstream (https://github.com/docbook/xslt10-stylesheets/issues/54) but not released. This commit patches the upstream fix into our customization layer. This patch addresses both the HTML and the FO output. The man output is already reproducible. Discussion: https://www.postgresql.org/message-id/flat/9077b779-a9f8-09c8-6e85-da1ebfba15af@eisentraut.org
2023-04-13doc: Make HTML ids discoverablePeter Eisentraut
In the HTML output, this decorates section headers and variable list terms with a marker ("#") that is a link to the same section/term. That way, links inside a page can be discovered for easier sharing. The marker only appears when hovering. This now requires that all elements that are candidates for such a link have an id attribute. Otherwise, an error will be generated. All previously missing ids have been added prior to this patch. Author: Brar Piening <brar@gmx.de> Reviewed-by: Karl O. Pinc <kop@karlpinc.com> Discussion: https://www.postgresql.org/message-id/flat/CAB8KJ=jpuQU9QJe4+RgWENrK5g9jhoysMw2nvTN_esoOU0=a_w@mail.gmail.com
2023-04-05docs: html: load stylesheet via custom.css.sourceAndres Freund
Until now the meson built docs did not have a working reference to the css stylesheet, it was copied in the make target. Instead of duplicating that for meson, use the docbook-xsl parameter custom.css.source to reference it. An additional benefit of that approach is that the stylesheet is now included in the single-file HTML documentation. Reported-by: Peter Eisentraut <peter.eisentraut@enterprisedb.com> Discussion: https://postgr.es/m/3fc3bb9b-f7f8-d442-35c1-ec82280c564a@enterprisedb.com
2022-02-15docs: Work around bug in the docbook xsl stylesheets.Andres Freund
docbook-xsl's index generation stylesheet (autoidx.xsl) has a small bug: It doesn't include xlink in exclude-result-prefixes. Normally just leads to a a single xmlns:xlink in the <div> containing the index, but because our customization emits that, xmlns:xlink intead gets added to every element output by autoidx.xsl below the <div>, totalling around 100kB. Adding the spurious xmlns:xlink to the <div> ourselves isn't great, but avoids the duplication. Reviewed-By: Peter Eisentraut <peter@eisentraut.org> Discussion: https://postgr.es/m/20220213201618.qz6p6noon3wagr3f%40alap3.anarazel.de
2022-02-15Fix XML namespace declarationsPeter Eisentraut
The XSL stylesheets used a mix of incorrect or outdated namespace declarations for XHTML, probably based on ancient advice and examples. Clean all this up. Besides improving correctness (although probably no impact in practice, other than possible validation failures), this removes a bunch of useless namespace declarations in the HTML output. Reported-by: Andres Freund <andres@anarazel.de> Discussion: https://www.postgresql.org/message-id/flat/20220213201618.qz6p6noon3wagr3f%40alap3.anarazel.de
2020-02-15Recreate website's formatting for "website" doc builds.Peter Geoghegan
The stylesheets used for the HTML documentation rendered on postgresql.org have shifted, and no longer matched what was expected by "make STYLE=website html" builds performed locally. Local doc builds did not reflect other aspects of the website, including font and margins. This patch updates the references to use the current set of stylesheets that are used by the documentation on postgresql.org. This also wraps the documentation preview in a HTML container so it can keep the content within similar margins to those found on the website. The documentation on building the docs is updated to reflect this change, and to let the documentation builder know that an external network connection is required to properly preview documentation built with "make STYLE=website html" (which was true prior to this patch too, but not mentioned). Author: Jonathan Katz Reported-By: Tom Lane Discussion: https://postgr.es/m/1375.1581446233@sss.pgh.pa.us
2019-04-16Better scaling of images in HTML outputPeter Eisentraut
Turn on the previously disabled automatic scaling of images in HTML output. To avoid images looking too large on nowadays-normal screens, restrict the width to 75% on such screens. Some work is still necessary because SVG images without a viewBox still won't scale, but that will a separate patch. Discussion: https://www.postgresql.org/message-id/flat/6d2442d1-84a2-36ef-e014-b6d1ece8a139%40postgresql.org
2019-03-27doc: Add some imagesPeter Eisentraut
Add infrastructure for having images in the documentation, in SVG format. Add two images to start with. See the included README file for instructions. Author: Jürgen Purtz <juergen@purtz.de> Author: Peter Eisentraut <peter.eisentraut@2ndquadrant.com> Discussion: https://www.postgresql.org/message-id/flat/aaa54502-05c0-4ea5-9af8-770411a6bf4b@purtz.de
2019-01-17Replace references to mailinglists with @lists.postgresql.orgMagnus Hagander
The namespace for all lists have changed a while ago, so all references should use the correct address.
2017-11-03doc: Convert ids to upper case at build timePeter Eisentraut
This makes the produced HTML anchors upper case, making it backward compatible with the previous (9.6) build system. Reported-by: Thomas Kellerer <spam_eater@gmx.net>
2017-04-07Remove use of Jade and DSSSLPeter Eisentraut
All documentation is now built using XSLT. Remove all references to Jade, DSSSL, also JadeTex and some other outdated tooling. For chunked HTML builds, this changes nothing, but removes the transitional "oldhtml" target. The single-page HTML build is ported over to XSLT. For PDF builds, this removes the JadeTex builds and moves the FOP builds in their place.