deplate 0.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. data/AUTHORS.TXT +26 -0
  2. data/CHANGES.TXT +177 -0
  3. data/LICENSE.TXT +340 -0
  4. data/NEWS.TXT +29 -0
  5. data/README.TXT +86 -0
  6. data/TODO.TXT +202 -0
  7. data/VERSION.TXT +1 -0
  8. data/bin/deplate +3 -0
  9. data/bin/deplate.bat +2 -0
  10. data/etc/deplate.ini +361 -0
  11. data/lib/deplate.rb +31 -0
  12. data/lib/deplate/abstract-class.rb +30 -0
  13. data/lib/deplate/builtin.rb +11 -0
  14. data/lib/deplate/cache.rb +59 -0
  15. data/lib/deplate/commands.rb +693 -0
  16. data/lib/deplate/common.rb +335 -0
  17. data/lib/deplate/converter.rb +99 -0
  18. data/lib/deplate/core.rb +2705 -0
  19. data/lib/deplate/css/article.css +545 -0
  20. data/lib/deplate/css/deplate.css +699 -0
  21. data/lib/deplate/css/heading-navbar.css +29 -0
  22. data/lib/deplate/css/layout-deplate-print.css +540 -0
  23. data/lib/deplate/css/layout-deplate.css +764 -0
  24. data/lib/deplate/css/sans-serif.css +160 -0
  25. data/lib/deplate/css/serif-e.css +170 -0
  26. data/lib/deplate/css/serif-rel.css +121 -0
  27. data/lib/deplate/css/serif.css +190 -0
  28. data/lib/deplate/css/slides.css +11 -0
  29. data/lib/deplate/css/tabbar-left.css +91 -0
  30. data/lib/deplate/css/tabbar-right-ie.css +14 -0
  31. data/lib/deplate/css/tabbar-right.css +118 -0
  32. data/lib/deplate/css/tabbar-top.css +64 -0
  33. data/lib/deplate/css/tabbar.css +81 -0
  34. data/lib/deplate/css/text-sans-serif.css +154 -0
  35. data/lib/deplate/css/text-serif.css +175 -0
  36. data/lib/deplate/define.rb +439 -0
  37. data/lib/deplate/docbook.rb +738 -0
  38. data/lib/deplate/elements.rb +1355 -0
  39. data/lib/deplate/etc.rb +199 -0
  40. data/lib/deplate/external.rb +135 -0
  41. data/lib/deplate/fmt/dbk-article-4.1.2.rb +21 -0
  42. data/lib/deplate/fmt/dbk-article.rb +46 -0
  43. data/lib/deplate/fmt/dbk-book.rb +46 -0
  44. data/lib/deplate/fmt/dbk-ref.rb +105 -0
  45. data/lib/deplate/fmt/dbk-slides.rb +47 -0
  46. data/lib/deplate/fmt/dbk-snippet.rb +21 -0
  47. data/lib/deplate/fmt/html-snippet.rb +21 -0
  48. data/lib/deplate/fmt/html.rb +1696 -0
  49. data/lib/deplate/fmt/htmlsite.rb +419 -0
  50. data/lib/deplate/fmt/htmlslides.rb +21 -0
  51. data/lib/deplate/fmt/htmlwebsite.rb +70 -0
  52. data/lib/deplate/fmt/latex-snippet.rb +22 -0
  53. data/lib/deplate/fmt/latex.rb +1242 -0
  54. data/lib/deplate/fmt/php.rb +19 -0
  55. data/lib/deplate/fmt/phpsite.rb +19 -0
  56. data/lib/deplate/fmt/plain.rb +598 -0
  57. data/lib/deplate/fmt/template.rb +34 -0
  58. data/lib/deplate/fmt/xhtml10t.rb +41 -0
  59. data/lib/deplate/formatter-snippet.rb +17 -0
  60. data/lib/deplate/formatter.rb +1210 -0
  61. data/lib/deplate/input.rb +492 -0
  62. data/lib/deplate/input/deplate-headings.rb +48 -0
  63. data/lib/deplate/input/deplate-restricted.rb +70 -0
  64. data/lib/deplate/input/deplate.rb +28 -0
  65. data/lib/deplate/input/rdoc.rb +277 -0
  66. data/lib/deplate/input/template.rb +29 -0
  67. data/lib/deplate/lib/latex/highlight-extra.sty +15 -0
  68. data/lib/deplate/lib/latex/highlight-typical.sty +15 -0
  69. data/lib/deplate/lib/tabmenu.js +146 -0
  70. data/lib/deplate/locale/de.latin1 +708 -0
  71. data/lib/deplate/locale/ru.koi8-r +48 -0
  72. data/lib/deplate/locale/zh_cn.gb2312 +35 -0
  73. data/lib/deplate/macros.rb +639 -0
  74. data/lib/deplate/messages.rb +120 -0
  75. data/lib/deplate/metadata.rb +77 -0
  76. data/lib/deplate/metadata/marshal.rb +24 -0
  77. data/lib/deplate/metadata/xml.rb +42 -0
  78. data/lib/deplate/metadata/yaml.rb +26 -0
  79. data/lib/deplate/mod/anyword.rb +56 -0
  80. data/lib/deplate/mod/babelfish.rb +27 -0
  81. data/lib/deplate/mod/code-gvim.rb +52 -0
  82. data/lib/deplate/mod/code-highlight.rb +91 -0
  83. data/lib/deplate/mod/colored-log.rb +17 -0
  84. data/lib/deplate/mod/de.rb +19 -0
  85. data/lib/deplate/mod/en.rb +17 -0
  86. data/lib/deplate/mod/endnotes.rb +60 -0
  87. data/lib/deplate/mod/fr.rb +46 -0
  88. data/lib/deplate/mod/html-asciimath.rb +40 -0
  89. data/lib/deplate/mod/html-deplate-button.rb +15 -0
  90. data/lib/deplate/mod/html-headings-navbar.rb +39 -0
  91. data/lib/deplate/mod/html-obfuscate-email.rb +47 -0
  92. data/lib/deplate/mod/html-sidebar.rb +232 -0
  93. data/lib/deplate/mod/htmlslides-navbar-fh.rb +32 -0
  94. data/lib/deplate/mod/iconv.rb +35 -0
  95. data/lib/deplate/mod/imgurl.rb +30 -0
  96. data/lib/deplate/mod/inlatex-compound.rb +69 -0
  97. data/lib/deplate/mod/koma.rb +109 -0
  98. data/lib/deplate/mod/latex-emph-table-head.rb +38 -0
  99. data/lib/deplate/mod/latex-styles.rb +461 -0
  100. data/lib/deplate/mod/latex-verbatim-small.rb +29 -0
  101. data/lib/deplate/mod/makefile.rb +194 -0
  102. data/lib/deplate/mod/mark-external-urls.rb +38 -0
  103. data/lib/deplate/mod/markup-1-warn.rb +37 -0
  104. data/lib/deplate/mod/markup-1.rb +41 -0
  105. data/lib/deplate/mod/navbar-png.rb +33 -0
  106. data/lib/deplate/mod/noindent.rb +32 -0
  107. data/lib/deplate/mod/numpara.rb +40 -0
  108. data/lib/deplate/mod/particle-math.rb +34 -0
  109. data/lib/deplate/mod/php-extra.rb +44 -0
  110. data/lib/deplate/mod/pstoedit.rb +71 -0
  111. data/lib/deplate/mod/recode.rb +57 -0
  112. data/lib/deplate/mod/ru_koi8-r.rb +20 -0
  113. data/lib/deplate/mod/smiley.rb +50 -0
  114. data/lib/deplate/mod/soffice.rb +23 -0
  115. data/lib/deplate/mod/symbols-latin1.rb +58 -0
  116. data/lib/deplate/mod/symbols-od-utf-8.rb +16 -0
  117. data/lib/deplate/mod/symbols-plain.rb +58 -0
  118. data/lib/deplate/mod/symbols-sgml.rb +97 -0
  119. data/lib/deplate/mod/symbols-utf-8.rb +81 -0
  120. data/lib/deplate/mod/symbols-xml.rb +34 -0
  121. data/lib/deplate/mod/syntax-region-alt.rb +37 -0
  122. data/lib/deplate/mod/utf8.rb +49 -0
  123. data/lib/deplate/mod/validate-html.rb +35 -0
  124. data/lib/deplate/mod/xmlrpc.rb +233 -0
  125. data/lib/deplate/mod/zh-cn-autospace.rb +108 -0
  126. data/lib/deplate/mod/zh-cn.rb +59 -0
  127. data/lib/deplate/once-method.rb +44 -0
  128. data/lib/deplate/output.rb +249 -0
  129. data/lib/deplate/particles.rb +815 -0
  130. data/lib/deplate/regions.rb +1076 -0
  131. data/lib/deplate/structured.rb +763 -0
  132. data/lib/deplate/template.rb +430 -0
  133. data/lib/deplate/templates/html-doc.html +28 -0
  134. data/lib/deplate/templates/html-left-tabbar-js.html +37 -0
  135. data/lib/deplate/templates/html-left-tabbar.html +31 -0
  136. data/lib/deplate/templates/html-tabbar-right-table.html +43 -0
  137. data/lib/deplate/templates/html-tabbar-right.html +23 -0
  138. data/lib/deplate/templates/html-tabbar-top.html +43 -0
  139. data/lib/deplate/templates/html-tabbar.html +31 -0
  140. data/lib/deplate/wiki-markup.rb +117 -0
  141. data/lib/deplate/xml.rb +109 -0
  142. data/lib/deplate/zh-cn.rb +59 -0
  143. data/lib/ps2ppm.rb +239 -0
  144. data/man/man1/deplate.1 +692 -0
  145. metadata +210 -0
data/NEWS.TXT ADDED
@@ -0,0 +1,29 @@
1
+ * deplate 0.7.3
2
+
3
+ This release contains many small changes, fixes, and improvements.
4
+
5
+ Easier configuration; can be fully localized; define elements and particles right in the document; some new modules & formatters; improved support for rdoc input.
6
+
7
+ Changes:
8
+ - The #Html, #Latex shortcuts for #Native were disabled.
9
+ - Template formatter can be used from the command line.
10
+ - Module for LaTeX like ($\math$) math markup.
11
+ - deplate can be fully localized.
12
+ - Variables can be hashes & array; improved support for boolean variables.
13
+ - Auxiliary files can be putted in a subdirectory (e.g., FILENAME_files).
14
+ - Improved utf8 support. On-the-fly transcoding via iconv (if available).
15
+ - Read user setting from ~/deplate/deplate.ini (which should make ruby hacking obsolete for most users).
16
+ - Php output (basically the same as HTML).
17
+ - In extended wiki links, both arguments get fully parsed (i.e., they may contain macros).
18
+ - Improved support for rdoc
19
+ - New elements, particles can be defined in the source document, no ruby hacking requires (experimental).
20
+ - Text can be embedded in comments.
21
+ - Can mix input formats (currently, only the inclusion of rdoc documents in deplate documents is supported).
22
+ - Improved xmlrpc server.
23
+ - Formatters for small text snippets.
24
+ - Improved support for bibtex files.
25
+ - Run "deplate -m makefile INPUT FILES" to create a standard Makefile.
26
+
27
+ For other changes please see the log.
28
+
29
+ % vi: ft=viki:tw=0:ts=4
data/README.TXT ADDED
@@ -0,0 +1,86 @@
1
+ deplate -- convert wiki-like markup to latex, docbook, html, and
2
+ "html-slides"
3
+ Copyright (C) 2004 Thomas Link
4
+
5
+ This program is free software; you can redistribute it and/or modify
6
+ it under the terms of the GNU General Public License as published by
7
+ the Free Software Foundation; either version 2 of the License, or
8
+ (at your option) any later version.
9
+
10
+ This program is distributed in the hope that it will be useful,
11
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ GNU General Public License for more details.
14
+
15
+ You should have received a copy of the GNU General Public License
16
+ along with this program; if not, write to the Free Software
17
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18
+ USA
19
+
20
+ ---
21
+
22
+ = Install
23
+
24
+ == The source distribution
25
+
26
+ Either:
27
+
28
+ $ ruby setup.rb config
29
+ $ ruby setup.rb setup
30
+ # ruby setup.rb install (may require root privilege)
31
+
32
+ Or (short):
33
+
34
+ # ruby setup.rb (may require root privilege)
35
+
36
+ Or if you have sh/bash (but this is just a wrapper for the above):
37
+
38
+ $ ./configure --help
39
+ $ ./configure
40
+ $ make
41
+ # make install
42
+
43
+ Download the latest source-code from the sourceforge project site:
44
+
45
+ http://sourceforge.net/projects/deplate/
46
+
47
+ The files in the "debian" sub-directory were contributed by Maxim Komar.
48
+ You might want to adjust some paths.
49
+
50
+
51
+ == The ruby gem distribution
52
+
53
+ The gem file can be installed by running
54
+
55
+ $ gem install deplate-VERSION.gem
56
+
57
+ When installing from a gem file, it could be necessary to manually
58
+ link/copy the deplate starter script in the GEMDIR/bin directory.
59
+
60
+
61
+ == The win-32 distribution
62
+
63
+ The win32 binary was created with exerb[1] and is supposed to work
64
+ without ruby being installed. The binary is self-contained and doesn't
65
+ rely on any extranous files. Just copy the binary into a directory in
66
+ PATH.
67
+
68
+ The distribution directory contains some extra files in the rc
69
+ directory, which you could copy to the respective sub-directories in
70
+ ~/.deplate/.
71
+
72
+ [1] http://exerb.sourceforge.jp/index.en.html
73
+
74
+
75
+ = Documentation
76
+
77
+ The documentation is distributed in a separate archive or can be
78
+ downloaded from
79
+
80
+ http://deplate.sf.net/deplate.html
81
+
82
+ The online manual usually corresponds to the latest testing/working
83
+ version.
84
+
85
+
86
+ vim: ft=rd
data/TODO.TXT ADDED
@@ -0,0 +1,202 @@
1
+ * Problems & issues
2
+ ** Current
3
+ #A _ Apply CH's patch, prepare the source to better support his changes
4
+ #A _ A "notice" within a list breaks the list in two -- this shouldn't be
5
+ the case (CH's patch should solve this)
6
+ #A _ International characters in simple wiki names do not work properly
7
+ #B _ check for potential code injection (when using eval)
8
+ #B _ Use Deplate::Cache for ''Deplate::Regions::DefElement''
9
+ #C _ Handling of backslashes in ''DefMacro''
10
+ #D _ ''#DefElement'' & ''#DefParticle'': Does it work with strange
11
+ characters? Are the Rx properly escaped etc.?
12
+ #D _ Misplaced hyperlinks in "BibTeX-files"
13
+
14
+ *** Docbook
15
+ #C _ check for invalid xreflabels
16
+
17
+ *** HTML
18
+ #C _ bibliography & html output: @incollection; @misc without author/editor
19
+
20
+ *** LaTeX
21
+
22
+ ** Other
23
+ #C _ relative/absolute file names & urls in the \{img\} and #IMG: define
24
+ proper behaviour
25
+ #C _ plain headers mustn't increase the heading index
26
+ - but this currently interferes with some other mechanisms (I'm not
27
+ sure if this is still true)
28
+ #C _ define how convert_string should work when invoked repeatedly (with
29
+ respect to #IDX, #ABBREV, ...)
30
+ #C _ manual-sf: I don't understand what causes: "Index: Neither file nor
31
+ level defined: dropping: idx001"
32
+
33
+
34
+ * TODO
35
+ ** 0.7.4
36
+ - Every element should know its original indentation level (if it doesn't
37
+ already)
38
+ - Method/attribute naming: indentation vs. level (heading)
39
+ - Rethink the way lists work (prepare generalized solution for: embedded
40
+ elements � la CH's patch; priority lists � la emacs-planner)
41
+ - Incorporate Csaba Henk's patch
42
+ - emacs-planner style task lists (as module because of a slight ambiguity
43
+ with the markup of commands)
44
+
45
+ ** 0.8
46
+ - #VAR should set the variable during #process & #print too, so that
47
+ variable handling is more intuitive
48
+ - unify region & command
49
+ - don't forget/skip creating test cases
50
+ - citation & bibliography styles
51
+ - HTML: make indexed words be hyperlinked to the index (~~tag cloud)
52
+ - module inlatex-compound.rb: Inlatex, ltx, math: all latex bits are
53
+ collected in one file, compiled in one big dvi file and then separated
54
+ into graphical output (partially done but not fully working yet)
55
+ - the output stuff has to be managed by the formatter class alone
56
+ - a null formatter that doesn't generate any output at all (to be used in
57
+ conjunction with modules that generate/scan metadata and do nothing
58
+ else)
59
+
60
+ ** 0.9
61
+ - Metadata-related stuff should be re-implemented (and made more useful)
62
+ - ''if'', ''ifelse'' macros
63
+ - fully document the code
64
+ - define a way to create a slot from within a deplate document
65
+ - allow addressing slots by name only
66
+ - make autoidx a particle of its own with a volatile rx saved in the
67
+ current instance of Deplate::Core (don't create new classes) -- the rx
68
+ should be a property of Deplate::Core though
69
+ - autoindexing is class-wide; if used in a multi-whatever environment,
70
+ this will result in unexpected indexes (but then: in conjunction
71
+ with some metadata, this probably is what one wants to do)
72
+ - clean up deplate.rb (handling of @sources, \--each, \--many is ...
73
+ suboptimal)
74
+ - reconsider the way indexes & clips & footnotes etc. work
75
+ - make a nice slides css/template that can be used for presentations
76
+ - test output to sciposter (or similar) for LaTeX output
77
+ - text blocks that can be freely placed on a page (at least for HTML &
78
+ LaTeX)
79
+
80
+ ** 1.0
81
+ - check doc variables/parameters for consistent naming
82
+ - in automatically inserted Text, words in \CamelCase mustn't be translated
83
+ to wiki names?
84
+ - LaTeX
85
+ - dense08: decrease the line spacing too
86
+ - longtable
87
+ - Make it possible to define a continuation caption
88
+ - smaller font sizes conflict with caption
89
+ - figures
90
+ - here! doesn't work properly when using longtable & figures
91
+ - HTML: re-check table alignment & positioning
92
+ - HTML + LaTeX: wrap text around floats (tables, figures)
93
+
94
+ * Additional classes for improved functionality
95
+ - "Priority lists" (� la planner mode)
96
+ - Widgets: Calender, Forms (HTML only?)
97
+
98
+ * Additional classes for better support of other wiki markups
99
+ - bold
100
+ - colored text
101
+ - inline html
102
+ - no autolinking region (twiki)
103
+ - center/left/right aligned text (tiki)
104
+ - text box (tiki)
105
+ - special characters (tiki)
106
+ - title bar (tiki)
107
+ - hanging line indent (tiki)
108
+ - nested quotes (E-Mail style quotes)
109
+ - other text styles: underline, strike through ...
110
+
111
+ * Other ideas
112
+ - additional markup classes
113
+ - support for additional wiki markups
114
+ - make the xmlrpc module handle files in subdirectories???; actually test
115
+ it
116
+ - make a php-based wiki that uses deplate via xmlrpc
117
+ - command line options
118
+ --cfg :: load a custom configuration file
119
+ --local-cfg :: allow a directory local configuration file tree
120
+ - htmlsite: make it possible break output at level 2,3... headings too
121
+ - generalize the concept of captions & table of contents; make it possible
122
+ to define arbitrary tables/lists
123
+ - #CAPTION class=NAME: TITLE
124
+ - #LIST: NAME
125
+ - #A, #ANCHOR command
126
+ - integrate with ctags
127
+ - #ACRONYM ... Glossar and acronyms
128
+ - #MAKEGLOSSAR
129
+ - #REQUIRE, #INCLUDE once! ... include a file only once (isn't this
130
+ already the default?)
131
+ - #Filter ... (general region) filter region through an external program,
132
+ insert result as verbatim, image, table etc.
133
+ - String patch Deplate::String ("bla".to_html)
134
+ - html: backreferences from the bibliography to the citation
135
+ - html: citation/bibliography styles?
136
+ - are 3 passes necessary? 2 would probably be sufficient and make things
137
+ easier.
138
+ - a way to define page layouts (it should at least be possible to make
139
+ posters/slides using a html/latex/context formatter)
140
+ - Define styles in deplate
141
+ - poor man's static blog: put articles in folders (YEAR/MONTH/DAY/ID/);
142
+ generate main page (incl menu) + rss with the newest articles; static
143
+ calender (or use \JavaScript?)
144
+ - rss somehow?
145
+ - Mod: rss-item. Erzeugt Region ''#RssItem title=TITLE, desc=@body''.
146
+ Die Items werden mit erstmaligen Datum + Url (im Text hinterlassen
147
+ sie einen Anchor) in einer yaml datei abgespeichert. Die 15 neuesten
148
+ Items werden als RSS-Feed (FILE.rss oder doc_option["rssItemsFile"])
149
+ gespeichert. Au�erdem wird eine HTML Version erzeugt (FILE-log.html,
150
+ doc_option["rssItemsLogFile"]), dass sich wie Template
151
+ (doc_option["rssItemsLogTemplate"]) anpassen l�sst.
152
+ - Nachteil, dass die RSS-items �ber Datei verstreut sind.
153
+ - Mod: rss. Eine Region #Rss, die eine Desc Liste als RSS Feed
154
+ interpretiert.
155
+ - Nachteil, dass man genaue URLs angeben muss, wo das RSS Item
156
+ hinzeigt.
157
+ - The syntax of regions vs. commands vs. macros is stupid -> unify!
158
+ (problem of the use of # for anchors, commands, and regions, which could
159
+ be solved by disallowing text/comments following an anchor or by
160
+ defining a #A command)
161
+ - colours (or maybe not; abstract styles are probably better)
162
+ - Option to keep/convert comments
163
+ - region: Hash
164
+ - Like a description list, but the content is saved as a hash doc option
165
+ (or use XML, YAML, or plain ruby syntax instead?)
166
+ - region: \ListAsTable
167
+ - 1 level items = rows: head, body, foot
168
+ - 2 level items = cells
169
+ ??? Or do it like phpwiki's definition list tables?
170
+ - better markup for tables (yet unseen/unknown)
171
+ - formatter "state": block/element - inline/particle, mathematical - text
172
+ - write a wiki server or a deplate plugin for some existing wiki
173
+ - write a general source code documentation tool that uses deplate markup
174
+ -- or bend rdoc to do so
175
+ - markup for math stuff
176
+
177
+ * Support for additional formats (in & out)
178
+ ** In
179
+ - mediawiki
180
+ - docuwiki
181
+ - pmwiki
182
+ - simplified latex
183
+ - simplified docbook
184
+ - rd
185
+ - markdown
186
+ - textile
187
+
188
+ ** Out
189
+ - \OpenDocument
190
+ - direct pdf output via the pdf-writer library
191
+ - rtf formatter (only if it can be done better than docbook+jade does and
192
+ if it is easier to implement than an \OpenDocument formatter)
193
+ - a deplate formatter (once there is a LaTeX input filter; make it so that
194
+ a roundtrip like deplate -> latex -> deplate doesn't produce too much
195
+ noise)
196
+
197
+
198
+ % @Last Change: 07-J�n-2005.
199
+ % vi: ft=viki:tw=78
200
+ % Local Variables:
201
+ % vikiNoSimpleNames: 1
202
+ % End:
data/VERSION.TXT ADDED
@@ -0,0 +1 @@
1
+ 0.7.3-2132
data/bin/deplate ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ require 'deplate'
3
+ Deplate::Core.deplate
data/bin/deplate.bat ADDED
@@ -0,0 +1,2 @@
1
+ @echo off
2
+ ruby -rdeplate -e Deplate.deplate -- %*
data/etc/deplate.ini ADDED
@@ -0,0 +1,361 @@
1
+ ; % * deplate.ini
2
+
3
+ ; % This is the ini file for deplate. It doesn't adhere to the section
4
+ ; % format usually used in ini-files. Instead it consists of simple
5
+ ; % commands or variable definitions. If you need to do something more
6
+ ; % sensible like making a variable's value dependent of the computer
7
+ ; % name, you have to write Ruby code and save it into config.rb. (See the
8
+ ; % manual for details.)
9
+
10
+ ; % ** Module
11
+ ; % mod <+module name+>
12
+
13
+ ; % ** Clips
14
+ ; % clip author=<+AUTHOR+>
15
+
16
+ ; % ** Applications
17
+ ; % app <+name+>=<+absolute file name+>
18
+
19
+ ; % ** Options
20
+ ; % option out=bla.out
21
+
22
+ ; % ** Wikis
23
+ ; % wikichars A-Z��� a-z��������������
24
+ ; % wikichars <+UPPER CASE LETTERS+> <+lower case letters+>
25
+ ; % wiki <+NAME+>.<+suffix+> = file://<+basedir+>
26
+
27
+ ; % ** Environment Variables
28
+ ; % $HOME=f:/
29
+
30
+ ; % ** Variables
31
+ ; *** General
32
+ ; authorSep :: A string used to concatenate author names in some
33
+ ; occasions (STRING, default: ;)
34
+
35
+ ; autoindex :: Enable automatically adding entries to index (BOOLEAN,
36
+ ; default: false)
37
+
38
+ ; autoFileNames :: Enable automatic generation of file names based on
39
+ ; the top heading for multi-file output (BOOLEAN, default: false)
40
+
41
+ ; auxiliaryDirSuffix :: If defined, auxiliary files will be put into
42
+ ; a subdirectory named after the base name of the root file plus this
43
+ ; suffix (STRING)
44
+
45
+ ; class :: The document class; used in LaTeX (= document class) or
46
+ ; HTML output (= CSS) (STRING)
47
+
48
+ ; codeStyle :: The default style used for formatting code regions;
49
+ ; depends on the backend (STRING)
50
+
51
+ ; codeSyntax :: The default syntax for #Code regions (STRING)
52
+
53
+ ; description :: A short description of the document (STRING)
54
+
55
+ ; docBasename :: The base name of the output document (STRING)
56
+
57
+ ; embeddedTextRx :: A regular expression matching embedded text
58
+ ; (submatch $1) (REGULAR EXPRESSION)
59
+
60
+ ; embeddedVerbatim :: The region name that will be used for text not
61
+ ; matching ''embeddedTextRx'' (STRING, default: Verbatim)
62
+
63
+ ; encoding :: The default encoding; dependent on the output format (STRING)
64
+ ; HTML :: ISO-8859-1
65
+ ; LaTeX :: latin1
66
+ ; XML :: UTF-8
67
+
68
+ ; floatAlign :: The default alignment of floats; dependent on the
69
+ ; output format (STRING)
70
+
71
+ ; headings :: The headings style (STRING)
72
+ ; plain :: Don't number headings
73
+
74
+ ; imgSfx :: The default suffix for images (STRING, default: png)
75
+
76
+ ; indexwiki :: If "no", don't autoindex extended wiki links (STRING)
77
+ ; - <+TBD+>This will be subject of change
78
+
79
+ ; inlatexPrelude :: A string or array of strings that will be
80
+ ; prepended to each inline LaTeX snippet
81
+
82
+ ; inlatexHeight, inlineLatexHeight :: Define the ''h'' parameter of
83
+ ; images generated by an inline LaTeX snippet (NUMBER)
84
+
85
+ ; ltxSfx :: The suffix of images generated by an inline LaTeX snippet
86
+ ; (STRING, default: dependent on the output format)
87
+
88
+ ; keywords :: The keyword to categorize the document; either an array
89
+ ; of strings or a list separated by [,;]
90
+
91
+ ; levelshift :: Shift heading levels (NUMBER)
92
+
93
+ ; ltxPrelude :: Like ''inlatexPrelude'' but used for the ''ltx''
94
+ ; macro only
95
+
96
+ ; mathPrelude :: Like ''inlatexPrelude'' but used for the ''math''
97
+ ; macro only
98
+
99
+ ; noExplicitNumbering :: Ignore the explicit numbering in lists (BOOLEAN)
100
+
101
+ ; pdfOutput :: Automatically set when using pdf output (the ''--pdf''
102
+ ; command line switch) (BOOLEAN)
103
+
104
+ ; ps2imgRes :: The resolution used for converting postscript files to
105
+ ; bitmaps, e.g., by ps2ppm (NUMBER, default: 96)
106
+
107
+ ; refButton :: String to be used to represent the wiki references
108
+ ; (STRING)
109
+
110
+ ; rPrelude :: Like ''inlatexPrelude'' but used for Img regions of
111
+ ; type ''R''
112
+
113
+ ; rScanTable :: If non-nil, guess column breaks in R tables (BOOLEAN)
114
+
115
+ ; stdoutSeparator :: A string printed after each output unit when
116
+ ; using multi-file output and when redirecting the output to
117
+ ; STDOUT (STRING)
118
+
119
+ ; suffix :: The suffix to be used when guessing target names
120
+ ; referenced by wiki names (STRING)
121
+ ; - <+TBD+>This will be subject of change
122
+
123
+ ; tableStyle :: The default style for tables (STRING)
124
+
125
+ ; tabwidth :: The tab width used when expanding whitespace (NUMBER,
126
+ ; default: 4)
127
+
128
+ ; template :: The default template for the output (STRING)
129
+
130
+ ; template_version :: Which template engine to use (NUMBER,
131
+ ; default: 2)
132
+
133
+ ; verbatimMargin :: Wrap verbatim regions at this width (NUMBER)
134
+
135
+
136
+ ; *** Output Format
137
+ ; **** HTML
138
+ ; baseUrl :: The document's base url (STRING)
139
+
140
+ ; baseUrlStripDir :: Number of directories to remove when adding a
141
+ ; file name to ''baseUrl'' (NUMBER)
142
+
143
+ ; bodyOptions :: The arguments passed to the ''body'' tag (STRING)
144
+
145
+ ; css :: The document's CSS file(s) (LIST separated by whitespace)
146
+ ; - The output media can be defined in the form: CSS|MEDIA
147
+
148
+ ; cssExtra :: Some extra text to be inserted at css position
149
+ ; (STRING or ARRAY OF STRINGS)
150
+
151
+ ; docNavbar :: If true, display a navigation bar (BOOLEAN)
152
+
153
+ ; explorerHack :: Code to deal with browser-specific stuff; inserted
154
+ ; at head position (STRING or ARRAY OF STRINGS)
155
+
156
+ ; headExtra :: Other HTML code to be inserted
157
+ ; at head position (STRING or ARRAY OF STRINGS)
158
+
159
+ ; homeButton :: The "home" button in the navigation bar
160
+ ; (STRING, default: [-])
161
+
162
+ ; metaDataExtra :: Other HTML code to be inserted
163
+ ; at head position (STRING or ARRAY OF STRINGS)
164
+
165
+ ; nextButton :: The "next" button in the navigation bar
166
+ ; (STRING, default: >>)
167
+
168
+ ; nextKey :: The keycode for jumping to the next page
169
+ ; (NUMBER, default: 16)
170
+
171
+ ; noBindKeys :: If true, don't bind keys for jumping to the previous
172
+ ; or next page (BOOLEAN, default: false)
173
+
174
+ ; noGenerator :: If true, don't add a generator tag (BOOLEAN,
175
+ ; default: false)
176
+
177
+ ; noNavMenu :: If true, don't add a menu to the navigation bar
178
+ ; (BOOLEAN, default: false)
179
+
180
+ ; noSwallow :: If true, don't swallow paragraphs in html-slides
181
+ ; output format (BOOLEAN, default: false)
182
+
183
+ ; noTabBarButtons :: If true, don't add buttons to the navigation bar
184
+ ; (BOOLEAN, default: false)
185
+
186
+ ; pageIcon :: The page icon tag (STRING)
187
+
188
+ ; prevButton :: The "previous" button in the navigation bar
189
+ ; (STRING, default: <<)
190
+
191
+ ; prevKey :: The keycode for jumping to the previous page
192
+ ; (NUMBER, default: 8)
193
+
194
+ ; shortcutIcon :: The shortcut icon tag (STRING)
195
+
196
+ ; styleExtra :: Some extra CSS information that will be wrapped in a
197
+ ; style tag (STRING or ARRAY OF STRINGS)
198
+
199
+ ; subToC :: Print a table of contents for the current section after
200
+ ; level 1 headings (BOOLEAN, default: false)
201
+
202
+ ; tabBar :: Items in the navigation bar (ARRAY OF STRINGS,
203
+ ; default: ["[auto]"])
204
+
205
+ ; tabBarButtons :: If true, don't add buttons to the navigation bar
206
+ ; (BOOLEAN, default: true)
207
+ ; - <+TBD+>Conflict with ''noTabBarButtons''?
208
+
209
+ ; tabEqualWidths :: If true, tabs will have equal width
210
+ ; (BOOLEAN, default: false)
211
+
212
+ ; tabBarHomeName :: The display name of the front page in the
213
+ ; navigation bar (STRING, default: <+TBD+>)
214
+
215
+ ; tabBarSep :: The separater between display names and URLs in
216
+ ; manual defintions of the navigation bar (STRING, default: |)
217
+
218
+ ; tableWidth :: The default table width
219
+
220
+ ; useDublinCore :: If true, use Dublin core tags instead of the
221
+ ; standard meta tags (BOOLEAN, default: false)
222
+
223
+
224
+ ; **** LaTeX
225
+ ; classOptions :: Options passed on to the document class (LIST
226
+ ; separated by whitespace or comma)
227
+
228
+ ; DIV (koma) :: If set, use KOMA script's typearea package; use this
229
+ ; variable to define the proportion of the printed area on a page;
230
+ ; see the KOMA script manual for details (NUMBER)
231
+
232
+ ; floatHere :: If true, add a ''h'' flag to floats (BOOLEAN,
233
+ ; default: false)
234
+
235
+ ; linespread :: If set, define the ''linespread'' parameter (NUMBER)
236
+
237
+ ; noteSize :: The font size for margin notes (NUMBER,
238
+ ; default: footnotesize)
239
+
240
+ ; texLists :: If set to ''wide'', the generated source will contain
241
+ ; more linebreaks. Otherwise the lines will be more condensed.
242
+
243
+ ; useBooktabs :: If true, use the booktabs package (BOOLEAN, default: false)
244
+
245
+
246
+ ; **** Docbook
247
+ ; copyrightYear :: The year field in the copyright section (STRING)
248
+
249
+ ; dbkEntities :: Entities to be added to the doctype tag (ARRAY OF
250
+ ; STRINGS)
251
+
252
+ ; dbkVersion :: The docbook version to use (STRING, default: 4.2)
253
+
254
+ ; manvol :: The manual volume to use for dbk-ref output (NUMBER,
255
+ ; default: 1)
256
+
257
+ ; refentry :: The reference category used by for dbk-ref output
258
+ ; (STRING)
259
+
260
+ ; sgml :: If true, try to be SGML compliant; useful when using tools
261
+ ; like openjade (BOOLEAN, default: false)
262
+
263
+ ; tableFrame :: The frame parameter for tables (STRING,
264
+ ; default: topbot)
265
+
266
+
267
+ ; *** Module
268
+ ; **** Anyword
269
+ ; anyword_catalog :: A catalog file containing automatically linked
270
+ ; words (STRING)
271
+
272
+ ; anyword_list :: A comma separated list of automatically linked
273
+ ; words (STRING)
274
+
275
+ ; anyword_pattern :: A glob pattern for file names in the current
276
+ ; directory the base names of which will be added to the list of
277
+ ; automatically linked words (STRING)
278
+
279
+ ; anyword_suffix :: The suffix to use when scanning the directory
280
+ ; using ''anyword_pattern'' (STRING)
281
+
282
+
283
+ ; **** CJK
284
+ ; cjk_encoding :: The default encoding (STRING, default: GB)
285
+
286
+ ; cjk_family :: The default font family (STRING, default: gbsn)
287
+
288
+ ; noSmartBlanks :: If true, guess whether a whitespace should go into
289
+ ; the output (BOOLEAN, default: false)
290
+
291
+
292
+ ; **** html-headings-navbar
293
+ ; headingsNavbarMaxLevel :: Add heading up to this level to the
294
+ ; navigation bar (NUMBER)
295
+
296
+
297
+ ; **** html-sidebar
298
+ ; Deprecated module.
299
+ ; mouseThresholdIn :: (NUMBER)
300
+ ; mouseThresholdOut :: (NUMBER)
301
+ ; navGif :: (STRING)
302
+
303
+
304
+ ; **** latex-verbatim-small
305
+ ; verbSize :: Font size for verbatim regions (NUMBER,
306
+ ; default: footnotesize)
307
+
308
+
309
+ ; **** Mark External URLs
310
+ ; mailtoIcon :: The file name of the e-mail icon (STRING, default: mailto.png)
311
+
312
+ ; urlIcon :: The file name of the external URL icon (STRING,
313
+ ; default: url.png)
314
+
315
+
316
+ ; **** navbar-png
317
+ ; buttonsColour :: The subtype of the button images
318
+
319
+ ; buttonsFileFormat :: The image suffix (STRING, default: png)
320
+
321
+
322
+ ; **** Obfuscate E-Mail
323
+ ; noObfuscatedNoscript :: If true, put only the name into the
324
+ ; noscript tag (BOOLEAN, default: false)
325
+
326
+ ; obfuscatedNoscriptAt :: How to display the @ sign in the noscript
327
+ ; region (STRING, default: AT )
328
+
329
+ ; obfuscatedNoscriptDot :: How to display periods in the noscript
330
+ ; region (STRING, default: DOT )
331
+
332
+
333
+ ; **** pstoedit
334
+ ; pstoeditArgs :: Additional command line arguments (STRING)
335
+
336
+
337
+ ; **** Smileys
338
+ ; smileySfx :: The suffix for smiley image files (STRING, default: png)
339
+
340
+
341
+ ; **** validate-html
342
+ ; noCssValid :: If true, don't add a button for CSS validation
343
+ ; (BOOLEAN, default: false)
344
+
345
+ ; noHtmlValid :: If true, don't add a button for HTML validation
346
+ ; (BOOLEAN, default: false)
347
+
348
+
349
+ ; **** XMLRPC
350
+ ; xmlrpcAllow :: A whitespace separated list of valid IP addresses of
351
+ ; regular expressions matching valid addresses
352
+
353
+ ; xmlrpcPath :: The path for accessing this xmlrpc server (STRING,
354
+ ; default: /deplate)
355
+
356
+ ; xmlrpcPort :: The xmlrpc server port (NUMBER, default: 2000)
357
+
358
+ ; xmlrpcReuseInterpreter :: If non-nil, reuse the converter as if the
359
+ ; requests were part of one big document (BOOLEAN, default: nil)
360
+
361
+