Changes between Version 34 and Version 35 of MarkdownMacro


Ignore:
Timestamp:
May 30, 2021, 9:45:37 PM (3 years ago)
Author:
Cinc-th
Comment:

Documented configuration and how to use Markdown as the default wiki language

Legend:

Unmodified
Added
Removed
Modified

  • MarkdownMacro

    v34 v35  
    1414* Footnotes.
    1515* Tables.
     16* Markdown as [#MarkdownasWikiLanguage default wiki language].
    1617
    1718Example of its [#usage usage]:
    … …  
    8182General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
    8283
    83 Enable the macro in your `trac.ini` file:
    84 {{{#!ini
    85 [components]
    86 tracmarkdown.macro.markdownformatter = disabled
    87 tracmarkdown.macro.markdownmacro = enabled
    88 }}}
    89 
    90 If you want to use markdown without
    91 wrapping the text in a [WikiProcessors WikiProcessor]:
     84Enable the macro and the wiki page formatter in your `trac.ini` file. This can also be done using the plugin admin page.
    9285{{{#!ini
    9386[components]
    9487tracmarkdown.macro.markdownformatter = enabled
    95 tracmarkdown.macro.markdownmacro = disabled
    96 }}}
    97 
    98 The `markdownformatter` and `markdownmacro` components are mutually
    99 exclusive and should not be both enabled.
     88tracmarkdown.macro.markdownmacro = enabled
     89}}}
     90
     91== Configuration
     92
     93The following may be set in `trac.ini`.
     94
     95{{{#!ini
     96[markdown]
     97root_pages = Docs, Note
     98tab_length = 4
     99}}}
     100
     101{{{#!tr
     102{{{#!td
     103`root_pages`
     104}}}
     105{{{#!td
     106List of wiki page names to be used as root pages for a page hierarchy. Wiki subpages of these roots will use Markdown as the default wiki language.[[BR]][[BR]]For example if the list contains `Docs, Note` the wiki pages `Docs/MyDocument` and `Note/FirstNote` will use Markdown; the wiki page `NoteOne` will use Trac WikiFormatting.
     107
     108Example:
     109{{{#!ini
     110[markdown]
     111root_pages = Docs, Note
     112}}}
     113**Note:** page names are case sensitive.
     114}}}
     115{{{#!td
     116(no default)
     117}}}
     118}}}
     119{{{#!tr
     120{{{#!td
     121`tab_length`   
     122}}}
     123{{{#!td
     124Specify the length of tabs in the markdown source. This affects the display of multiple paragraphs in list items, including sub-lists, blockquotes, code blocks, etc.
     125}}}
     126{{{#!td
     1274
     128}}}
     129}}}
    100130
    101131== Usage
    … …  
    276306=== Using !WikiMacros
    277307
    278 **Note:** this is a Trac addition
     308**Note:** this is a Trac extension
    279309
    280310Tracs WikiMacros can be used like with normal Trac wiki syntax.
    … …  
    290320}}}
    291321}}}
     322
     323== Markdown as Wiki Language
     324
     325You may specify a list of wiki page names to be used as !root pages for a page hierarchy. Wiki subpages of these roots will use Markdown as the default wiki language.
     326
     327For example if the list contains `Docs, Note` the wiki pages `Docs/MyDocument` and `Note/FirstNote` will use Markdown; the wiki page `NoteOne` will use Trac WikiFormatting.
     328
     329Example:
     330{{{#!ini
     331[markdown]
     332root_pages = Docs, Note
     333}}}
     334
     335**Note:** page names are case sensitive.
    292336
    293337== Recent Changes