Oppolzer - Informatik / Blog


Blog-Hauptseite      Neuester Artikel      Älterer Artikel      Neuerer Artikel      Älterer gleiche Kategorie      Neuerer gleiche Kategorie

ASSEMBLER-L - Technische Dokumente erstellen mit XML

Subject:

Re: Redesigning the Principles of Operation Manual

From:

Bernd Oppolzer <bernd.oppolzer@T-ONLINE.DE>

Reply-To:

IBM Mainframe Assembler List <ASSEMBLER-LIST@LISTSERV.UGA.EDU>

Date:

2014.11.17 08:51:24


BTW:

I build the handouts for my technical classes and other documentation using a
special kind of XML, and from that XML I generate HTML, if needed, or other
representations of the documentation (at the moment I generate ONLY HTML and do
printed representations using a browser and a PDF generating printer driver,
which works pretty well).

AFAIK, there are other "standard" XML formats to do such things, maybe one is
called BookDoc.

Using XML, you can do any kind of markup you want.

I build the XML files using a normal text editor; this is less cumbersome as it
sounds. For me, it is much easier as for example doing the tech writing with
Word or such "tools". You spend absolutely no time with layout etc.; your only
concern is the content.

There are XML tags like

- paragraphs
- enumerations
- deflists
- text boxes
- source boxes (monospaced)
- source code (monospaced)
- images
- tables
- chapters
- subchapters

etc. etc.

Kind regards

Bernd



Am 16.11.2014 23:43, schrieb R.V.:
> Such a document could likewise serve a input to a filter
>> generating HTML or other hypertext media; PDF; odt; ods;
>> ...; quodlibet.
>
> HTML isn't something that a manual should be in.
> It almost never prints properly (prints half-lines etc), doesn't have
> organised
> page numbers or index, etc etc.

Blog-Hauptseite      Neuester Artikel      Älterer Artikel      Neuerer Artikel      Älterer gleiche Kategorie      Neuerer gleiche Kategorie