blob: 56265f60c66156c4d4e82ae34b921e553beb1df4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
========================
M2Crypto Documentation
========================
:Author: Ng Pheng Siong
:Id: $Id: DOCU,v 1.3 2004/03/21 17:07:44 ngps Exp $
2004-03-21
------------
As it turns out, I now have teTeX installed. So it looks like I'll
be using vim + LaTeX for documentation.
2003-06-22
------------
DocBook wasn't to my taste, and I stopped soon after.
I didn't start again, until recently. ;-)
I now write in ReStructuredText. I use Zope as the content management
system, which has the advantage of automatic HTML rendering. Not
having to run the Jade command line shown below (or the
ReStructuredText equivalent) to generate HTML is like getting rid of
the "compile/link" step in the "edit-compile/link-run"
cycle. Productivity goes up!
Of course, nobody in his right mind does serious editing using Zope's
TTW interface. I use Emacs/ange-ftp.
I envisage some kind of ReportLab-based magic to generate PDF output
easily from within Zope.
15 Dec 2001
-------------
Here begins documentation.
A year ago, I started writing documentation in Structured Text, but didn't
get very far.
I'm currently writing in DocBook. I use the following to process the
DocBook files:
- DocBook 4.1
- Modular DSSSL stylesheets 1.64
- Jade 1.2.1
- SP 1.3.4
- ISO 8879-1986 character entity sets. (I don't really know how these are used.)
I invoke Jade thusly::
jade -V nochunks -t sgml -d /.../html/docbook.dsl file.docbook > file.html
|
