Changeset 37532 in project


Ignore:
Timestamp:
04/09/19 10:31:32 (18 months ago)
Author:
evhan
Message:

wiki/eggref/markdown-svnwiki: update version history

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/markdown-svnwiki

    r37406 r37532  
    1717markdown-svnwiki installs both a module and a command line utility. The command line utility is used as follows:
    1818
    19     usage: markdown-svnwiki [-h | --help]
    20                             [-o | --output-file NAME]
    21                             [-e | --extension EXTENSION]
    22                             [-t | --no-toc]
    23                             [file]
     19 usage: markdown-svnwiki [-h | --help]
     20                         [-o | --output-file NAME]
     21                         [-e | --extension EXTENSION]
     22                         [-t | --no-toc]
     23                         [file]
    2424
    2525Convert the given Markdown file to CHICKEN's svnwiki syntax. If no file is given, stdin is read. If neither the output-file or extension arguments are given, the result is written to stdout. If the output-file argument is provided, the resulting svnwiki file is written to a file of that name. If the extension argument is given, the svnwiki file uses the same name as the input file, with the given extension.
     
    2727
    2828=== Documentation
    29 <procedure> (markdown->svnwiki input)</procedure>
     29<procedure>(markdown->svnwiki input)</procedure>
    3030
    3131Convert the given {{input}} (may be a string or a port) into svnwiki, outputting to {{current-output-port}}.
    3232
    33 <parameter> pre-processing</parameter>
     33<parameter>pre-processing</parameter>
    3434
    3535An alist of functions that accept a string (the input to {{markdown->svnwiki}}) and should transform it in some way. By default contains one entry: {{code-blocks}}, for dealing with code blocks as described in Special Syntax.
    3636
    37 <parameter> post-processing</parameter>
     37<parameter>post-processing</parameter>
    3838
    3939An alist of functions that accept a string (the pre-post-processed output from {{markdown->svnwiki}}) and should transform it in some way. By default contains: {{code-blocks}}, {{procedure}}, {{macro}}, {{read}}, {{parameter}}, {{record}}, {{string}}, {{class}}, {{method}}, {{constant}}, {{setter}}, {{syntax}}, and {{type}}, for dealing with code blocks and definition tags as described in Special Syntax.
    4040
    41 <parameter> toc</parameter>
     41<parameter>toc</parameter>
    4242
    4343If true, inserts {{[[toc:]]}} after the first-level heading(s). Defaults to {{#t}}.
     
    4747markdown-svnwiki supports the syntax highlighted code blocks that [[help.github.com/articles/github-flavored-markdown#syntax-highlighting|GitHub]], [[http://johnmacfarlane.net/pandoc/README.html#fenced-code-blocks|Pandoc]] and perhaps others support. It converts these blocks into the {{<enscript>}} tags that highlight with the given language. It does this using a pre and post-processing step, both named {{code-blocks}}. These code blocks take the following form:
    4848
    49     ``` Scheme
    50     code ...
    51     ```
     49 ``` Scheme
     50 code ...
     51 ```
    5252
    5353Becomes:
    5454
    55     <enscript highlight="scheme">
    56     code ...
    57     </enscript>
     55 <enscript highlight="scheme">
     56 code ...
     57 </enscript>
    5858
    5959Additionally, markdown-svnwiki supports a special syntax for adding the [[https://wiki.call-cc.org/edit-help#extensions-for-chicken-documentation|definition tags]] supported by the Chicken wiki. Single-line verbatim code blocks that begin with exactly four spaces followed by {{[definition-type]}} are given a {{<definition-type>}} tag. Only the tags supported by the Chicken wiki are supported. For example:
    6060
    61         [procedure] (my-proc ...)
     61     [procedure] (my-proc ...)
    6262
    6363Becomes:
    6464
    65     <procedure>(my-proc ...)</procedure>
     65 <procedure>(my-proc ...)</procedure>
    6666
    6767
     
    6969This example can be compiled to make a command line program that accepts one argument - a Markdown file - and outputs a svnwiki file into the same directory. It shows the addition of of a pre-processing step - one that removes the first section called "Installation" (fairly indiscriminately, it stops at the first {{#}}).
    7070
    71 <enscript highlight="scheme">    
     71<enscript highlight="scheme">
    7272(import
    7373  scheme
     
    9797
    9898=== Version history
     99
     100==== Version 0.3.1
     1017 April 2019
     102
     103* Fix error on empty input
     104* Remove unnecessary whitespace from tags and code blocks
     105
    99106
    100107==== Version 0.3.0
Note: See TracChangeset for help on using the changeset viewer.