deplate 0.8 → 0.8.1

data/NEWS.TXT

@@ -1,33 +1,50 @@
-* deplate 0.8
-
-This release contains many small changes and fixes. The main user-visible improvements are: better support for bibliographies, embedded elements in lists, task lists, a general style attribute, custom listings, hierarchical counters, load-time-expanded skeletons etc.
-
-    - Custom listings and hierarchical counters (toc, lof & lot are now implemented this way)
-    - Skeletons were introduced; skeletons are expanded at load-time before the document is parsed
-    - Improved support for bibliographies
-    - Improved lists:
-        - Enable nested/embedded elements in lists
-        - Some support for task lists
-    - Remove blacklisted LaTeX commands from input (unless allow=t is set)
-    - Support for a general style attribute (support for styled LaTeX and HTML output; not supported for DocBook output)
-    - Extended wiki names my include interwikis (e.g. [[WIKI::FooBar#a][Foo and Bar]])
-    - Slightly improved support for international characters in camel-case type wiki names
-    - More commands were made volatile (i.e. they don't close elements)
-    - Experimental hack for nukumi2 (v0.5)
-    - Support for jsMath
-    - A php hack was included to provide cheap/unsafe per-page user comments
-    - A javascript hack was included to provided step-by-step display of HTML pages
-    - Footnotes now contain block elements
-    - New commands: #PAGE, #DEFLIST, #REGISTER, #KEYWORDS, #NOP
-    - New regions: #Write
-    - New macros: counter, msg
-    - New variables: auxiliaryDir, mandatoryID, prefixID, bibStyle
-    - New services: outputFilename(), outputBasename()
-    - New classes: DeplateString convenience class
-    - New command line options: --list-modules, --list-css command
-
-NOTE: The way files are automatically numbered with multi-file output (e.g. when using the htmlsite formatter) has changed which may result in a different numbering under certain conditions.
+* deplate 0.8.1
+
+This release incorporates the usual set of bugfixes, some general improvements, and support for dvipng. The way how ARG/XARG commands/macros work has changed.
+
+Incompatible changes:
+    - deplate currently is slightly instable. This is related to a change of how ARG and XARG type of commands/macros work within #Def... regions, which are now passed through the template filter. In order to retain the old behaviour, set the legacyDefine1 variable.
+    - the locale-related modules were renamed to lang-* (in some cases underscores and dashes were transposed)
+    - most lists (e.g. css variable) are now comma-separated lists
+    - many regions (e.g. #For, #Def*) are first processed by the template filter before being actually expanded
+    - The use of @regNote (the part after the colon) will be deprecated in some future version; deplate currently displays a warning message that isn't always useful/correct and should currently be ignored in certain cases
+
+Improvements:
+    - dvipng support (by Lucas Wilcox)
+    - Preliminary support for writing plays (stage, screen).
+    - A whitespace line is a valid region delimiter.
+    - The {step} macro allows to stepwise highlight text on a HTML page, which could be useful for doing HTML-based presentations.
+    - #INCLUDE is much more versatile now.
+    - #Native now takes an optional template! argument so that the body gets processed by the template filter.
+    - The {cite} now knows a few extra arguments.
+    - The environment variables are accessible from within a deplate document through the env[] variable (a hash).
+    - ''$ClassName[property]'' variable to set properties for all elements of a certain class.
+    - Can filter elements or particles according to the ''tag'' property by setting the efilter and/or pfilter variables.
+    - The #INCLUDE command can set variables for the included document.
+    - A whitespace line can be a valid region delimiter
+
+New input format:
+    - play
+
+New output format:
+    - latex-dramatist
+
+New commands:
+    - #PUSH
+    - #PP, #PROP (synonyms for #OPT)
+
+New macros:
+    - mark1st, ~
+    - downcase, upcase, capitalize
+    - eprop
+
+New modules:
+    - code-gvim71
+    - guesslanguage (guess the input document's language)
+    - html-highstep (''step'' macro)
+    - linkmap (Jeff Barczewski): markdown-like hyperlinks
 
 For other changes please see the CHANGES.TXT.
 
-% vi: ft=text:tw=0:ts=4
+
+% vi: ft=viki:tw=0:ts=4

data/README.TXT

@@ -17,7 +17,6 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  
 USA
 
----
 
 = Install
 

data/TODO.TXT

@@ -1,17 +1,51 @@
 * Problems & issues
+    #A1 _ Generation of the win32 executable is currently broken (I don't have 
+      the time to adapt the exr file for the current version of exerb)
+    #A1 _ arg vs xarg: definition, switch them?
+    #A1 _ parse error: {cite n=aus\: p=11: kaiser83}
+        !!! n="aus:" should work though
+    #A2 _ Wrong line numbers in the log for regions defined with 
+      ''#DefRegion'' etc.
     #A2 _ ''[[#textpipe][TextPipe]]'' generates wrong link when splitting 
       output (''[[integration#textpipe][TextPipe]]'' is okay though)
+    #A3 _ LaTeX output for task lists that are embedded in lists throws an 
+      error: ''! LaTeX Error: Too deeply nested.''
+        - This is most likely a proplem with deplate per se but deplate should 
+          at least display a warning or similar.
     #A4 _ Find a way to respect whitespace at the beginning of a macro's 
       argument, e.g.
         - ''{text: \ bla}'' -> currently generates a non-breakable space
         - ''{text exact!: bla}''
         - ''{text:: bla}''
+        - ''{text @body=" bla"}'' (this one would integrate well with the 
+          existing basis)
+    #A4 All regions & macros should take a template argument that makes the 
+      body be passed through the template filter.
+    #A4 For whatever reason there has to be a blank line in the following 
+      example; also, it's annoying having to escape #COMMENTS which shouldn't 
+      be necessary as the command isn't allowed in templates anyway:
+      #Verb <<---------
+        #DefRegion id=Slide <<--
+        * {xarg: title}
+        \#OPT: id={xarg: id}
+        \#COMMENTS: {xarg: n}
 
+        #XARG: @body
+        --
+      ---------
+        !!! I'm not sure if this wasn't already solved by making #XARG 
+            non-volatile.
+    #A4 When passing a block on initialization of deplate/converter, newly 
+      listed modules in options.modules should be automatically loaded.
+
+    #A5 _ Interviki names defined as format strings
+    #A5 _ parbox macro (latex)
+        - or rather an inline macro that takes a clip or the contents of a 
+          variable and formats it as (inline) particle (ie wrap it up in a 
+          parbox, div ...)
     #A5 _ #INC: look in the directory of the input file first
     #A7 _ Wrong numbering when defining a heading as an example's title 
       (level_as_string gets lost somehow or is not updated right in time)
-    #A7 _ Latin-1 umlauts are sometimes translated to utf-8, when including a  
-      document-- I have no idea what is causing this
     #A9 _ Duplicate anchors
         - Regions.html: - r_geyser	914, 917
             - dot_example	906, 909
@@ -24,6 +58,14 @@
       to "plain"; running numbers are also used in auto-generated labels which 
       is wrong.
 
+    #B1 _ New Command #PARAM, #PN (or something like that), that works like 
+      \#PP but on the following elements. It should actually define a list of 
+      properties that are automatically tagged on following elements right 
+      when processing the input.
+        !!! This can currently be done by setting $ElementName[VAR]=VALUE.
+    #B1 _ Support for output via latex-screenplay
+    #B1 _ Enable filtering of dialog lines according to speaker
+    #B1 _ Enable filtering of scenes according to characters and place
     #B1 _ Disable #Native in templates (why/when was it enabled?)
     #B1 _ Handling of multi-file output is still a mess
     #B1 _ Check for potential code injection (when using eval & 
@@ -32,7 +74,7 @@
         - places where user input finds its way into the output
             navbar-png.rb :: variables['buttonsColour'], 
               variables['buttonsFileFormat']
-        - this calls for a general validation framework, I'd say
+        - this calls for a general validation framework for variables, I'd say
     #B3 _ All File.open & File.exists should be replaced with wrapper 
       functions; depending on some allow flags these functions should restrict 
       access to:
@@ -49,9 +91,21 @@
         - this should probably be renamed to something like template 
           function/helper and restricted to templates
 
+    #C2 _ The arguments need different rules
+        - Good
+            - foo=1 bar="bla bla" x=(1 2 3) z=[1; 3; 4]
+            - foo! bar=true var=false x=\true y="true"
+            - var=bla\ bla y="[1 2 3]"
+        - Bad
+            - foo=bar=1 bar=bla bla x=y!z
     #C2 _ Do we still need @dest? @dest vs. @options.out vs.  
       @output.destination: One should be enough.
     #C4 _ Skeletons vs. services vs. #INC: this is kind of redundant
+    #C5 _ Microformats http://microformats.org/wiki/Main_Page
+        - Use index for <a rel="tag"></a> http://microformats.org/wiki/rel-tag
+        - rel="license"
+        - rel="friend" http://www.gmpg.org/xfn/
+        - Task lists -> http://microformats.org/wiki/hcalendar
     #C5 _ Currently, deplate converts a document in three steps; this is wrong 
       because it introduces too much complexity just to avoid running deplate 
       three times � la LaTeX; there should be only one step and the 
@@ -63,18 +117,24 @@
           certain threshold was surpassed (can't converge error).
     #C7 _ Improved support for symbols: input vs. output encoding
     #C7 _ Symbols & locales: The conversion table should be contained in the 
-      DATA section, not in some extra file
+      source file's DATA section, not in some extra file
+    #C7 _ Guesslanguage: Temporarily switch languages
+    #C7 _ citations: allow something like {cite: author#page}
     #C8 _ lists: don't tranform list items to structs but accumulate the items 
       right away
     #C9 _ HTML: use entities for special characters (e.g. &uuml; instead of 
       �) -- the problem with this currently is, that we have to know the input 
       encoding in order to compile a conversion list; an alternative approach 
       would be to convert everything to utf8 internally but this whould rely 
-      on iconv which is not available on all platforms (at least not in the 
+      on iconv which is not available on all platforms (at least not with the 
       default ruby installation)
 
+    #E2 _ guesslanguage: Use best guess for most of the input document.
+    #E2 _ Output themes (style + template): (1) collect files in directories 
+    or (2) define theme in a metafile that refers to the styles and templates 
+    to be used.
     #E3 _ #Math region (similar to \{math\} macro but at the block/element 
-      level)
+    level)
     #E4 _ {var} ~~ {arg: var} || {get: var}
     #E4 _ {val:} vs. {var:} vs. {arg:} vs. {xarg:} vs. {get:} vs. {opt:}
     #E4 _ variables vs. clips
@@ -82,26 +142,31 @@
     #E4 _ {cite an!: xxx} -> X & Y~(2000)
     #E4 _ citation styles
             - numbered � la uniform medical submission requirements ...
-            - implementations: prefixed (=style) methdos:
+            - implementations: prefixed (=style) methods:
                 - eg: apa_cite
                     - if ''STYLE_method'' doesn't exist -> Fallback: 
-                      ''default_method'' or simply ''method''?
+                    ''default_method'' or simply ''method''?
     #E4 _ #MAKEBIB -> #LIST: bib
     #E4 _ #Style -> Mark text in region with style attribute
 
     #F3 _ chaining formatter; reimplement the way particles are formatted
     #F5 _ check how inlatex-compound can be made more robust (and make it the 
-      default for dealing with inline latex bits)
+    default for dealing with inline latex bits)
     #F9 _ Regions should be handled differently so that nested regions can use 
-      \#End.
+    \#End -- or completely remove this alternative markup for regions.
 
 ** Docbook
+    #A1 _ Author names like "{foo bar}" are parsed and formatted first and 
+      rearranged later on. As a consequence, Deplate complains about unknown 
+      macros. The solution would be to have a simplified latex input filter. 
+      In the meanwhile, we disable macros when parsing the text.
     #A _ deplate complains about a malformed list (toc, lot, lof?) or internal 
       error when compiling the manual
     #C _ docbook support for styles (e.g. for task lists) (well, how? role?)
     #D _ docbook support for custom lists
 
 ** HTML
+    #A _ Make the tabbar use ul/li tags instead of a table.
     #A _ If an indexed word is moved to a list (#LIST), then the index points 
       to the wrong position.
     #B _ The #AUTOIDX command should not create an index entry for itself. 
@@ -111,7 +176,8 @@
 ** LaTeX
 
 ** PHP
-    #B _ Propagate the get arguments -> Base url should be a format string.
+    #B _ Make internal wiki links propagate the get arguments -> Base url 
+      should be a format string.
 
 ** Plain text
 
@@ -122,10 +188,10 @@
     #C _ define how convert_string should work when invoked repeatedly (with 
       respect to #IDX, #ABBREV, ...)
     #F _ custom names for labels/refs (html output)
-            - or use extended wiki names instead
+        - or use extended wiki names instead
     #F _ relative/absolute file names & urls in the \{img\} and #IMG: define 
       proper behaviour
-            - general solution or formatter specific (as it is now)?
+        - general solution or formatter specific (as it is now)?
 
 
 ** Tests for ...
@@ -135,20 +201,27 @@
 
 * TODO
 ** 0.09
-    - test output to sciposter (or similar) for LaTeX output
+    - Metadata-related stuff should be re-implemented (and made more useful)
+    - Two/n-pass single-step redesign (there really is no use in implementing 
+      more features before this was done)
+    - Prepare the Deplate::Input for non-line-based format like latex.
     - define a way to create a slot from within a deplate document
+    - basic support for:
+        - textile input
+        - markdown input
+        - wikipedia input
+    - TEI output
+    - sciposter output (or similar)
     - \FreeMind output
     - \OpenDocument or RTF output (if rtf.rb can be used for this)
     - Method/attribute naming: indentation vs. level (heading)
-    - Metadata-related stuff should be re-implemented (and made more useful)
-    - Two-pass single-step redesign
     - citation & bibliography styles
     - the output stuff has to be managed by the formatter class alone
     - HTML: make indexed words be hyperlinked to the index (~~tag cloud)
     - HTML: bib entries should have backlinks to where an author was cited
     - PHP: mysql backend for the comment facility (per page, element)
 
-** 0.10
+** 0.??
     - unify region & command & anchor
         - unify region & command
         - if it isn't a region/command, check if it could be an anchor
@@ -265,11 +338,11 @@
     - markdown
     - textile
     - xml
-        - \FreeMind
+        - FreeMind
 
 ** Out
-    - \OpenDocument
-    - \FreeMind
+    - OpenDocument
+    - FreeMind
     - direct pdf output via the pdf-writer library
     - rtf formatter (only if it can be done better than docbook+jade does and 
       if it is easier to implement than an \OpenDocument formatter)

data/VERSION.TXT

@@ -1 +1 @@
-0.8final-2711
+0.8.1final-2965

data/bin/deplate.exy

@@ -0,0 +1,192 @@
+# Generated by mkexy
+# on 2007-07-16 18:52
+
+general:
+  startup: bin/deplate
+  core: cui
+  kcode: none
+
+file:
+  bin/deplate:
+  rbconfig.rb:
+    file: /usr/lib/ruby/1.8/i386-cygwin/rbconfig.rb
+  rubygems/rubygems_version.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/rubygems_version.rb
+  thread.rb:
+    file: /usr/lib/ruby/1.8/thread.rb
+  rbconfig/datadir.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rbconfig/datadir.rb
+  rubygems/user_interaction.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/user_interaction.rb
+  socket.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/socket.so
+    type: extension-library
+  timeout.rb:
+    file: /usr/lib/ruby/1.8/timeout.rb
+  net/protocol.rb:
+    file: /usr/lib/ruby/1.8/net/protocol.rb
+  uri/common.rb:
+    file: /usr/lib/ruby/1.8/uri/common.rb
+  uri/generic.rb:
+    file: /usr/lib/ruby/1.8/uri/generic.rb
+  uri/ftp.rb:
+    file: /usr/lib/ruby/1.8/uri/ftp.rb
+  uri/http.rb:
+    file: /usr/lib/ruby/1.8/uri/http.rb
+  uri/https.rb:
+    file: /usr/lib/ruby/1.8/uri/https.rb
+  uri/ldap.rb:
+    file: /usr/lib/ruby/1.8/uri/ldap.rb
+  uri/mailto.rb:
+    file: /usr/lib/ruby/1.8/uri/mailto.rb
+  uri.rb:
+    file: /usr/lib/ruby/1.8/uri.rb
+  net/http.rb:
+    file: /usr/lib/ruby/1.8/net/http.rb
+  stringio.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/stringio.so
+    type: extension-library
+  yaml/error.rb:
+    file: /usr/lib/ruby/1.8/yaml/error.rb
+  syck.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/syck.so
+    type: extension-library
+  yaml/ypath.rb:
+    file: /usr/lib/ruby/1.8/yaml/ypath.rb
+  yaml/basenode.rb:
+    file: /usr/lib/ruby/1.8/yaml/basenode.rb
+  yaml/syck.rb:
+    file: /usr/lib/ruby/1.8/yaml/syck.rb
+  yaml/tag.rb:
+    file: /usr/lib/ruby/1.8/yaml/tag.rb
+  yaml/stream.rb:
+    file: /usr/lib/ruby/1.8/yaml/stream.rb
+  yaml/constants.rb:
+    file: /usr/lib/ruby/1.8/yaml/constants.rb
+  rational.rb:
+    file: /usr/lib/ruby/1.8/rational.rb
+  date/format.rb:
+    file: /usr/lib/ruby/1.8/date/format.rb
+  date.rb:
+    file: /usr/lib/ruby/1.8/date.rb
+  yaml/rubytypes.rb:
+    file: /usr/lib/ruby/1.8/yaml/rubytypes.rb
+  yaml/types.rb:
+    file: /usr/lib/ruby/1.8/yaml/types.rb
+  yaml.rb:
+    file: /usr/lib/ruby/1.8/yaml.rb
+  zlib.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/zlib.so
+    type: extension-library
+  rubygems/remote_fetcher.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/remote_fetcher.rb
+  digest.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/digest.so
+    type: extension-library
+  digest/sha2.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/digest/sha2.so
+    type: extension-library
+  rubygems/digest/digest_adapter.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/digest/digest_adapter.rb
+  rubygems/digest/sha2.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/digest/sha2.rb
+  forwardable.rb:
+    file: /usr/lib/ruby/1.8/forwardable.rb
+  parsedate.rb:
+    file: /usr/lib/ruby/1.8/parsedate.rb
+  time.rb:
+    file: /usr/lib/ruby/1.8/time.rb
+  rubygems/source_index.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/source_index.rb
+  rubygems/version.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/version.rb
+  rubygems/specification.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/specification.rb
+  openssl.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/openssl.so
+    type: extension-library
+  openssl/bn.rb:
+    file: /usr/lib/ruby/1.8/openssl/bn.rb
+  openssl/cipher.rb:
+    file: /usr/lib/ruby/1.8/openssl/cipher.rb
+  openssl/digest.rb:
+    file: /usr/lib/ruby/1.8/openssl/digest.rb
+  openssl/buffering.rb:
+    file: /usr/lib/ruby/1.8/openssl/buffering.rb
+  fcntl.so:
+    file: /usr/lib/ruby/1.8/i386-cygwin/fcntl.so
+    type: extension-library
+  openssl/ssl.rb:
+    file: /usr/lib/ruby/1.8/openssl/ssl.rb
+  openssl/x509.rb:
+    file: /usr/lib/ruby/1.8/openssl/x509.rb
+  openssl.rb:
+    file: /usr/lib/ruby/1.8/openssl.rb
+  rubygems/gem_openssl.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/gem_openssl.rb
+  rubygems/security.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/security.rb
+  rubygems/custom_require.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb
+  rubygems.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/rubygems.rb
+  ubygems.rb:
+    file: /usr/lib/ruby/site_ruby/1.8/ubygems.rb
+  optparse.rb:
+    file: /usr/lib/ruby/1.8/optparse.rb
+  ostruct.rb:
+    file: /usr/lib/ruby/1.8/ostruct.rb
+  ftools.rb:
+    file: /usr/lib/ruby/1.8/ftools.rb
+  pathname.rb:
+    file: /usr/lib/ruby/1.8/pathname.rb
+  deplate/core.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/core.rb
+  deplate/common.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/common.rb
+  deplate/input.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/input.rb
+  deplate/metadata.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/metadata.rb
+  deplate/output.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/output.rb
+  deplate/cache.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/cache.rb
+  deplate/variables.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/variables.rb
+  deplate/counters.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/counters.rb
+  deplate/etc.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/etc.rb
+  deplate/abstract-class.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/abstract-class.rb
+  deplate/elements.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/elements.rb
+  deplate/regions.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/regions.rb
+  deplate/commands.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/commands.rb
+  deplate/macros.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/macros.rb
+  deplate/particles.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/particles.rb
+  deplate/define.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/define.rb
+  deplate/formatter.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/formatter.rb
+  deplate/fmt/template.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/fmt/template.rb
+  deplate/template.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/template.rb
+  deplate/skeletons.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/skeletons.rb
+  deplate/bib.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/bib.rb
+  getopts.rb:
+    file: /usr/lib/ruby/1.8/getopts.rb
+  ps2ppm.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/ps2ppm.rb
+  deplate/external.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate/external.rb
+  deplate.rb:
+    file: /cygdrive/f/ext/Ruby/tml/deplate/lib/deplate.rb