allow_formats
; this option is turned off by defaultThis is an old revision of the document!
Table of Contents
skipentity Plugin
Compatible with DokuWiki
detritus, "Elenor Of Tsort","Frusterick Manners"
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to unformattedcode
Installation
Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.
Examples/Usage
Dokuwiki enables the configuration of various text combinations for conversion into HTML entities. For instance:
- <-> becomes ↔
- (c) becomes ©
This plugin uses a very simple syntax to prevent these conversions conversions, in monospaced text, by replacing Dokuwiki's double apostrophes with double backward apostrophes (or backquotes
), so that:
- ``(c)`` becomes
(c)
- ``<->`` becomes
<->
This syntax replaces Dokuwiki's native markup for monospace text, giving monospaced text while preserving, as literals, combinations that would otherwise be converted to entities.
The functionality of this plugin goes beyond preserving entity literals, since it will convert to literals any markup found inside the backquotes. So, for instance, if you wish to add an example from the wrap plugin, this:
``<WRAP center round box 60%> simple centered box </WRAP> ``
will give you this: <WRAP center round box 60%> simple centered box </WRAP>
Full Syntax
The Double Backquote syntax
The plugin comes with a toolbar icon, which can be viewed here:
The user selects the relevant text, clicks on the icon, and the text will be enclosed within a pair of backquotes:
``text``
In its default configuration, everything contained within the backquotes is treated as literal. However, there is a configuration option1), which will enable formatting but with one exception: the entity text itself or any text meant to be literal-ized cannot be included within the Dokuwiki formatting markup.
``**this is bold but exclude the** entity text **from the bold markup**``
This will give you:
this is bold but exclude the (c) from the bold markup
.
Otherwise you will get:
this is bold but exclude the © from the bold markup
.
If you wish to apply Dokuwikiwi formatting to the entire selection, you can do this by placing the formatting external to the skipentity
markup. So to make the entire selection bold, you can do this:
**``this is a text with the (c) copyright entity``**
This would give you: this is a text with the (c) copyright entity
. This is the same technique as you would use with links: **[[start|start]]**.
Triple Backquotes Syntax
If you use three backquotes, instead of two, the selected text will remain True Type (monospaced) but the background shadowing and coloring will be removed, so that you will get a text which is black on white, or more accurately, the color of your template's font-color setting, and the color of its background-color setting. So ```this is (c) text``` will give you:
this is (c) text
instead of this is (c) text
.
It is very much like using <nowiki>text</nowiki> or %%text%%, except that the font treatment will be True Type.
Extra toolbar icons
If you plan to use the triple backquotes format frequently, you can set the skipentity multiple
configuration option to true. This will add two toolbar icons that pop up when you click on the main skipentity
icon, one for the double backquotes and one for the triple:
The left-hand icon is the triple and the right is the double backquotes.
Change Log
Use either the Dokuwiki forum or github's issues, which is linked to above.
- Merge pull request #2 from turnermm/xcl_formats (2021-12-26 18:05)
- updates version (2021-12-26 18:01)
- enables selective removal of default formatting markup when allow_for… (2021-12-26 17:58)
- updates version (2021-12-23 21:53)
- Changed PARSER_MODES[formatting] from hard-coded selected list to lis… (2021-12-23 18:22)
- Inserts into syntax.php::getAllowedTypes a reformulated $PARSER_MODES… (2021-12-23 00:00)
- Correction to Settings.php (2019-08-12 01:57)
- Adds support for multiple spaces (2019-08-09 17:01)
- updated function declarations to php 7 (2016-11-08 13:36)
- update info (2016-07-31 13:02)
- Update README.md (2016-06-17 18:09)
- reset multiple to false, updated setting text url (2016-06-14 03:02)
Discussion
Use either the forum or github issues