Table of Contents
Comment Syntax Plugin
Compatible with DokuWiki
- 2023-04-04 "Jack Jackrum" probably
- 2022-07-31 "Igor" probably
- 2020-07-29 "Hogfather" probably
- 2018-04-22 "Greebo" yes
The Comment Syntax plugin brings a CSS-like comment syntax to your DokuWiki. The comment is not shown in the page, but visible when you edit the page.
Comments are used to explain your Wiki source text, and may help you when you edit it, especially which is using complex syntax markups, at some future. Comments are ignored when converting source text to html.
1. 'C' style comments
'C' style comments start with
/* and ends with
*/. The comment-start markup
/* must be placed at the start of line, or after a white-space letter. Comments can also span multiple lines:
/* This is a comment */
/* This is a multi-line comment */
The comment syntax mode has priority to list block mode. You may comment-out some list item without breaking the whole list structure.
- item 1 /* A white space is necessary before comment-start markup */ /*- item 2 will be eliminated from this list without breaking it */ - item 3 /* will be numbered as 2 in the list */
- item 1
- item 3
Note that 'C' style comments end at the first
*/ encountered. If you however wish that nested comments should be treated correctly, you can change the behavior through the configuration. In case the
use_cstyle_nest option is enabled (default off), the whole part enclosed in outmost pair of
*/ recognized as a comment:
/* There is an another comment /* in this comment */ (nested comment)*/
2. one-line comment
The “one-line” comment syntax will be available if the
use_oneline_style option is enabled (default off).
* non-ordered list item // comment
- non-ordered list item
- item 1 // A white space is necessary before One-line comment markup //- item 2 will be eliminated from this list without breaking it - item 3 // will be numbered as 2 in the list
- item 1
- item 3
Adverse effect: The one-line comment syntax
// may interfere with the markup for italics. The use of italic formatting markup
//...// will be restricted so that it can not go over next line.
This text //in italics. is rendered as normal // due to broken double-slash pairs
This text is rendered as normal
3. Control Macro like Comments
There are so-called control macros syntax, such as
~~NOCACHE~~. It may be convenient if you put a white space between
NOCACHE~~, it becomes a comment without displaying
~~ NOCACHE~~ in the page.
~~ This is a comment without affecting other macros in the page. ~~
4. HTML comment syntax
The HTML comment will not rendered by the browser, but can be viewed with “View source code” command.
<!-- This is a HTML comment -->
Configuration and Settings
Change Log from github repository
- Merge pull request #11 from e-dschungel/e-dschungel-email-patch (2023-04-13 12:34)
- remove "<" and ">" (2023-03-11 11:40)
- update version date (2022-01-01 01:58)
- use __CLASS__ instead of get_class() (2021-12-09 04:51)
- add unittest (2021-12-07 14:28)
Different syntax patterns of similar plugins
|plugin name||mode type||regular expressions|
Known Bugs and Issues
Is there plans to fix the current issues?
Which issues? There are none listed here nor in the bug tracker. — Anika Henke 2016-07-31 15:42