deplate 0.8 → 0.8.1

data/etc/deplate.ini

@@ -73,10 +73,17 @@
 
 ;    codeSyntax :: The default syntax for #Code regions (STRING)
 
+;    commentsShow :: Display comments in the output (BOOLEAN = any comment 
+;       or STRING = comments with this prefix/marker)
+
 ;    description :: A short description of the document (STRING)
 
 ;    docBasename :: The base name of the output document (STRING)
 
+;    efilter :: Include only elements in the output that are tagged with 
+;       one of these tags. ''any'' matched untagged elements. 
+;       (COMMA-SEPARATED LIST)
+
 ;    elementStyle :: If set to 'block', the markup of styles changes. For 
 ;       LaTeX output, this make ''deplate'' use regions. You can set this 
 ;       for single elements too. (STRING)
@@ -91,6 +98,10 @@
 ;       HTML  :: ISO-8859-1
 ;       LaTeX :: latin1
 ;       XML   :: UTF-8
+;       - In order to set the encoding do:
+;           ''#VAR: encoding=utf-8''
+;       - To set the encoding for HTML output only:
+;           ''#VAR fmt=html: encoding=utf-8''
 
 ;    figureNumbering :: How figures should be numbered (STRING)
 ;       flat, document :: One counter for all figures
@@ -117,6 +128,8 @@
 
 ;    imgSfx :: The default suffix for images (STRING, default: png)
 
+;    includeVars :: The variables to be used for #INC commands (HASH)
+
 ;    indexwiki :: If "no", don't autoindex extended wiki links (STRING)
 ;       - <+TBD+>This will be subject of change
 
@@ -126,6 +139,9 @@
 ;    inlatexHeight, inlineLatexHeight :: Define the ''h'' parameter of 
 ;       images generated by an inline LaTeX snippet (NUMBER)
 
+;    itemizeMarkers :: The markers for itemize lists (currently only 
+;       used for plain text output) (COMMA-SEPARATED LIST)
+
 ;    ltxPointsize :: The pointsize used for LaTeX snippets; this can be  
 ;       overridden by a per-element 'pointsize' argument; see also 
 ;       [[#ps2imgRes][ps2imgRes]] (NUMBER, default: 10)
@@ -134,7 +150,7 @@
 ;       (STRING, default: dependent on the output format)
 
 ;    keywords :: The keyword to categorize the document; either an array 
-;       of strings or a list separated by [,;]
+;       of strings or a list separated by semi-colons
 
 ;    levelshift :: Shift heading levels (NUMBER)
 
@@ -144,6 +160,9 @@
 ;    mandatoryID :: If set, elements that create auxiliary files must 
 ;       have an ID (BOOLEAN)
 
+;    mark1stStyle :: If set, use the style to markup the ''mark1st'' 
+;        macro (STRING)
+
 ;    mathPrelude :: Like ''inlatexPrelude'' but used for the ''math'' 
 ;       macro only
 
@@ -156,6 +175,10 @@
 ;    pdfOutput :: Automatically set when using pdf output (the ''--pdf'' 
 ;       command line switch) (BOOLEAN)
 
+;    pfilter :: Include only particles in the output that are tagged 
+;       with one of these tags. ''any'' matched untagged particles. 
+;       (COMMA-SEPARATED LIST)
+
 ;    prefixID :: Prefix autogenerated names for auxiliary files with 
 ;       this string; if not defined, use the current document's base 
 ;       name (STRING)
@@ -175,6 +198,9 @@
 ;       using multi-file output and when redirecting the output to 
 ;       STDOUT (STRING)
 
+;    styledTags :: If set, tags will automatically style an element with 
+;       style "TAG#\{tagname\}" (BOOLEAN)
+
 ;    suffix :: The suffix to be used when guessing target names 
 ;       referenced by wiki names (STRING)
 ;       - <+TBD+>This will be subject of change
@@ -189,11 +215,16 @@
 ;    tabwidth :: The tab width used when expanding whitespace (NUMBER, 
 ;       default: 4)
 
+;    tag :: Tag all elements with these tags (COMMA-SEPARATED LIST)
+
 ;    template :: The default template for the output (STRING)
 
 ;    template_version :: Which template engine to use (NUMBER, 
 ;       default: 2)
 
+;    useParentSuffix :: When referring to other files, use the source 
+;       file's suffix as fallback strategy (BOOL, default; false)
+
 ;    verbatimMargin :: Wrap verbatim regions at this width (NUMBER)
 
 
@@ -207,12 +238,15 @@
 
 ;    bodyOptions :: The arguments passed to the ''body'' tag (STRING)
 
-;    css :: The document's CSS file(s) (LIST separated by whitespace)
+;    css :: The document's CSS file(s) (COMMA-SEPARATED LIST)
 ;       - The output media can be defined in the form: CSS|MEDIA
 
 ;    cssExtra :: Some extra text to be inserted at css position 
 ;       (STRING or ARRAY OF STRINGS)
 
+;    cssInclude :: Include the contents of the CSS file in the HTML output 
+;       (BOOLEAN)
+
 ;    docNavbar :: If true, display a navigation bar (BOOLEAN)
 
 ;    explorerHack :: Code to deal with browser-specific stuff; inserted 
@@ -230,6 +264,15 @@
 ;    metaDataExtra :: Other HTML code to be inserted 
 ;       at head position (STRING or ARRAY OF STRINGS)
 
+;    newsFeed :: An array of strings defining news feeds for the current
+;       site. (STRING or ARRAY OF STRINGS)
+;       - Entry format (please enclose the arguments in quotations marks):
+;           - ''rss="URL" title="Title"''
+;           - ''atom="URL" title="Title"''
+;           - ''href="URL" title="Title"'' (defaults to ''rss'')
+;           - ''type=rss href="URL" title="Title"''
+;           - ''type=atom href="URL" title="Title"''
+
 ;    nextButton :: The "next" button in the navigation bar 
 ;       (STRING, default: >>)
 
@@ -268,10 +311,11 @@
 ;       1){lab: stepwiseBegin}
 
 ;    stepwiseContinous :: Automatically move to the next page if all elements 
-;       are displayed (BOOLEAN, default: false)
+;       are displayed. If the value is ''confirm'' the user will be 
+;       queried before moving to the next page. (MIXED, default: false)
 
 ;    stepwiseKey :: Key code for revealing the next element (COMMA-SEPARATED 
-;       LIST; default: 78 = 'n'){lab: stepwiseKey}
+;       LIST; default: 34 = '\PageDn'){lab: stepwiseKey}
 
 ;    styleExtra :: Some extra CSS information that will be wrapped in a 
 ;       style tag (STRING or ARRAY OF STRINGS)
@@ -302,13 +346,19 @@
 
 
 ; **** LaTeX
-;    classOptions :: Options passed on to the document class (LIST 
-;       separated by whitespace or comma)
+;    bookClass :: Classes that use a ''\\chapter{}'' command
+;       (COMMA-SEPARATED LIST or BOOLEAN)
 
-;    DIV (koma) :: If set, use KOMA script's typearea package; use this  
+;    classOptions :: Options passed on to the document class 
+;       (COMMA-SEPARATED LIST)
+
+;    typeareaDIV, DIV (koma) :: If set, use KOMA script's typearea package; use this  
 ;       variable to define the proportion of the printed area on a page;  
 ;       see the KOMA script manual for details (NUMBER)
 
+;    typeareaDIV_, DIV_ (koma) :: Same as the above but the parameter is 
+;       set as a document class option.
+
 ;    floatHere :: If true, add a ''h'' flag to floats (BOOLEAN, 
 ;       default: false)
 
@@ -355,7 +405,7 @@
 ;    anyword_catalog :: A catalog file containing automatically linked 
 ;       words (STRING)
 
-;    anyword_list :: A comma separated list of automatically linked 
+;    anyword_list :: A comma-separated list of automatically linked 
 ;       words (STRING)
 
 ;    anyword_pattern :: A glob pattern for file names in the current 
@@ -398,6 +448,9 @@
 ;    urlIcon :: The file name of the external URL icon (STRING, 
 ;       default: url.png)
 
+;    markerInFrontOfURL :: Put the icon in front of the URL (BOOLEAN, 
+;       default: false)
+
 
 ; **** navbar-png
 ;    buttonsColour :: The subtype of the button images
@@ -435,7 +488,7 @@
 
 
 ; **** XMLRPC
-;    xmlrpcAllow :: A whitespace separated list of valid IP addresses of 
+;    xmlrpcAllow :: A comma-separated list of valid IP addresses of 
 ;       regular expressions matching valid addresses
 
 ;    xmlrpcPath :: The path for accessing this xmlrpc server (STRING, 
@@ -447,3 +500,11 @@
 ;       requests were part of one big document (BOOLEAN, default: nil)
 
 
+; *** Legacy
+;    legacyDefine1 :: Make #Define type of regions behave as in 
+;       version up to 0.8 (alternatively, you can pass a noTemplate! 
+;       argument to the region)
+
+; legacyFor1 :: Make #For behave as in version up to 0.8 (alternatively, 
+;       you can pass a noTemplate! argument to the region)
+

data/lib/action_view/helpers/deplate.rb

@@ -1,45 +1,45 @@
 # deplate.rb -- support for ActionPack's action_view
-# @Author:      Thomas Link (samul AT web de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     13-Apr-2006.
-# @Last Change: 14-Apr-2006.
-# @Revision:    0.12
+# @Last Change: 2007-07-07.
+# @Revision:    0.16
 
 module ActionView
-  module Helpers #:nodoc:
-    module TextHelper
-      begin
-        require_library_or_gem 'deplate/deplate-string'
-        unless defined?(DEPLATE_AUXBASEURL)
-            DEPLATE_AUXBASEURL = 'http://localhost:2500/'
-        end
-        o = DeplateString.deplate_options
-        o.input_def = 'deplate-restricted'
-        o.variables['headings']   = 'plain'
-        o.variables['htmlAuxUrl'] = [DEPLATE_AUXBASEURL, 'files/%s'].join
+    module Helpers #:nodoc:
+        module TextHelper
+            begin
+                require_library_or_gem 'deplate/deplate-string'
+                unless defined?(DEPLATE_AUXBASEURL)
+                    DEPLATE_AUXBASEURL = 'http://localhost:2500/'
+                end
+                o = DeplateString.deplate_options
+                o.input_def = 'deplate-restricted'
+                o.variables['headings']   = 'plain'
+                o.variables['htmlAuxUrl'] = [DEPLATE_AUXBASEURL, 'files/%s'].join
 
-        # Returns the text with all the deplate/viki codes turned into HTML-tags.
-        # <i>This method is only available if deplate/deplate-string can be required</i>.
-        def deplate(text, page_name=nil)
-          if text.blank?
+                # Returns the text with all the deplate/viki codes turned into HTML-tags.
+                # <i>This method is only available if deplate/deplate-string can be required</i>.
+                def deplate(text, page_name=nil)
+                    if text.blank?
             ''
-          else
-            out = DeplateString.new(text)
-            if page_name
-                pn = page_name.gsub(/[^a-zA-Z0-9_]/, '_')
-                out.variables['auxiliaryDir'] = 'public/files/%s' % pn
-                out.variables['mandatoryID']  = false
-            else
-                out.variables['auxiliaryDir'] = 'public/files'
-                out.variables['mandatoryID']  = true
+                    else
+                        out = DeplateString.new(text)
+                        if page_name
+                            pn = page_name.gsub(/[^a-zA-Z0-9_]/, '_')
+                            out.deplate_options.variables['auxiliaryDir'] = 'public/files/%s' % pn
+                            out.deplate_options.variables['mandatoryID']  = false
+                        else
+                            out.deplate_options.variables['auxiliaryDir'] = 'public/files'
+                            out.deplate_options.variables['mandatoryID']  = true
+                        end
+                        out.to_html
+                    end
+                end
+            rescue LoadError
+                # We can't really help what's not there
             end
-            out.to_html
-          end
         end
-      rescue LoadError
-        # We can't really help what's not there
-      end
     end
-  end
 end
 

data/lib/deplate.rb

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 # deplate.rb -- Convert wiki-like plain text pseudo markup to something else
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     24-Feb-2004.
-# @Last Change: 28-Apr-2006.
+# @Last Change: 2007-04-14.
 
 require 'profile' if ARGV[0] == '--profile'
 

data/lib/deplate/bib.rb

@@ -1,9 +1,9 @@
 # bib.rb
-# @Author:      Thomas Link (samul AT web de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     11-Feb-2006.
-# @Last Change: 19-Feb-2006.
-# @Revision:    0.48
+# @Last Change: 2007-07-01.
+# @Revision:    0.85
 #
 # = Description
 # = Usage
@@ -37,7 +37,7 @@ class Deplate::Bib::Default < Deplate::CommonObject
     end
 
     def bib_format(bibdef)
-        type = bib_get_value(bibdef, '@type').downcase
+        type = bib_get_value(bibdef, '_type').downcase
         meth = "bib_#{type}"
         unless self.respond_to?(meth, true)
             meth = 'bib_default'
@@ -51,15 +51,17 @@ class Deplate::Bib::Default < Deplate::CommonObject
         args = invoker.args
         n    = args['n']
         p    = args['p']
-        np   = args['np']
+        ip   = args['ip']
+        np   = ip || args['np']
+        mode = args['mode']
         y    = args['y']
+        sep  = args['sep'] || (np ? '' : ' ')
         acc  = []
         pmsg = @deplate.msg('p.\\ ')
         for c in invoker.elt
             cc = @deplate.formatter.bib_entry(c)
             if cc
-                yr = cc.assoc('year')
-                yr = if yr then yr[1] else '' end
+                yr = cc['year'] || ''
                 if p
                     p = @deplate.parse_and_format_without_wikinames(container, "#{pmsg}#{p}")
                     yr += ": #{p}"
@@ -68,14 +70,21 @@ class Deplate::Bib::Default < Deplate::CommonObject
                 if y
                     acc << referenced_bib_entry(invoker, c, yr)
                 else
-                    nm = cc.assoc('author') || cc.assoc('editor') || cc.assoc('howpublished')
+                    nm = cc['author'] || cc['editor'] || cc['howpublished']
                     if nm
-                        nm = nm[1]
-                        nm = nm.gsub(/\s+/, ' ').split(' and ').collect do |a|
-                            a.scan(/\w+$/)
+                        if nm =~ /^\{(.*?)\}$/
+                            nm = $1
+                        else
+                            nm = nm.gsub(/\s+/, ' ').split(/ +and +/).collect do |a|
+                                a.scan(/\w+$/)
+                            end
+                            nm   = nm.join(', ')
+                        end
+                        if ip
+                            acc << referenced_bib_entry(invoker, c, "#{nm} (#{yr})")
+                        else
+                            acc << referenced_bib_entry(invoker, c, [nm, yr].join(' '))
                         end
-                        nm   = nm.join(', ')
-                        acc << referenced_bib_entry(invoker, c, [nm, yr].join(' '))
                     else
                         acc << referenced_bib_entry(invoker, c, c)
                     end
@@ -84,10 +93,16 @@ class Deplate::Bib::Default < Deplate::CommonObject
         end
         n &&= n + @deplate.formatter.plain_text(' ', true)
         acc = acc.join('; ')
+        sep = @deplate.formatter.plain_text(sep, true)
         if np
-            return %{#{@deplate.formatter.plain_text(' ', true)}#{n}#{acc}}
+            return %{#{sep}#{n}#{acc}}
         else
-            return %{#{@deplate.formatter.plain_text(' ', true)}(#{n}#{acc})}
+            case mode
+            when 'np'
+                return %{#{sep}#{n}#{acc}}
+            else
+                return %{#{sep}(#{n}#{acc})}
+            end
         end
     end
 
@@ -101,9 +116,8 @@ class Deplate::Bib::Default < Deplate::CommonObject
     end
     
     def bib_get_value(bibdef, key)
-        val = bibdef.assoc(key)
+        val = bibdef[key.downcase]
         if val
-            val = val[1]
             val.gsub(/\s{2,}/, ' ')
         end
     end
@@ -334,9 +348,17 @@ class Deplate::Bib::Default < Deplate::CommonObject
     # author title howpublished month year             
     def bib_misc(bibdef)
         author  = bib_author(bibdef)
+        how     = bib_howpublished(bibdef)
+        pub     = bib_publisher(bibdef)
+        if !author and how
+            author = how
+            how = nil
+        end
+        if !how and pub
+            how = pub
+        end
         year    = bib_year(bibdef)
         title   = bib_title(bibdef)
-        how     = bib_howpublished(bibdef)
         month   = bib_month(bibdef)
         address = bib_address(bibdef)
         url     = bib_url(bibdef)
@@ -529,29 +551,38 @@ class Deplate::Bib::Default < Deplate::CommonObject
 
     def reformat_authors(text)
         if text
-            namesep   = @deplate.variables['bibSepName'] || bibSepName
-            authorsep = @deplate.variables['bibSepAuthors'] || bibSepAuthors
-            twosep    = @deplate.variables['bibSepTwoAuthors'] || bibSepTwoAuthors
-            lastsep   = @deplate.variables['bibSepLastAuthor'] || bibSepLastAuthor
-            authors   = Deplate::Core.authors_split(text)
-            authorsn  = authors.size
-            authorsn1 = authors.size - 1
-            authorsn2 = authors.size - 2
-            au = []
-            authors.each_with_index do |a, i|
-                m = /^((.+?)?\s+)?(\S+)$/.match(a.strip)
-                if m[2]
-                    au << reformat_author_name(m[2], m[3], namesep)
-                else
-                    au << a
-                end
-                if i < authorsn2
-                    au << authorsep
-                elsif i < authorsn1
-                    au << (authorsn == 2 ? twosep : lastsep)
-                end
-            end
-            return au.join
+			if text =~ /^\{(.*?)\}$/
+				return $1
+			else
+				namesep   = @deplate.variables['bibSepName'] || bibSepName
+				authorsep = @deplate.variables['bibSepAuthors'] || bibSepAuthors
+				twosep    = @deplate.variables['bibSepTwoAuthors'] || bibSepTwoAuthors
+				lastsep   = @deplate.variables['bibSepLastAuthor'] || bibSepLastAuthor
+				authors   = Deplate::Core.authors_split(text)
+				authorsn  = authors.size
+				authorsn1 = authors.size - 1
+				authorsn2 = authors.size - 2
+				au = []
+				authors.each_with_index do |a, i|
+					m = /^(.+?)\s*,\s*(.+)$/.match(a.strip)
+                    if m
+                        au << reformat_author_name(m[2], m[1], namesep)
+                    else
+                        m = /^((.+?)?\s+)?(\S+)$/.match(a.strip)
+                        if m[2]
+                            au << reformat_author_name(m[2], m[3], namesep)
+                        else
+                            au << a
+                        end
+                        if i < authorsn2
+                            au << authorsep
+                        elsif i < authorsn1
+                            au << (authorsn == 2 ? twosep : lastsep)
+                        end
+                    end
+				end
+				return au.join
+			end
         end
     end