====== skipentity Plugin ======

---- plugin ----
description: Creates monospaced text without processing entities as well as other markup
author     : Myron Turner 
email      : turnermm02@shaw.ca 
type       : syntax
lastupdate : 2021-12-26
compatible : Detritus, "Elenor Of Tsort", "Frusterick Manners",Greebo,hogfather
depends    : 
conflicts  : 
similar    : unformattedcode
tags       : code, entity, formatting, typography
downloadurl: https://github.com/turnermm/Dokuwiki-skip-entity/archive/master.zip
bugtracker : https://github.com/turnermm/Dokuwiki-skip-entity/issues
sourcerepo : https://github.com/turnermm/Dokuwiki-skip-entity
donationurl: http://mturner.org/userfiles/donate.php  

screenshot_img : 
----

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. 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 (c)

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 [[plugin: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: [[https://github.com/turnermm/Dokuwiki-skip-entity/blob/master/skent.png|{{https://raw.githubusercontent.com/turnermm/Dokuwiki-skip-entity/master/skent.png?32x32&recache}}]]

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 option((''allow_formats''; this option is turned off by default)), which will enable formatting but with one exception: the entity text itself or any text meant to be literalized cannot be included within the DokuWiki formatting markup.
<code>``**this is bold but exclude the** entity text **from the bold markup**``</code>

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** (c) **from the bold markup**''.

If you wish to apply DokuWiki 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:

<code>**``this is a text with the (c) copyright entity``**</code>

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 <nowiki>%%text%%</nowiki>, 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:

{{ http://mturner.org/userfiles/doku/skipentity-1_zpsac9iuvfv.png }}

The left-hand icon is the triple and the right is the double backquotes. 

==== Configuration ====
^allow_formats|Allow Dokuwiki formatting syntax inside skipentity markup|
^multiple|Enable toolbar icons for both double and triple back-ticks; this gives you a choice between using your template's TrueType styling (double ticks) and TrueType with styling removed (triple ticks). See [[#triple_backquotes_syntax]]|
^xcl_formats|When set to true, this setting enables you to exclude selected formats from those which are allowed when the allow_formats option is set to true|

=== Notes on xcl_formats ===
  *  In the xcl_formats choices, ''emphasis'' and ''strong'' refer respectively to italic and bold
  * Some users have found that allowing italic (emphasis) formatting interferes with url markup.  Therefore, the xcl_formats option can remove italic from the allowed formats, which is in fact the default setting. 
===== Change Log =====

Use either the DokuWiki forum or GitHub's issues, which is linked to above.

{{rss>https://github.com/turnermm/Dokuwiki-skip-entity/commits/master.atom date count=12}}

===== Discussion =====

Use either the [[https://forum.dokuwiki.org/|forum]] or [[https://github.com/turnermm/Dokuwiki-skip-entity/issues|GitHub issues]].