On Dec 21, 2017, at 23:15, Mike Carroll <druidl...@gmail.com> wrote:
> What tool(s) do you use to work on DocBook files?
The build-chain for turning the DocBook 5 sources into (X)HTML and PDF uses
XsltProc and Apache Fop. You’ll also need the DocBook 5 stylesheets themselves.
You can find instructions for getting and configuring the various pieces in the
‘DOCUMENTATION’ section of ‘INSTALL’.
For hacking on the actual markup, I personally use GNU Emacs (yes, I am
occasionally accused of masochistic tendencies), although pretty much any text
editor will serve. There are also a number of specialized editors for DocBook
out there (both FOSS and closed-source) that should work fine as well, although
I have no personal experience with any of those. For looking at the rendered
content, I use the Evince PDF viewer, which has a nifty feature where it will
automatically reload the PDF when it sees the timestamp on the underlying file
advance. A *huge* time saver.
The good news is that you don’t need to be a Docbook Ninja in order to work on
the Ops Guide! While the number of files in ‘docs/opsguide/‘ can look
intimidatingly large at first glance, the only ones you really need to deal
with are the ones that end with ‘.xml’. As of this writing (v2.18.1), the
entire list is:
*** snip snip ***
filepath_wildcards.xml rdadmin.xml rdlogmanager.xml
frontspiece.xml rdairplay.xml rivendell_filter.xml
gpio_switcher_devices.xml rdcartslots.xml rml.xml
gplv2.xml rdcatch.xml utilities.xml
metadata_wildcards.xml rdlibrary.xml voicetracking.xml
opsguide.xml rdlogedit.xml wings_filter.xml
overview.xml rdlogin.xml
*** snip snip ***
Basically, one file for each chapter or appendix (plus 'opsguide.xml’, which is
the top-level ‘glue’ that brings all of the pieces together). Open one up in a
text editor, make some changes, then do ‘make’ to see what happens. You’ll get
the hang of it quickly.
Cheers!
|----------------------------------------------------------------------|
| Frederick F. Gleason, Jr. | Chief Developer |
| | Paravel Systems |
|----------------------------------------------------------------------|
| Do not try to think outside of the box. That's impossible. |
| Instead, realise the truth. There is no box. |
| --Quoted by "larsmjoh" on GrokLaw.net |
|----------------------------------------------------------------------|
_______________________________________________
Rivendell-dev mailing list
Rivendell-dev@lists.rivendellaudio.org
http://caspian.paravelsystems.com/mailman/listinfo/rivendell-dev
