DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:bbcodeextensions

Differences

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

Link to this comparison view

Next revision
Previous revision
plugin:bbcodeextensions [2018-02-06 20:10] – created ryan.chappelleplugin:bbcodeextensions [2023-04-13 23:09] (current) ryan-chappelle
Line 4: Line 4:
 description:  description: 
 author     : Luis Machuca Bezzaza  author     : Luis Machuca Bezzaza 
-email      : luis.machuca@gulix.cl +email      : lambalicious [at] tuta [dot] io
 type       : syntax type       : syntax
-lastupdate : 2018-02-06+lastupdate : 2023-04-13
 compatible :  compatible : 
 depends    :  depends    : 
 conflicts  conflicts 
 similar    : bbcode similar    : bbcode
-tags       : formatting, markup_language, bbcode, experimental +tags       : formatting, markup_language, highlight, bbcode, htmlok_replacement
- +
-downloadurl: https://notabug.org/lmachucabezzaza/dw-plugin-bbcode-extensions/archive/master.zip +
-bugtracker : https://notabug.org/lmachucabezzaza/dw-plugin-bbcode-extensions/issues +
-sourcerepo : https://notabug.org/lmachucabezzaza/dw-plugin-bbcode-extensions/ +
-donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44AQDXJQJTJQ+
  
 +downloadurl: https://codeberg.org/lmachucabezzaza0/dw-plugin-bbcode-extensions/archive/master.zip
 +bugtracker : https://codeberg.org/lmachucabezzaza0/dw-plugin-bbcode-extensions/issues
 +sourcerepo : https://codeberg.org/lmachucabezzaza0/dw-plugin-bbcode-extensions
 +donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44AQDXJQJTJQ&source=url
 ---- ----
  
-The //BBCode Extensions// plugin introduces support for a number of nonstandard BBCode tags that are forum-specific and do not form part of the mainline [[doku>plugin:bbcode|BBCode plugin for Dokuwiki]]. +The //BBCode Extensions// plugin introduces support for a number of nonstandard BBCode tags that are forum-specific and do not form part of the mainline [[plugin:bbcode|BBCode Plugin for DokuWiki]].
  
  
 ===== Installation ===== ===== Installation =====
  
-Install the plugin using the [[doku>plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually
 + 
 +:!: The official release of the plugin has been moved over to Codeberg; the Notabug release URL remains as a mirror.
  
 ===== Usage ===== ===== Usage =====
 +
 +The plugin adds a few non-standard BBCode tags found in different forums. Where possible those tags map to HTML tags or formatting elements, to aid in supplementing :!: [[PR>3798|planned loss of embedded HTML support]].
  
 See the plugin in action at FIXME (pending demo page). See the plugin in action at FIXME (pending demo page).
  
-^ Syntax   ^ Result    ^ +**HTML Anchor** 
-| ''[a]name[/a]'' An anchor which can be pointed to via ''<nowiki>[[pagelink#name]]</nowiki>'' (see also: [[doku>plugin:anchor]]).  + 
-| ''[cd="classes..."]\\ Content[/cd]'' ''<div>'' with the given ''class="classes..."'' (see also: [[doku>plugin:wrap]]).  | +<code> 
-| ''[cs="classes..."]\\ Content[/cd]'' ''<span>'' with the given ''class="classes..."'' (see also: [[doku>plugin:wrap]]) |+[a]name[/a] 
 +</code> 
 + 
 +An anchor with HTML id "''name''" will be placed in the page at that position, which can be linked to via ''%%[[pagelink#name]]%%'' (see also: [[plugin:anchor]]). 
 + 
 +**Edit Markers** 
 + 
 +<code> 
 +[del]this section has been deleted[/del] 
 +[ins]this section has been added[/ins] 
 +</code> 
 + 
 +These tags mark text as being the result of an edit deletion or edit insertion via de respective HTML elements [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/del|del]] (deletion) and [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ins|ins]] (insertion).  
 + 
 +Depending on the user agent they are styled in different ways: for example, a deletion can be marked with <del>strikethrough</del> while an insertion can be styled with __underline__. 
 + 
 +**Highlight** 
 + 
 +<code> 
 +Please take notice of [hil]this particular result[/hil]. 
 +</code> 
 + 
 +Code stylized with this element is marked by default in the same way that the search results for the OS-level or browser-level in the current page. For example, in some browsers this is a yellow background. This is done via the [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark|mark]] HTML element. 
 + 
 + 
 +**Quote (inline)** 
 + 
 +<code> 
 +Some text with [q]a citation[/q]. 
 +Some text with [q cite="source author"]a citation with source[/q]. 
 +</code> 
 + 
 +The text will be formatted as a quotation. In general browsers do this by styling them the same way %%<em>%% are styled. Extra styling can be added by declaring the adequate elements in userstyles.css: 
 + 
 +<code css> 
 +/* The classname can change depending on your wiki configuration */ 
 +q.bbcodeextensions { 
 +font-family: cursive; 
 +
 +</code> 
 + 
 +**Terminal Interaction** 
 + 
 +<code> 
 +Type [kbd]hello world <Enter>[/kbd]  
 +and you get a [samp]Hello $NAME[/samp] as response. 
 +</code> 
 + 
 +Text marked with these tags is marked as, respectively, **input** given to a terminal prompt or to a system that takes user input, and **output** that is rendered by a terminal or other such device. These are basically semantic supplements to the ''code'' tag. See [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/kbd]] (user input) and [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/samp]] (terminal output). 
 + 
 +==== Freestyle ==== 
 + 
 +Two generic tags are added which allow to create a %%<div>%% or a %%<span>%% decorated with given classnames. This means you can style inline or block sections in any way that is loaded in your local wiki, for example in ''conf/userstyles.css''. The syntax is as follows: 
 + 
 + 
 +^  Wikitext  ^  Resulting HTML (approximate)  ^ 
 +| ''%%[cd="classes..."] Content [/cd]%%''  | ''%%<div class="classes..."> Content </div>%%'' 
 +| ''%%[cs="classes..."] Content [/cs]%%''  | ''%%<span class="classes..."> Content </span>%%''   | 
 + 
 +See also: the [[plugin:wrap|Wrap Plugin]].
  
  
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
  
-(to be done)+The plugin has one configurable parameter: 
 + 
 +^  Parameter ^  Usage   | 
 +| ''anchor_symbol''  | The symbol to preppend to anchor syntax for non-HTML renderers, such as the [[plugin:text|text renderer]]. Defaults to the [[wp>Index (typography)|typographical mark]] "☞" .  | 
  
 ===== Development ===== ===== Development =====
Line 46: Line 111:
 Potentially thinking of implementing some BBCode tags such as: Potentially thinking of implementing some BBCode tags such as:
  
-  * ''[baseurl=...]'' for domain-based relative URL links (see [[doku>plugin:baselink]]). +  * ''%%[baseurl=...]%%'' for domain-based relative URL links (see [[plugin:baselink]]). 
-  * ''[hil]...'' for highlighting text the same way as highlights for eg.: search results. +  * ''%%[hil]...%%'' for highlighting text the same way as highlights for eg.: search results. 
-  * ''[h1]'' ... ''[h6]'' for headers. +  * ''%%[h1]%%'' ... ''%%[h6]%%'' for headers. 
-  * ''[hh]'' for same-level headers. +  * ''%%[hh]%%'' for same-level headers. 
-  * ''[left]/[right]/[center]/[justify]'' for text alignment (see [[doku>plugin:divalign2]]). +  * ''%%[left]/[right]/[center]/[justify]%%'' for text alignment (see [[plugin:divalign2]]). 
-  * ''[abbr]'' for abbreviation/tooltip.+  * ''%%[abbr]%%'' for abbreviation/tooltip.
  
  
 === Change Log === === Change Log ===
  
-**2018-02-01** +{{rss>https://codeberg.org/lmachucabezzaza0/dw-plugin-bbcode-extensions.rss date}}
- +
-  * First upload. Support for ''a'' (anchor), ''cd'' ''cs'' (class div/span). +
- +
- +
-See the issue tracker for a more precise view of changes.+
  
 === Issues === === Issues ===
  
-See the [[https://notabug.org/lmachucabezzaza/dw-plugin-bbcode-extensions/issues|issue tracker]] for issues.+See the [[https://codeberg.org/lmachucabezzaza0/dw-plugin-bbcode-extensions/issues|issue tracker]] for issues.
  
  
 ===== FAQ ===== ===== FAQ =====
 +
 ===== Discussion ===== ===== Discussion =====
- 
- 
  
  
plugin/bbcodeextensions.1517944255.txt.gz · Last modified: 2018-02-06 20:10 by ryan.chappelle

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