Changes between Version 33 and Version 34 of MarkdownMacro

Timestamp:

May 30, 2021, 4:06:00 PM (3 years ago)

Author:

Cinc-th

Comment:

Documented Code Fence syntax for WikiProcessors. Some more general Description with feature list.

MarkdownMacro

@@ -5 +5 @@
 == Description
 
-This macro implements John Gruber's [http://daringfireball.net/projects/markdown/ Markdown] lightweight plain text-to-HTML formatting syntax as a [WikiProcessors wiki processor] macro.
+This macro implements John Gruber's [http://daringfireball.net/projects/markdown/ Markdown] lightweight plain text-to-HTML formatting syntax as a [WikiProcessors wiki processor] macro. It comes with Markdown extensions to better integrate with the Trac wiki.
+
+* Supports WikiProcessors in Markdown text.
+*  It's possible to use WikiMacros.
+* Supports TracLinks.
+* Syntax highlighting for source code if enabled in Trac.
+* Full support for inline HTML and [https://python-markdown.github.io/extensions/md_in_html/ Markdown in HTML].
+* Footnotes.
+* Tables.
 
 Example of its [#usage usage]:
@@ -208 +216 @@
 === Using !WikiProcessors
 
-**Note:** this is a Trac addition
+You may use WikiProcessors in your Markdown text by either
+* use [#Codefencesyntax Code fence] syntax
+* or use Trac WikiProcessors syntax
+
+When using `Code fence` syntax your text will better work with other Markdown editors because any !WikiProcessor content will be shown as preformatted text.
+
+==== Code fence syntax
+Use the Markdown code fence syntax like this:
+
+
+{{{
+```python
+def function():
+    foo = 1
+```
+}}}
+
+or with parameters:
+
+{{{
+```div style="border: 1px solid blue;"
+Some text in a blue box.
+```
+}}}
+
+Note that this ''may'' break presentation in other editors.
+
+Like with Tracs WikiProcessors the first line of the content may be used for parameters:
+{{{
+```
+#!div style="border: 1px solid blue;"
+Some text in a blue box.
+```
+}}}
+==== Trac !WikiProcessor syntax
+
+**Note:** this is a Trac only extension.
 
 WikiProcessors can be used without any special escape syntax. Just add the processor to the Markdown text.