doc: organize chapters into parts, and reduce toc depth

Reorganize the chapters into parts and reduce the TOC depth to make the
TOC useful again. The top-level TOC is very brief, but that is fine
because every part will have its own TOC.

Section titles of languages/frameworks are also simplified to just
the name of the language/framework.
This commit is contained in:
Frederik Rietdijk 2019-10-20 12:17:58 +02:00
parent af7378397f
commit 95dfbe2d63
13 changed files with 41 additions and 29 deletions

View file

@ -8,7 +8,7 @@
<xsl:param name="html.script" select="'./highlightjs/highlight.pack.js ./highlightjs/loader.js'" /> <xsl:param name="html.script" select="'./highlightjs/highlight.pack.js ./highlightjs/loader.js'" />
<xsl:param name="xref.with.number.and.title" select="1" /> <xsl:param name="xref.with.number.and.title" select="1" />
<xsl:param name="use.id.as.filename" select="1" /> <xsl:param name="use.id.as.filename" select="1" />
<xsl:param name="toc.section.depth" select="3" /> <xsl:param name="toc.section.depth" select="0" />
<xsl:param name="admon.style" select="''" /> <xsl:param name="admon.style" select="''" />
<xsl:param name="callout.graphics.extension" select="'.svg'" /> <xsl:param name="callout.graphics.extension" select="'.svg'" />
</xsl:stylesheet> </xsl:stylesheet>

View file

@ -1,4 +1,4 @@
# User's Guide to Emscripten in Nixpkgs # Emscripten
[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler [Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler

View file

@ -3,7 +3,7 @@ title: User's Guide for Haskell in Nixpkgs
author: Peter Simons author: Peter Simons
date: 2015-06-01 date: 2015-06-01
--- ---
# User's Guide to the Haskell Infrastructure # Haskell
## How to install Haskell packages ## How to install Haskell packages

View file

@ -1,4 +1,4 @@
# Idris packages # Idris
## Installing Idris ## Installing Idris

View file

@ -1,7 +1,7 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="chap-language-support"> xml:id="chap-language-support">
<title>Support for specific programming languages and frameworks</title> <title>Languages and frameworks</title>
<para> <para>
The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter. The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.
</para> </para>

View file

@ -1,5 +1,5 @@
Node.js packages Node.js
================ =======
The `pkgs/development/node-packages` folder contains a generated collection of The `pkgs/development/node-packages` folder contains a generated collection of
[NPM packages](https://npmjs.com/) that can be installed with the Nix package [NPM packages](https://npmjs.com/) that can be installed with the Nix package
manager. manager.

View file

@ -1,5 +1,5 @@
R packages R
========== =
## Installation ## Installation

View file

@ -4,7 +4,7 @@ author: Matthias Beyer
date: 2017-03-05 date: 2017-03-05
--- ---
# User's Guide to the Rust Infrastructure # Rust
To install the rust compiler and cargo put To install the rust compiler and cargo put

View file

@ -3,7 +3,7 @@ title: User's Guide for Vim in Nixpkgs
author: Marc Weber author: Marc Weber
date: 2016-06-25 date: 2016-06-25
--- ---
# User's Guide to Vim Plugins/Addons/Bundles/Scripts in Nixpkgs # Vim
Both Neovim and Vim can be configured to include your favorite plugins Both Neovim and Vim can be configured to include your favorite plugins
and additional libraries. and additional libraries.

View file

@ -6,20 +6,32 @@
</subtitle> </subtitle>
</info> </info>
<xi:include href="introduction.chapter.xml" /> <xi:include href="introduction.chapter.xml" />
<xi:include href="quick-start.xml" /> <part>
<xi:include href="package-specific-user-notes.xml" /> <title>Using Nixpkgs</title>
<xi:include href="stdenv.xml" /> <xi:include href="configuration.xml" />
<xi:include href="multiple-output.xml" /> <xi:include href="overlays.xml" />
<xi:include href="cross-compilation.xml" /> <xi:include href="functions.xml" />
<xi:include href="configuration.xml" /> </part>
<xi:include href="functions.xml" /> <part>
<xi:include href="meta.xml" /> <title>Standard environment</title>
<xi:include href="languages-frameworks/index.xml" /> <xi:include href="stdenv.xml" />
<xi:include href="platform-notes.xml" /> <xi:include href="meta.xml" />
<xi:include href="package-notes.xml" /> <xi:include href="multiple-output.xml" />
<xi:include href="overlays.xml" /> <xi:include href="cross-compilation.xml" />
<xi:include href="coding-conventions.xml" /> <xi:include href="platform-notes.xml" />
<xi:include href="submitting-changes.xml" /> </part>
<xi:include href="reviewing-contributions.xml" /> <part>
<xi:include href="contributing.xml" /> <title>Languages, frameworks and packages</title>
<xi:include href="languages-frameworks/index.xml" />
<xi:include href="package-specific-user-notes.xml" />
<xi:include href="package-notes.xml" />
</part>
<part>
<title>Contributing to Nixpkgs</title>
<xi:include href="quick-start.xml" />
<xi:include href="coding-conventions.xml" />
<xi:include href="submitting-changes.xml" />
<xi:include href="reviewing-contributions.xml" />
<xi:include href="contributing-to-documentation.xml" />
</part>
</book> </book>

View file

@ -1,6 +1,6 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-platform-nodes"> xml:id="chap-platform-notes">
<title>Platform Notes</title> <title>Platform Notes</title>
<section xml:id="sec-darwin"> <section xml:id="sec-darwin">
<title>Darwin (macOS)</title> <title>Darwin (macOS)</title>

View file

@ -2,7 +2,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0" version="5.0"
xml:id="sec-reviewing-contributions"> xml:id="chap-reviewing-contributions">
<title>Reviewing contributions</title> <title>Reviewing contributions</title>
<warning> <warning>
<para> <para>