about summary refs log tree commit diff
path: root/nixos/doc/manual/options-to-docbook.xsl
Commit message (Collapse)AuthorAge
* nixos: Split paras by \n\n in option descriptionsaszlig2018-09-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | What annoyed me for a long time was the fact, that in order to break into a new paragraph, you need to insert </para><para> in the description attribute of an option. Now we will automatically create <para/> elements for every block that is separated by two consecutive newlines. I first tried to do this within options-to-docbook.xsl, but it turns out[1] that this isn't directly possible with XSLT 1.0, so I added another XSLT file that postprocesses the option descriptions that are now enclosed in <nixos:option-description/> by options-to-docbook.xsl. The splitting itself is a bit more involved, because we can't simply split on every \n\n because we'd also split text nodes of elements, for example: <screen><![CDATA[ one line another one ]]></screen> This would create one <para/> element for "one line" and another for "another line", which we obviously don't want because <screen/> is used to display verbatim contents of what a user is seeing on the screen. So what we do instead is splitting *only* the top-level text nodes within the outermost <para/> and leave all elements as-is. If there are more than one <para/> elements at the top-level, we simply don't process it at all, because the description then already contains </para><para>. https://www.mhonarc.org/archive/html/xsl-list/2012-09/msg00319.html Signed-off-by: aszlig <aszlig@nix.build> Cc: @edolstra, @domenkozar
* nixos docs: give IDs to thingsGraham Christensen2018-09-01
|
* nixos docs: Add a makefile for hacking on the nixos docsGraham Christensen2018-04-28
|
* nixos, lib: implement relatedPackages optionJan Malakhovski2018-02-09
| | | | | | | | This allows one to specify "related packages" in NixOS that get rendered into the configuration.nix(5) man page. The interface philosophy is pretty much stolen from TeX bibliography. See the next several commits for examples.
* Revert "nixos: doc: implement related packages in the manual"Graham Christensen2017-12-23
|
* nixos, lib: implement relatedPackages optionJan Malakhovski2017-12-07
| | | | | | This allows one to specify "related packages" in NixOS that get rendered into the configuration.nix(5) man page. The interface philosophy is pretty much stolen from TeX bibliography.
* fix https://github.com/NixOS/nixops/issues/331Domen Kožar2016-06-03
|
* Manual: Don't render types as stringsEelco Dolstra2015-07-30
|
* Add read-only optionsEelco Dolstra2015-07-30
| | | | | These are options that can have only one definition, regardless of priority.
* Fix indentationEelco Dolstra2015-07-30
|
* Add Type information into manual and manpages, fixes #4600Domen Kožar2015-01-04
|
* Manual: Render function defaultsEelco Dolstra2014-08-09
|
* SimplifyEelco Dolstra2014-04-14
|
* Manual: Generate stable ids for optionsEelco Dolstra2014-04-14
| | | | | | E.g. ‘#opt-boot.initrd.kernelModules’. Also, shut up a stupid XSLT warning (‘attribute value is not an NCName’).
* nixos manual: make nixos options linkableDomen Kozar2014-03-08
|
* Clean up some option examplesEelco Dolstra2013-10-30
|
* Manual: Render multi-line strings properlyEelco Dolstra2013-10-29
|
* Manual: Escape $Eelco Dolstra2013-10-29
|
* Manual: Render strings containing special characters as indented stringsEelco Dolstra2013-10-29
|
* Manual: Don't show "Default: none"Eelco Dolstra2013-10-29
|
* Manual: Render null valuesEelco Dolstra2013-10-29
|
* Allow literalExample in subexpressions of examplesEelco Dolstra2013-10-23
|
* Manual: Don't depend on the absolute path of modulesEelco Dolstra2013-10-23
| | | | | | This ensures that the manual has the same store path regardless of the directory in which Nixpkgs is stored, and thus can be fetched from the channel.
* Move all of NixOS to nixos/ in preparation of the repository mergeEelco Dolstra2013-10-10