deplate 0.8.4 → 0.8.5

data/lib/deplate/wiki-markup.rb

@@ -1,10 +1,11 @@
+# encoding: ASCII
 # wiki-markup.rb
 # @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     10-M�r-2005.
-# @Last Change: 2007-09-01.
-# @Revision:    0.284
+# @Last Change: 2009-02-02.
+# @Revision:    0.286
 #
 # = Description
 # Various elements for defining input filters

data/lib/deplate/xml.rb

@@ -1,31 +1,28 @@
+# encoding: ASCII
 # xml.rb
 # @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     17-M�r-2004.
-# @Last Change: 2007-07-21.
-# @Revision:    0.2318
-# 
-# TODO:
-# - 
+# @Last Change: 2009-02-05.
+# @Revision:    0.2335
 
-# An abstract xml formatter
-
-require "deplate/structured"
+require 'deplate/structured'
 
+# An abstract xml formatter
 class Deplate::Formatter::XML < Deplate::Formatter::Structured
-    self.suffix = ".xml"
+    self.suffix = '.xml'
 
     def initialize(deplate, args)
         deplate.options.indentation_level = [0]
         super
         @special_symbols = {
-            "\"" => Proc.new {|e| symbol_quote(nil)},
-            "&"  => Proc.new {|e| symbol_amp(nil)},
-            "�"  => Proc.new {|e| symbol_paragraph(nil)},
-            "<"  => Proc.new {|e| symbol_lt(nil)},
-            ">"  => Proc.new {|e| symbol_gt(nil)},
-            " "  => Proc.new {|e| e ? nonbreakingspace(nil) : ' '},
+            '"'  => Proc.new {|e| symbol_quote(nil)},
+            '&'  => Proc.new {|e| symbol_amp(nil)},
+            # '�'  => Proc.new {|e| symbol_paragraph(nil)},
+            '<'  => Proc.new {|e| symbol_lt(nil)},
+            '>'  => Proc.new {|e| symbol_gt(nil)},
+            ' '  => Proc.new {|e| e ? nonbreakingspace(nil) : ' '},
         }
         build_plain_text_rx
         @encodings = {
@@ -36,7 +33,7 @@ class Deplate::Formatter::XML < Deplate::Formatter::Structured
     
     def pre_process
         super
-        @encoding = canonic_enc_name(@deplate.variables["encoding"] || "utf-8")
+        @encoding = canonic_enc_name(@deplate.variables['encoding'] || 'utf-8')
         if @deplate.options.symbols_encoding
             symbols = @deplate.options.symbols_encoding
         elsif @deplate.variables['sgml']
@@ -67,9 +64,9 @@ class Deplate::Formatter::XML < Deplate::Formatter::Structured
     end
     
     def prepare
-        creator = ["===================================================",
-            "== Created with deplate (http://deplate.sf.net) ==",
-            "==================================================="]
+        creator = ['===================================================',
+            '== Created with deplate (http://deplate.sf.net) ==',
+            '===================================================']
         output_at(:pre, :doc_def,   get_doc_def({:deplate => @deplate}))
         output_at(:pre, :doc_def,   get_comment(creator))
         output_at(:pre, :doc_beg,   get_doc_open({}))
@@ -86,9 +83,10 @@ class Deplate::Formatter::XML < Deplate::Formatter::Structured
     end
 
     def plain_text(text, escaped=false, vapor_space=true)
+        # p "DBG", text, caller[0..3]
         super(text, escaped) do |accum|
             if vapor_space
-                accum.join.gsub(/ {2,}/, " ")
+                accum.join.gsub(/ {2,}/, ' ')
             else
                 accum.join
             end
@@ -96,7 +94,7 @@ class Deplate::Formatter::XML < Deplate::Formatter::Structured
     end
 
     def encode_id(text)
-        text ? text.gsub(/\W/, "00") : ""
+        text ? text.gsub(/\W/, '00') : ''
     end
 
     def get_comment(strings)

data/lib/deplate/zh_CN.rb

@@ -1,10 +1,11 @@
+# encoding: ASCII
 # zh-cn.rb -- Simplified Chinese messages
 # @Author:      Thomas Link; localization by Jjgod Jiang (gzjjgod AT 21cn com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     01-Aug-2004.
-# @Last Change: 2007-09-02.
-# @Revision:    0.217
+# @Last Change: 2009-02-02.
+# @Revision:    0.219
 
 require 'deplate/messages'
 

data/man/man1/deplate.1

@@ -2,39 +2,36 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "DEPLATE" "1" "06. Jul 2008" "" ""
+.TH "DEPLATE" "1" "06. Feb 2009" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-deplate \- Deplate 0.8.2 \-\- convert wiki\-like markup to latex, docbook, html, or "html\-slides"
+deplate \- Deplate 0.8.5 \-\- convert wiki\-like markup to latex, docbook, html, or "html\-slides"
 .SH "USAGE"
 .PP
 The command\-line options:
 .sp
 .nf
 Usage: deplate.rb [OPTIONS] FILE [OTHER FILES ...]
-deplate is a free software with ABSOLUTELY NO WARRANTY 
-under
+deplate is a free software with ABSOLUTELY NO WARRANTY under
 the terms of the GNU General Public License version 2.
 General Options:
     \-a, \-\-[no\-]ask                   On certain actions, 
     query user before overwriting files
     \-A, \-\-allow ALLOW                Allow certain things: 
     l, r, t, w, W, x, X, $
-    \-c, \-\-config FILE                Alternative user 
-    cfg file
-        \-\-[no\-]clean                 Clean up temporary 
-        files
+    \-c, \-\-config FILE                Alternative user cfg 
+    file
+        \-\-[no\-]clean                 Clean up temporary files
         \-\-color                      Colored output
-        \-\-css NAME                   Copy NAME.css to 
-        the destination directory, if inexistent
-        \-\-copy\-css NAME              Copy NAME.css to 
-        the destination directory
+        \-\-css NAME                   Copy NAME.css to the 
+        destination directory, if inexistent
+        \-\-copy\-css NAME              Copy NAME.css to the 
+        destination directory
     \-d, \-\-dir DIR                    Output directory
-    \-D, \-\-define NAME=VALUE          Define a document 
-    option
+    \-D, \-\-define NAME=VALUE          Define a document option
     \-e, \-\-[no\-]each                  Handle each file 
     separately
         \-\-[no\-]force                 Force output
@@ -42,14 +39,14 @@ General Options:
     html)
         \-\-[no\-]included              Output body only
     \-i, \-\-input NAME                 Input definition
-        \-\-list FILE                  A file that contains 
-        a list of input files
+        \-\-list FILE                  A file that contains a 
+        list of input files
         \-\-log FILE                   A file (or \- for 
         stdout) where to put the log
-        \-\-[no\-]loop                  Read from stdin 
-        forever and ever
-        \-\-metadata [NAME]            Save metadata in 
-        this format (default: yaml)
+        \-\-[no\-]loop                  Read from stdin forever 
+        and ever
+        \-\-metadata [NAME]            Save metadata in this 
+        format (default: yaml)
     \-m, \-\-module MODULE              Load a module
     \-o, \-\-out FILE                   Output to file or 
     stdout ('\-')
@@ -65,74 +62,69 @@ General Options:
         names
         \-\-split\-level LEVEL          Heading level for 
         splitting
-        \-\-suffix SUFFIX              Suffix for output 
-        files
+        \-\-suffix SUFFIX              Suffix for output files
     \-t, \-\-template NAME              Template to use
         \-\-theme THEME                Theme to use
-        \-\-[no\-]vanilla               Ignore user configuration
-    \-x, \-\-allow\-ruby [RUBY SAFE]     Allow the execution 
-    of ruby code
-    \-X, \-\-[no\-]allow\-exec            Allow the execution 
-    of helper applications
+        \-\-[no\-]vanilla               Ignore user 
+        configuration
+    \-x, \-\-allow\-ruby [RUBY SAFE]     Allow the execution of 
+    ruby code
+    \-X, \-\-[no\-]allow\-exec            Allow the execution of 
+    helper applications
         \-\-[no\-]external
- 
 
 LaTeX Formatter:
-        \-\-[no\-]pdf                   Prepare for use 
-        with pdf(la)tex
- 
+        \-\-[no\-]pdf                   Prepare for use with 
+        pdf(la)tex
 
 Available input defintions:
-deplate, deplate\-headings, deplate\-restricted, play, 
-rdoc, template
- 
+deplate, deplate\-headings, deplate\-restricted, play, rdoc, 
+template
 
 Available formatters:
-dbk\-article, dbk\-article\-4.1.2, dbk\-book, dbk\-ref, dbk\-slides, 
-dbk\-snippet, html, html\-snippet, htmlsite, htmlslides, 
-htmlwebsite, latex, latex\-dramatist, latex\-snippet, null, 
-php, phpsite, plain, template, xhtml10t, xhtml11m
- 
+dbk\-article, dbk\-article\-4.1.2, dbk\-book, dbk\-ref, 
+dbk\-slides, dbk\-snippet, html, html\-snippet, htmlsite, 
+htmlslides, htmlwebsite, latex, latex\-dramatist, 
+latex\-snippet, null, php, phpsite, plain, sweave, template, 
+xhtml10t, xhtml11m
 
 Available metadata formats:
 marshal, xml, yaml
- 
 
 Available modules:
 anyword, babelfish, code\-coderay, code\-gvim, code\-gvim71, 
-code\-highlight, colored\-log, endnotes, entities\-decode, 
-entities\-encode, guesslanguage, html\-asciimath, html\-deplate\-button, 
-html\-headings\-navbar, html\-highstep, html\-jsmath, html\-mathml, 
+code\-highlight, colored\-log, encode, endnotes, 
+entities\-decode, entities\-encode, guesslanguage, 
+html\-asciimath, html\-deplate\-button, html\-headings\-navbar, 
+html\-highstep, html\-jsmath, html\-mathml, 
 html\-obfuscate\-email, html\-sidebar, htmlslides\-navbar\-fh, 
 iconv, imgurl, inlatex\-compound, koma, lang\-de, lang\-en, 
 lang\-ru, lang\-ru\-koi8\-r, lang\-zh_CN, lang\-zh_CN\-autospace, 
 latex\-emph\-table\-head, latex\-styles, latex\-verbatim\-small, 
-linkmap, makefile, mark\-external\-urls, markup\-1, markup\-1\-warn, 
-navbar\-png, noindent, numpara, particle\-math, php\-extra, 
-pstoedit, recode, smart\-dash, smiley, soffice, symbols\-latin1, 
-symbols\-od\-utf\-8, symbols\-plain, symbols\-sgml, symbols\-utf\-8, 
-symbols\-xml, syntax\-region\-alt, utf8, validate\-html, 
-xmlrpc
- 
+linkmap, makefile, mark\-external\-urls, markup\-1, 
+markup\-1\-warn, navbar\-png, noindent, numpara, particle\-math, 
+php\-extra, pstoedit, recode, smart\-dash, smiley, soffice, 
+symbols\-latin1, symbols\-od\-utf\-8, symbols\-plain, 
+symbols\-sgml, symbols\-utf\-8, symbols\-xml, syntax\-region\-alt, 
+utf8, validate\-html, xmlrpc
 
 Available themes:
-CVS, presentation.html
- 
+navbar\-right.html, presentation.html, s5.xhtml
 
 Available css files:
-article, deplate, doc, heading\-navbar, highstep, htmldoc, 
-layout\-deplate, layout\-deplate\-print, play, sans\-serif, 
-serif, serif\-e, serif\-rel, slides, styles, tabbar, tabbar\-left, 
-tabbar\-right, tabbar\-right\-ie, tabbar\-top, text\-sans\-serif, 
-text\-serif
- 
+article, deplate, doc, heading\-navbar, highlight, highstep, 
+htmldoc, layout\-deplate, layout\-deplate\-print, play, 
+presentation, presentation_highstep, presentation_website, 
+sans\-serif, screenplay, serif, serif\-e, serif\-rel, slides, 
+styles, tabbar, tabbar\-left, tabbar\-right, tabbar\-right\-ie, 
+tabbar\-top, text\-sans\-serif, text\-serif, websitary, website
 
 Available templates:
-html\-doc.html, html\-left\-tabbar\-js.html, html\-left\-tabbar.html, 
-html\-tabbar\-right\-pcomments.php, html\-tabbar\-right\-step.html, 
-html\-tabbar\-right\-table.html, html\-tabbar\-right.html, 
-html\-tabbar\-top.html, html\-tabbar.html
- 
+html\-doc.html, html\-left\-tabbar\-js.html, 
+html\-left\-tabbar.html, html\-tabbar\-right\-pcomments.php, 
+html\-tabbar\-right\-step.html, html\-tabbar\-right\-table.html, 
+html\-tabbar\-right.html, html\-tabbar\-top.html, 
+html\-tabbar.html
 
 Other Options:
         \-\-debug [LEVEL]              Show debug messages
@@ -140,8 +132,8 @@ Other Options:
         \-\-[no\-]quiet                 Be quiet
     \-v, \-\-[no\-]verbose               Run verbosely
     \-h, \-\-help                       Show this message
-        \-\-list\-modules [REGEXP]      List modules matching 
-        a pattern
+        \-\-list\-modules [REGEXP]      List modules matching a 
+        pattern
         \-\-list\-css [REGEXP]          List css files matching 
         a pattern
         \-\-version                    Show version
@@ -183,18 +175,18 @@ You can define document variables via the command line; if no value is provided
 The option parser library, which
 deplate
 uses, doesn't deal well with spaces in command line arguments. This is why spaces have to be replaced with tildes; a tilde and backslashes have to be preceded with backslashes. Example:
-\-D text=bla~bla\\~bla
+\-D\ text=bla~bla\\~bla
 sets the document variable
 text
 to "bla bla~bla". As a shell usually interpretes backslashes too, you would usually have to type
-\-D text=bla~bla\\\\~bla.
+\-D\ text=bla~bla\\\\~bla.
 .TP
 \-e
 Process each file separately
 .TP
 \-m, \-\-module MODULE
 Load an add\-on/module (after loading the core and the formatter); modules reside in the deplate library directory or in the user configuration directory ("~/.deplate/mod/"); type
-deplate \-\-help
+deplate\ \-\-help
 to see a list of available modules.
 .sp
 After loading the module, deplate searches for the file "~/.deplate/after/mod/NAME.rb" which will be loaded if found.
@@ -203,46 +195,10 @@ German, Chinese, and Russian localizations are provided as modules.
 .TP
 \-p PATTERN, \-P PATTERN
 Backslashes in the pattern must come in doubles; backslashes can be used to prevent the shell from expanding the pattern; e.g., in case you're using bash, you would usually type something like
-\-p "\\\\*.txt"
+\-p\ "\\\\*.txt"
 .TP
 \-\-theme THEME
-A theme is a collection of
-.RS
-.TP 3
-\(bu
-an ini file (THEME/theme.ini, see also
-Usage
-and
-Configuration)
-.TP
-\(bu
-css files (THEME/css/...)
-.TP
-\(bu
-templates (THEME/templates/...)
-.TP
-\(bu
-a library (THEME/lib/...)
-.TP
-\(bu
-a prelude (THEME/prelude.txt)
-.TP
-\(bu
-additional resources (THEME/resources/*)
-.sp
-All components are optional and are stored in either one of
-.RS
-.TP 3
-\(bu
-~/.deplate/themes/THEME/...
-.TP
-\(bu
-~/.deplate/themes/THEME/...
-.TP
-\(bu
-/lib/ruby/.../deplate/themes/THEME/...
-.RE
-.RE
+See\ ??.
 .TP
 \-x, \-\-allow\-ruby [RUBY SAFE]
 Ruby's SAFE variable has 5 levels (0=no checks/default .. 4=sandbox; at present, this also sets the SAFE variable for
@@ -274,7 +230,7 @@ deplate.rc
 directory too; if you want to allow a
 deplate.ini
 file in this directory, you have the add
-allow r
+allow\ r
 to your private deplate.ini file (usually in
 ~/.deplate/)
 .TP
@@ -312,7 +268,7 @@ Allow referencing options by prepending a name with ":" in some situations (e.g.
 .RE
 .IP
 You can remove the permission to do something by prepending a minus to the flag, e.g. by setting
-\-\-allow \-x
+\-\-allow\ \-x
 on the command line after having allowed
 x
 in the deplate.ini file.
@@ -326,7 +282,7 @@ In multi\-file output, the file name is constructed from the top heading unless
 .TP
 auxiliaryDirSuffix
 If defined, auxiliary files are saved in the subdirectory
-#{basename FILENAME}#{auxiliaryDirSuffix}. E.g., if
+#{basename\ FILENAME}#{auxiliaryDirSuffix}. E.g., if
 auxiliaryDirSuffix
 is "_files" and the current file is "Test", then auxiliary files (images, on\-the\-fly generated files that are passed to external applications etc.) are saved in "Test_files".
 .SS "Editor support"
@@ -555,46 +511,45 @@ and/or
 .PP
 This file contains a sequence of commands. Each command must fit in one line. The following commands are allowed:
 .TP
-allow FLAGS
+allow\ FLAGS
 Allow
 deplate
-to do certain things(see
-Usage)
+to do certain things(see\ Usage)
 .RS
 .TP 3
 \(bu
 If you use deplate only for your own files, you might want to run deplate in "unsafe" mode by adding
-allow all
+allow\ all
 to your deplate.ini file.
 .RE
 .TP
 \-\-OPTION
 Additional command line option
 .TP
-mod NAME
+mod\ NAME
 Load the module NAME
 .TP
-fmt NAME
+fmt\ NAME
 Set the standard formatter
 .TP
-clip NAME=VALUE
+clip\ NAME=VALUE
 Set the clip NAME (e.g., "author") to VALUE
 .TP
-wiki NAME.SUFFIX=BASEURL
+wiki\ NAME.SUFFIX=BASEURL
 Define an interwiki (the
 .SUFFIX
 part is optional)
 .TP
-wikichars UPPERCHARS LOWERCHARS
+wikichars\ UPPERCHARS\ LOWERCHARS
 Define which characters are allowed in wiki names
 .TP
-app NAME=COMMANDLINE
+app\ NAME=COMMANDLINE
 Define an external app (e.g., latex, dvips, R, dot, neato, pstoedit, identify, gs ...)
 .RS
 .TP 3
 \(bu
 If you get a
-Exec format error
+Exec\ format\ error
 error, this is probably caused by a missing executable suffix. To avoid this error, redefine the app and add a
 .exe
 or similar to the name.
@@ -615,19 +570,19 @@ Although this may not always work as expected, you can also set some options by
 option
 keyword:
 .TP
-option NAME~
+option\ NAME~
 Set option NAME to false
 .TP
-option NAME!
+option\ NAME!
 Set option NAME to true
 .TP
-option NAME?=true|false|yes|no|on|off
+option\ NAME?=true|false|yes|no|on|off
 Set option NAME to a boolean value
 .TP
-option NAME%=INTEGER
+option\ NAME%=INTEGER
 Set option NAME to a numeric value
 .TP
-option NAME=VALUE
+option\ NAME=VALUE
 Set option NAME to VALUE as string
 .PP
 Lines beginning with one of
@@ -787,13 +742,13 @@ Some text that in multi\-file mode should appear in every output file, the end o
 .PP
 These commands take a list of slots (named or as numbers) as arguments. The slots can be single slots or ranges. They can be positive (add selectively) or negative (add with the exception of certain content). Examples:
 .TP
-#PREMATTER: \-doc_def
+#PREMATTER:\ \-doc_def
 add the prematter without the document type definition
 .TP
-#PREMATTER: doc_def mod_packages mod_head
+#PREMATTER:\ doc_def\ mod_packages\ mod_head
 add the document type definition, and stuff added by modules
 .TP
-#PREMATTER: head_beg..prematter_end
+#PREMATTER:\ head_beg..prematter_end
 add everything from the head on downwards
 .PP
 A slot cannot be consumed twice. I.e., if you use several template commands, the latter will not insert the content that was already inserted by the previous command.