nix-pills/default.nix

{ pkgs ? import <nixpkgs> {}, revCount, shortRev }:
let
  lib = pkgs.lib;

  sources = let

      # We want nix examples, but not the top level nix to build things
      noTopLevelNix = path: type: let
          relPath = lib.removePrefix (toString ./. + "/") (toString path);
        in builtins.match "[^/]*\.nix" relPath == null;

      extensions = [ ".xml" ".txt" ".nix" ".bash" ];

    in lib.cleanSourceWith {
      filter = noTopLevelNix;
      src = lib.sourceFilesBySuffices ./. extensions;
    };

  combined = pkgs.runCommand "nix-pills-combined"
    {
      buildInputs = [ pkgs.libxml2 ];
      meta.description = "Nix Pills with as a single docbook file";
      inherit revCount shortRev;
    }
    ''
      cp -r ${sources} ./sources
      chmod -R u+w ./sources

      cd sources

      printf "%s-%s" "$revCount" "$shortRev" > version
      xmllint --xinclude --output "$out" ./book.xml
    '';

  toc = builtins.toFile "toc.xml"
    ''
      <toc role="chunk-toc">
        <d:tocentry xmlns:d="http://docbook.org/ns/docbook" linkend="book-nix-pills"><?dbhtml filename="index.html"?>
        </d:tocentry>
      </toc>
    '';

  manualXsltprocOptions = toString [
    "--param section.autolabel 1"
    "--param section.label.includes.component.label 1"
    "--stringparam html.stylesheet style.css"
    "--param xref.with.number.and.title 1"
    "--param toc.section.depth 3"
    "--stringparam admon.style ''"
    "--stringparam callout.graphics.extension .svg"
    "--stringparam current.docid nix-pills"
    "--param chunk.section.depth 0"
    "--param chunk.first.sections 1"
    "--param use.id.as.filename 1"
    "--stringparam generate.toc 'book toc appendix toc'"
    "--stringparam chunk.toc '${toc}'"
  ];

in {
  html-split = pkgs.stdenv.mkDerivation {
    name = "nix-pills";

    src = sources;

    buildInputs = with pkgs; [
      libxslt
    ];

    installPhase = ''
      runHook preInstall

      # Generate the HTML manual.
      dst=$out/share/doc/nix-pills
      mkdir -p "$dst"
      xsltproc \
        ${manualXsltprocOptions} \
        --nonet --output "$dst/" \
        "${pkgs.docbook-xsl-ns}/xml/xsl/docbook/xhtml/chunk.xsl" \
        "${combined}"

      mkdir -p "$dst/images/callouts"
      cp -r "${pkgs.docbook-xsl-ns}/xml/xsl/docbook/images/callouts"/*.svg "$dst/images/callouts"

      cp "${./style.css}" "$dst/style.css"

      mkdir -p "$out/nix-support"
      echo "nix-build out $out" >> "$out/nix-support/hydra-build-products"
      echo "doc nix-pills $dst" >> "$out/nix-support/hydra-build-products"

      runHook postInstall
    '';
  };

  epub = pkgs.stdenv.mkDerivation {
    name = "nix-pills-epub";

    src = sources;

    buildInputs = with pkgs; [
      libxslt
      zip
    ];

    installCheckInputs = with pkgs; [
      epubcheck
    ];

    doInstallCheck = true;

    installPhase = ''
      runHook preInstall

      # Generate the EPUB manual.
      dst=$out/share/doc/nix-pills
      mkdir -p "$dst"
      xsltproc \
        ${manualXsltprocOptions} \
        --nonet --output "$dst/epub/" \
        "${pkgs.docbook-xsl-ns}/xml/xsl/docbook/epub3/chunk.xsl" \
        "${combined}"

      mkdir -p "$dst/epub/OEBPS/images/callouts"
      cp -r "${pkgs.docbook-xsl-ns}/xml/xsl/docbook/images/callouts"/*.svg "$dst/epub/OEBPS/images/callouts"
      cp "${./style.css}" "$dst/epub/OEBPS/style.css"

      echo "application/epub+zip" > mimetype
      manual="$dst/nix-pills.epub"
      zip -0Xq "$manual" mimetype
      pushd "$dst/epub" && zip -Xr9D "$manual" *
      popd

      rm -rf "$dst/epub"

      mkdir -p "$out/nix-support"
      echo "nix-build out $out" >> "$out/nix-support/hydra-build-products"
      echo "doc-epub nix-pills $manual" >> "$out/nix-support/hydra-build-products"

      runHook postInstall
    '';

    installCheckPhase = ''
      runHook preInstallCheck

      epubcheck "$manual"

      runHook postInstallCheck
    '';
  };
}