DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:codedoc

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:codedoc [2019-10-09 18:36] – [Support for Comments] Aleksandrplugin:codedoc [2022-08-13 04:40] (current) – [codedoc Plugin] turnermm
Line 7: Line 7:
 type       : syntax type       : syntax
 lastupdate : 2018-04-20 lastupdate : 2018-04-20
-compatible : lemming,anteater,rincewind,angua,adora belle,weatherwax,binky,"ponder stibbons"hrun,detritus,"Elenor Of Tsort",greebo+compatible : LemmingAnteaterRincewindAnguaAdora belle, WeatherwaxBinkyPonder stibbons, HrunDetritus, Elenor Of Tsort, Greebo, Hogfather,IgoR
 depends    :  depends    : 
 conflicts  conflicts 
Line 105: Line 105:
  
 This outputs the current user's name. This outputs the current user's name.
-  ~~codedoc:user~~ + 
 +  ~~codedoc:user~~
  
 The timestamp and the user name are independent of the codedoc container and can be placed anywhere in a document. The timestamp and the user name are independent of the codedoc container and can be placed anywhere in a document.
Line 118: Line 119:
   ~~codedoc:DokuWiki embeds [[:snippet]] filenames in HTML definition lists [[:definitions#def_1|see definitions]]~~   ~~codedoc:DokuWiki embeds [[:snippet]] filenames in HTML definition lists [[:definitions#def_1|see definitions]]~~
  
-As the above demonstrates, the links can contain references to internal link headings, that is to the named anchors which Dokuwiki creates when it formats its H1-H5 headings.+As the above demonstrates, the links can contain references to internal link headings, that is to the named anchors which DokuWiki creates when it formats its H1-H5 headings.
  
-One of the benefits of codedoc is that its comments support HTML markup. Comments will appear on more than one line if you insert HTML line-breaks into the comment or if the comment contains an internal newline.  If the plugin finds an HTML line-break, i.e. ''<BR />'' or ''<br />'', or if the comment is on more than one line, the comment will have the multi-line comment format:+One of the benefits of codedoc is that its comments support HTML markup. Comments will appear on more than one line if you insert HTML line-breaks into the comment or if the comment contains an internal newline.  If the plugin finds an HTML line-break, i.e. ''%%<BR />%%'' or ''%%<br />%%'', or if the comment is on more than one line, the comment will have the multi-line comment format:
  
 <code> <code>
Line 150: Line 151:
 === 4. Selective Highlighting === === 4. Selective Highlighting ===
  
-  ~~codedoc: <em>. . . </em>~~              +  ~~codedoc: <em>. . . </em>~~ 
-  ~~codedoc: <b>. . . </b>~~             +  ~~codedoc: <b>. . . </b>~~
  
 If the enclosed text contains either an ''<em>''  or a ''<b>'', it is styled as defined in If the enclosed text contains either an ''<em>''  or a ''<b>'', it is styled as defined in
Line 161: Line 162:
 === 5. Named Anchor === === 5. Named Anchor ===
  
-  ~~codedoc:xref:anchor_name~~             +  ~~codedoc:xref:anchor_name~~
  
 This will create a named anchor in your page, enabling you to link to places in your code, on the same or other pages, which are not marked by the anchors which DokuWiki creates((DokuWiki creates anchors for each H1-H5 heading)).  This feature is obviously very useful when linking to places inside code blocks which cannot contain header markup and therefore cannot have anchors defined by DokuWiki headers. This will create a named anchor in your page, enabling you to link to places in your code, on the same or other pages, which are not marked by the anchors which DokuWiki creates((DokuWiki creates anchors for each H1-H5 heading)).  This feature is obviously very useful when linking to places inside code blocks which cannot contain header markup and therefore cannot have anchors defined by DokuWiki headers.
plugin/codedoc.1570638994.txt.gz · Last modified: 2019-10-09 18:36 by Aleksandr

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