Skip to content

doc: point to openjade; provide instructions for Lyx->SGML; provide pointers to Debian packages #40

@paravoid

Description

@paravoid

It took me a while to figure out how to regenerate the ipv6calc.html file from the source ipv6calc.lyx file. I'm filing this to document this for others, and perhaps as a feature enhancement request for doc/generate.sh:

This is a two step process: first, the Lyx file is generated to an SGML. Second, the SGML to the HTML. (Note: I have not figured out what the purpose of the XML file in the source tree is.).

Only the second step is actually in generate.sh.

Step 1: Lyx to SGML

  1. apt install lyx docbook-utils
  2. cd doc && lyx --export docbook ipv6calc.lyx

Step 2: SGML to HTML

The build system seems to be using "jade", but this is an old piece of software that has been forked in the meantime. Replacing "jade" with "openjade" seems to work just fine.

  1. apt install opensp openjade docbook docbook-dsssl
  2. cd doc && onsgmls -s ipv6calc.sgml (This is optional and just validates the SGML. ./generate.sh does this)
  3. cd doc && openjade -t sgml -i html -V nochunks -d "ldp.dsl#html" ipv6calc.sgml > ipv6calc.html (./generate.sh does this)

As an alternative:

  1. (as above)
  2. (as above)
  3. apt install ldp-docbook-dsssl
  4. cd doc && openjade -t sgml -i html -V nochunks -d "docbook/stylesheet/dsssl/ldp/ldp.dsl#html" ipv6calc.sgml > ipv6calc.html (in this case, doc/ldp.dsl is not necessary and can be removed)

ldp here stands for "Linux Documentation Project", and the ldp.dsl file is almost a pristine copy compared to the system copy as shipped in the ldp-docbook-dsssl package.

Versions used

This was under a Debian sid with Lyx v2.3.7, Docbook 4.5, Docbook-utils 0.6.14, Docbook-DSSSL 1.79, OpenJade 1.4devel1, opensp 1.5.2

Metadata

Metadata

Assignees

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions