DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:commentsyntax

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:commentsyntax [2016-01-18 12:51] – new release, german language support s.saharaplugin:commentsyntax [2022-01-01 02:08] (current) – update version date s-sahara
Line 3: Line 3:
 ---- plugin ---- ---- plugin ----
 description: Allow to use source comment syntax to leave edit instructions of the page. Comments are visible only in the source view, not rendered as any page elements. description: Allow to use source comment syntax to leave edit instructions of the page. Comments are visible only in the source view, not rendered as any page elements.
-author     : S.Sahara +author     : Satoshi Sahara
 email      : sahara.satoshi@gmail.com  email      : sahara.satoshi@gmail.com 
 type       : syntax type       : syntax
-lastupdate : 2016-01-18 +lastupdate : 2022-01-01 
-compatible : Ponder Stibbons, Hrun, Detritus+compatible : Ponder Stibbons, Hrun, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo+
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : comment, commentsrc +similar    : comment, commentsrc, wrap 
-tags       : comment+tags       : annotations, hide, comment
  
 downloadurl: https://github.com/ssahara/dw-plugin-commentsyntax/zipball/master downloadurl: https://github.com/ssahara/dw-plugin-commentsyntax/zipball/master
Line 24: Line 24:
 ===== Installation ===== ===== Installation =====
  
-Install the plugin through the [[plugin:extension|Extension Manager]] or [[plugin:plugin|Plugin Manager]] using the download URL above, which points to latest version of the plugin. Refer to [[:plugin_installation_instructions|plugin installation instructions]].+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Feature ===== ===== Feature =====
Line 57: Line 57:
  
 ==== 2. one-line comment ==== ==== 2. one-line comment ====
-The "one-line" comment syntax will be available if the ''use_oneline_style'' option is enabled (default off). The use of //italic// formatting markup ''%%//...//%%'' restricted so that it can not go over next line.  +The "one-line" comment syntax will be available if the ''use_oneline_style'' option is enabled (default off).
 <file> <file>
   * non-ordered list item // comment    * non-ordered list item // comment 
Line 71: Line 71:
   - item 1   - item 1
   - item 3    - 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.  
 +<file>
 +This text //in italics. 
 +is rendered as normal // due to broken double-slash pairs
 +</file>
 +
 +This text is rendered as normal
  
 ==== 3. Control Macro like Comments ==== ==== 3. Control Macro like Comments ====
Line 78: Line 86:
  
  
 +==== 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 ===== ===== Configuration and Settings =====
Line 98: Line 110:
 |[[plugin:comment]]         | substition |special pattern |''%%^/\*.*?\*|\s+/\*.*?\*/%%'' | |[[plugin:comment]]         | substition |special pattern |''%%^/\*.*?\*|\s+/\*.*?\*/%%'' |
 |[[plugin:commentsrc]]      | substition |special pattern |''%%!-.*-!%%''  | |[[plugin:commentsrc]]      | substition |special pattern |''%%!-.*-!%%''  |
-|commentsyntax   | protected   |entry pattern   |''%%\s/\*(?=.*?\*/)%%''  |+|commentsyntax   | protected   |entry pattern   |''%%\t]*\n?/\*(?=.*?\*/)%%''  |
 | :::            | :::         |exit pattern    |''%%\*/%%''              | | :::            | :::         |exit pattern    |''%%\*/%%''              |
 | :::            | substition  |special pattern |''%%\s//(?:[^/\n]*|[^/\n]*/[^/\n]*)(?=\n)%%''  | | :::            | substition  |special pattern |''%%\s//(?:[^/\n]*|[^/\n]*/[^/\n]*)(?=\n)%%''  |
-| :::            | substition  |special pattern |''%%\B~~ [^\r\n]+?~~\B%%''  |+| :::            | substition  |special pattern |''%%~~[^\r\n]+?~~%%''  |
  
  
Line 110: Line 122:
 ===== Discussion ===== ===== Discussion =====
  
 +Is there plans to fix the current issues?
  
- +> Which issues? There are none listed here nor in the bug tracker. --- [[user>ach|Anika Henke]] //2016-07-31 15:42//
plugin/commentsyntax.1453117918.txt.gz · Last modified: 2016-01-18 12:51 by s.sahara

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki