DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace: • plugins • plugins
plugin:wrap

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:wrap [2016-03-30 19:59] – [Discussion] adrianvesaplugin:wrap [2024-08-05 19:16] (current) – [Wrap Plugin] Seems to work fine with Kaos fiwswe
Line 6: Line 6:
 email      : anika@selfthinker.org email      : anika@selfthinker.org
 type       : syntax, action, helper type       : syntax, action, helper
-lastupdate : 2015-07-19 +lastupdate : 2023-08-13 
-compatible : 2010-11-07 "Anteater", 2011-05-25 "Rincewind", 2012-01-25 "Angua", 2012-10-13 "Adora Belle", "Weatherwax", 2013-12-08 "Binky", 2014-05-05 "Ponder Stibbons", 2014-09-29 "Hrun", 2015-08-10 "Detritus"+compatible : !Greebo, Hogfather, Igor, Jack Jackrum, Kaos
 depends    :  depends    : 
 conflicts  :  conflicts  : 
-similar    : bootnote, bootswrapper, box, button, class, clearfloat, color, columns, comment, commentsrc, div_span_shorthand, divalign, divalign2, emphasis, fontcolor, fontfamily, fontsize, fontsize2, hide, highlight, htmlcomment, important_paragraf, importanttext, lang, layout, ltr, noprint, note, outdent, pagebreak, pagebreak, side_note, spoiler, styler, tab, tablewidth, tip, typography, wpre +similar    : bootnote, bootswrapper, box, button, class, clearfloat, color, columns, comment, commentsrc, div_span_shorthand, divalign, divalign2, emphasis, fontcolor, fontfamily, fontsize, fontsize2, hide, highlight, htmlcomment, important_paragraf, importanttext, lang, layout, ltr, noprint, note, outdent, pagebreak, side_note, spoiler, styler, tab, tablewidth, tip, typography, wpre, admnote 
-tags       : annotations, boxes, formatting, hide, highlight, icons, language, printing, style, typography+tags       : anchor, annotations, bookmark, boxes, columns, formatting, hide, highlight, icons, language, printing, style, tabs, typography, instructions
  
 downloadurl: https://github.com/selfthinker/dokuwiki_plugin_wrap/archive/stable.zip downloadurl: https://github.com/selfthinker/dokuwiki_plugin_wrap/archive/stable.zip
Line 18: Line 18:
 donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=11071728 donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=11071728
 ---- ----
 +
  
 ===== One plugin to rule them all ===== ===== One plugin to rule them all =====
Line 35: Line 36:
 ===== Installation ===== ===== Installation =====
  
-Download and install the plugin using the [[plugin:plugin|Plugin Manager]] using the URL given above. 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.
  
 ===== Syntax ===== ===== Syntax =====
Line 44: Line 45:
   </WRAP>   </WRAP>
      
-  or+  **or**
   <block classes #id width :language>   <block classes #id width :language>
   "big" content   "big" content
Line 82: Line 83:
 The following classes are currently available: The following classes are currently available:
  
-{{ :plugin:wrap_plugin_example9.png?300&direct}}+{{ :plugin:wrap_plugin_example10.png?300&direct}}
  
-^ class name  ^ description/notes  ^ 
-^ __columns__ -- similar to [[columns]], [[side_note]], [[styler]], [[tip]]  || 
-| **''column''**  | same as ''left'' in LTR languages and same as ''right'' in RTL languages  | 
-| **''left''**  | same as ''column'', will let you float your container on the left  | 
-| **''right''**  | will let the container float right  | 
-| **''center''**  | will position the container in the horizontal center of the page  | 
-| **''col2''**..**''col5''**  | will show the text in multiple columns (2, 3, 4 or 5), only works in modern browsers (Firefox, Chrome and Safari)  | 
-^ __widths__ -- :!: **experimental**, might not work as expected, includes mobile support  || 
-| **''half''**  | fits two columns in a row, should be used in pairs  | 
-| **''third''**  | fits three columns in a row, should be used in triplets  | 
-| **''quarter''**  | fits four columns in a row, should be used in quads  | 
-^ __alignments__ -- similar to [[divalign]], [[columns]], [[styler]] -- :!: don't work with spans!  || 
-| **''leftalign''**  | aligns text on the left  | 
-| **''rightalign''**  | aligns text on the right  | 
-| **''centeralign''**  | centers the text  | 
-| **''justify''**  | justifies the text  | 
-^ __boxes and notes__ -- similar to [[box]], [[note]], [[tip]]  || 
-| **''box''**  | creates a box around the container (uses colours from ''style.ini'')  | 
-| **''info''** (was ''information'' in first version)  | creates a blue box with an info icon  | 
-| **''important''**  | creates an orange box with an important icon  | 
-| **''alert''** (:!: was ''warning'' in previous versions)  | creates a red box with an alert icon  | 
-| **''tip''**  | creates a yellow box with a tip icon  | 
-| **''help''**  | creates a violet box with a help icon  | 
-| **''todo''**  | creates a cyan box with an todo icon  | 
-| **''download''**  | creates a green box with a download icon  | 
-| **''round''**  | adds rounded corners to any container with a background colour or a border (only works in modern browsers, i.e. no IE)  | 
-| **''danger''**  | creates a red danger safety note  | 
-| **''warning''**  | creates an orange warning safety note  | 
-| **''caution''**  | creates a yellow caution safety note  | 
-| **''notice''**  | creates a blue notice safety note  | 
-| **''safety''**  | creates a green safety note  | 
-^ __marks__ -- similar to [[emphasis]], [[important_paragraf]], [[importanttext]]  || 
-| **''hi''**  | marks text as highlighted  | 
-| **''lo''**  | marks text as less significant  | 
-| **''em''**  | marks text as especially emphasised  | 
-^ __miscellaneous__  || 
-| **''clear''**  | similar to [[clearfloat]], should preferably be used with divs, i.e. uppercase ''%%<WRAP>%%''s  | 
-| **''tabs''**  | if wrapped around a list of links, will show those as tabs  | 
-| **''hide''**  | hides the text per CSS (the text will still appear in the source code, in non-modern browsers and is searchable)  | 
-| **''noprint''**  | displays text on the screen, but not in print, similar to [[noprint]]  | 
-| **''onlyprint''**  | displays text only in print, but not on the screen  | 
-| **''pagebreak''**  | forces a new page in printouts (not visible on the screen), similar to [[pagebreak]]  | 
-| **''nopagebreak''**  | tries to avoid a pagebreak in printouts (not visible on the screen)  | 
-| **''spoiler''**  | shows white text on a white background, only to be revealed by highlighting it; similar to [[hide]]  | 
-| **''button''**  | when wrapped around a link, styles it like a button  | 
-| **''indent''**  | indents the text, could be used instead of [[tab]]  | 
-| **''outdent''**  | "outdents" the text, could partly be used instead of [[outdent]]  | 
-| **''prewrap''**  | wraps text inside pre-formatted code blocks, similar to [[wpre]]  | 
  
-All tables inside a column or box will always be 100% wide. This makes positioning and sizing tables possible and partly replaces [[tablewidth]].+^ class name                                                                                        ^ description/notes                                                                                                                                     ^ 
 +^ __columns__ -- similar to [[columns]], [[side_note]], [[styler]], [[tip]]                                                                                                                                                                                || 
 +| **''column''**                                                                                    | same as ''left'' in LTR languages and same as ''right'' in RTL languages                                                                              | 
 +| **''left''**                                                                                      | same as ''column'', will let you float your container on the left                                                                                     | 
 +| **''right''**                                                                                     | will let the container float right                                                                                                                    | 
 +| **''center''**                                                                                    | will position the container in the horizontal center of the page                                                                                      | 
 +| **''col2''**..**''col5''**                                                                        | will show the text in multiple columns determined by their amount (2, 3, 4 or 5), only works in modern browsers (no IE9 and below)                    | 
 +| **''colsmall''**, **''colmedium''**, **''collarge''**                                             | will also show the text in multiple columns but determined by their width (small, medium or large), only works in modern browsers (no IE9 and below)  | 
 +^ __widths__ -- :!: **experimental**, might not work as expected, includes mobile support                                                                                                                                                                  || 
 +| **''half''**                                                                                      | fits two columns in a row, should be used in pairs                                                                                                    | 
 +| **''third''**                                                                                     | fits three or two columns in a row, should be used in triplets or together with ''twothirds''                                                         | 
 +| **''twothirds''**                                                                                 | fits two columns in a row when used together with ''third'', one 1/3 wide and another 2/3 wide                                                        | 
 +| **''quarter''**                                                                                   | fits four columns in a row, should be used in quads                                                                                                   | 
 +^ __alignments__ -- similar to [[divalign]], [[columns]], [[styler]] -- :!: don't work with spans!                                                                                                                                                         || 
 +| **''leftalign''**                                                                                 | aligns text on the left                                                                                                                               | 
 +| **''rightalign''**                                                                                | aligns text on the right                                                                                                                              | 
 +| **''centeralign''**                                                                               | centers the text                                                                                                                                      | 
 +| **''justify''**                                                                                   | justifies the text                                                                                                                                    | 
 +^ __boxes and notes__ -- similar to [[box]], [[note]], [[tip]]                                                                                                                                                                                             || 
 +| **''box''**                                                                                       | creates a box around the container (uses colours from ''style.ini'')                                                                                  | 
 +| **''info''** (was ''information'' in first version)                                               | creates a blue box with an info icon                                                                                                                  | 
 +| **''important''**                                                                                 | creates an orange box with an important icon                                                                                                          | 
 +| **''alert''** (:!: was ''warning'' in previous versions)                                          | creates a red box with an alert icon                                                                                                                  | 
 +| **''tip''**                                                                                       | creates a yellow box with a tip icon                                                                                                                  | 
 +| **''help''**                                                                                      | creates a violet box with a help icon                                                                                                                 | 
 +| **''todo''**                                                                                      | creates a cyan box with an todo icon                                                                                                                  | 
 +| **''download''**                                                                                  | creates a green box with a download icon                                                                                                              | 
 +| **''round''**                                                                                     | adds rounded corners to any container with a background colour or a border (only works in modern browsers, i.e. no IE)                                | 
 +| **''danger''**                                                                                    | creates a red danger safety note                                                                                                                      | 
 +| **''warning''**                                                                                   | creates an orange warning safety note                                                                                                                 | 
 +| **''caution''**                                                                                   | creates a yellow caution safety note                                                                                                                  | 
 +| **''notice''**                                                                                    | creates a blue notice safety note                                                                                                                     | 
 +| **''safety''**                                                                                    | creates a green safety note                                                                                                                           | 
 +^ __marks__ -- similar to [[emphasis]], [[important_paragraf]], [[importanttext]]                                                                                                                                                                          || 
 +| **''hi''**                                                                                        | marks text as highlighted                                                                                                                             | 
 +| **''lo''**                                                                                        | marks text as less significant                                                                                                                        | 
 +| **''em''**                                                                                        | marks text as especially emphasised                                                                                                                   | 
 +^ __miscellaneous__                                                                                                                                                                                                                                        || 
 +| **''clear''**                                                                                     | similar to [[clearfloat]], should preferably be used with divs, i.e. uppercase ''%%<WRAP>%%''s                                                        | 
 +| **''tabs''**                                                                                      | if wrapped around a list of links, will show those as tabs                                                                                            | 
 +| **''hide''**                                                                                      | hides the text per CSS (the text will still appear in the source code, in non-modern browsers and is searchable)                                      | 
 +| **''noprint''**                                                                                   | displays text on the screen, but not in print, similar to [[noprint]]                                                                                 | 
 +| **''onlyprint''**                                                                                 | displays text only in print, but not on the screen                                                                                                    | 
 +| **''pagebreak''**                                                                                 | forces a new page in printouts (not visible on the screen), similar to [[pagebreak]]                                                                  | 
 +| **''nopagebreak''**                                                                               | tries to avoid a pagebreak in printouts (not visible on the screen)                                                                                   | 
 +| **''spoiler''**                                                                                   | shows white text on a white background, only to be revealed by highlighting it; similar to [[hide]]                                                   | 
 +| **''button''**                                                                                    | when wrapped around a link, styles it like a button                                                                                                   | 
 +| **''tablewidth''**                                                                                | sets widths of tables inside to whichever width the wrap gets, partly replaces [[tablewidth]]                                                         | 
 +| **''indent''**                                                                                    | indents the text, could be used instead of [[tab]]                                                                                                    | 
 +| **''outdent''**                                                                                   | "outdents" the text, could partly be used instead of [[outdent]]                                                                                      | 
 +| **''prewrap''**                                                                                   | wraps text inside pre-formatted code blocks, similar to [[wpre]]                                                                                      |
  
 === Known restrictions === === Known restrictions ===
  
-  * WRAPs won't export in ODT format.+  * WRAPs export to ODT format but not everything works 100%
   * Round corners only work in modern browsers (no IE8 and below).   * Round corners only work in modern browsers (no IE8 and below).
   * Multiple columns only work in modern browsers (no IE9 and below).   * Multiple columns only work in modern browsers (no IE9 and below).
   * Width classes are experimental and only work in modern browsers (no IE8 and below).   * Width classes are experimental and only work in modern browsers (no IE8 and below).
-  * Normal DokuWiki Headlines used to not work and a work-around was added. Now that headlines do work, the work-around is not needed anymore but kept for backwards-compatibility. The following syntax would produce two different kinds of emulated headlines inside any of the columns or boxes/notes:+  * Normal DokuWiki Headlines used to not work and a work-around was added. Now that headlines do work, the work-around is not needed anymore but kept for backwards-compatibility. It was deprecated in version 2018-04-22 and disabled by default. They can be enabled by using the ''emulatedHeadlines'' [[#configuration_options|config option]]. The following syntax would then produce two different kinds of emulated headlines inside any wrap:
     * %%//**__Big Underlined Headline__**//%% (They will look a bit different in safety notes.)     * %%//**__Big Underlined Headline__**//%% (They will look a bit different in safety notes.)
     * %%//**Small Headline**//%%     * %%//**Small Headline**//%%
 +  * do not include ~~DISCUSSION~~ within a WRAP noprint block
  
 You might need to adjust a few of the classes to your template's needs, especially ''hi'', ''lo'' and ''em''. If you have a dark or otherwise heavily coloured theme, please use the ''darkTpl'' [[#configuration_options|config option]]. You might need to adjust a few of the classes to your template's needs, especially ''hi'', ''lo'' and ''em''. If you have a dark or otherwise heavily coloured theme, please use the ''darkTpl'' [[#configuration_options|config option]].
Line 151: Line 155:
 ==== Widths ==== ==== Widths ====
  
-You can set any valid widths on any uppercase %%<WRAP>%% container: ''%, px, em, ex, pt, pc, cm, mm, in''. Just set the width before or after or with the classes, e.g.+You can set any valid widths on any uppercase %%<WRAP>%% container: ''%, px, em, rem, ex, ch, vw, vh, pt, pc, cm, mm, in''. Just set the width before or after or with the classes, e.g.
   <WRAP someclass 50% anotherclass>...   <WRAP someclass 50% anotherclass>...
 All except percentages will be reduced to have the maximum width available on smaller screens. All except percentages will be reduced to have the maximum width available on smaller screens.
  
-You can also use the width keywords ''half'', ''third'' and ''quarter''. To work correctly they need another wrap around them. E.g.+You can also use the width keywords ''half'', ''third'', ''twothirds'' and ''quarter''. To work correctly they need another wrap around them. E.g.
   <WRAP group>   <WRAP group>
     <WRAP half column>...</WRAP>     <WRAP half column>...</WRAP>
Line 161: Line 165:
   </WRAP>   </WRAP>
 will result in two columns next to each other, which will wrap underneath each other on smaller screens and mobile devices. will result in two columns next to each other, which will wrap underneath each other on smaller screens and mobile devices.
 +
 +
 +==== Anchor ====
 +
 +To define an anchor, the following syntax applies:
 +  <wrap #ankername />
 +
 +The anchor is accessible via: ''#ankername''
  
 ==== Languages and Text Directions ==== ==== Languages and Text Directions ====
Line 178: Line 190:
 You can see a demo of the plugin on [[http://demo.selfthinker.org/plugin:wrap|demo.selfthinker.org]]. You can see a demo of the plugin on [[http://demo.selfthinker.org/plugin:wrap|demo.selfthinker.org]].
  
-[[https://fotki.yandex.ru/next/users/alexgearbox/album/189832/view/740257|“Examples” (demo) in Russian]] (for v2011-05-15). [[http://pastebin.com/C9xjaEH9|Source]].+[[https://yadi.sk/i/ycbENWFjWEduTA|“Examples” (demo) in Russian]] (for v2011-05-15). [[http://pastebin.com/C9xjaEH9|Source]].
  
 +[[http://mcloud-doc.lonxun.com/wiki/playground/wrap|a demo of the plugin in China]]
 ===== Configuration options ===== ===== Configuration options =====
  
 ^ Option  ^ Description  ^ Default value ^ ^ Option  ^ Description  ^ Default value ^
-|''noPrefix''  | Which (comma separated) class names should be excluded from being prefixed with "wrap_" | tabs, group | +|''noPrefix''  | Which (comma separated) class names should be excluded from being prefixed with "wrap_"  (* and ? wildcards allowed) | tabs, group | 
-|''restrictedClasses'' | restrict usage of plugin to these (comma separated) classes | //(empty)// | +|''restrictedClasses'' | Restrict usage of plugin to these (comma separated) classes (* and ? wildcards allowed) | //(empty)// | 
-|''restrictionType''  | restriction type, specifies if classes above shall be included or excluded | 0 |+|''restrictionType''  | Restriction type, specifies if classes above shall be included or excluded | 0 |
 |''syntaxDiv''  | Which syntax should be used in the toolbar picker for block wraps? | WRAP (other choices: div, block) | |''syntaxDiv''  | Which syntax should be used in the toolbar picker for block wraps? | WRAP (other choices: div, block) |
 |''syntaxSpan''  | Which syntax should be used in the toolbar picker for inline wraps? | wrap (other choices: span, inline) | |''syntaxSpan''  | Which syntax should be used in the toolbar picker for inline wraps? | wrap (other choices: span, inline) |
 |''darkTpl''  | Optimise colours for dark templates? | 0 | |''darkTpl''  | Optimise colours for dark templates? | 0 |
 +|''emulatedHeadlines''  | Use emulated headings? (deprecated) | 0 |
  
 ===== ODT Support ===== ===== ODT Support =====
 +
 +FIXME There have been more updates to the Wrap as well as the ODT plugin, so more stuff works. The below should be updated with what works and what doesn't.
  
 Since version 2015-06-13 the Wrap plugin supports exporting most of its functionality/styling to ODT when using at least version 2015-06-29 of the [[odt|ODT Plugin]]. By default, Wrap syntax will be exported to ODT using 'print' CSS styles. This means the exported Wrap elements will look the same when printing a wiki page. If you want to have the ODT exported Wrap elements look like displayed in the browser (i.e. with 'screen' CSS styles), then use the following ODT plugin configuration settings: Since version 2015-06-13 the Wrap plugin supports exporting most of its functionality/styling to ODT when using at least version 2015-06-29 of the [[odt|ODT Plugin]]. By default, Wrap syntax will be exported to ODT using 'print' CSS styles. This means the exported Wrap elements will look the same when printing a wiki page. If you want to have the ODT exported Wrap elements look like displayed in the browser (i.e. with 'screen' CSS styles), then use the following ODT plugin configuration settings:
Line 221: Line 237:
   * "simple centered box" creates a standard box (60% wide, centered)   * "simple centered box" creates a standard box (60% wide, centered)
   * "info, tip, important, alert, help, download, todo box" creates specifically themed boxes (also 60% wide, centered)   * "info, tip, important, alert, help, download, todo box" creates specifically themed boxes (also 60% wide, centered)
-  * "clear floats" creates a ''%%<WRAP clear></WRAP>%%''+  * "clear floats" creates a ''%%<WRAP clear/>%%''
   * "especially emphasised, highlighted, less significant" creates the respective marks   * "especially emphasised, highlighted, less significant" creates the respective marks
  
Line 237: Line 253:
 ==== Examples ==== ==== Examples ====
  
-in style.css+in userall.css:
  
 <code css> <code css>
Line 252: Line 268:
   <WRAP note>...</WRAP>   <WRAP note>...</WRAP>
  
-Here are some [[plugin:wrap:extensions|useful wrap extensions]] created by users of this plugin.+Here are some [[plugin:wrap:extensions|useful Wrap extensions]] created by users of this plugin.
 ==== Add former typography classes ==== ==== Add former typography classes ====
  
Line 303: Line 319:
 ==== Done ==== ==== Done ====
  
-[[https://github.com/selfthinker/dokuwiki_plugin_wrap/commits/master.atom|{{http://img529.imageshack.us/img529/5725/feedm.png?16x16 |Recent commits to Wrap Plugin (RSS feed)}}]]+[[https://github.com/selfthinker/dokuwiki_plugin_wrap/commits/master.atom|{{https://raw.githubusercontent.com/legacy-icons/famfamfam-silk/master/dist/png/feed.png?16x16&recache |Recent commits to Wrap Plugin (RSS feed)}}]]
 {{rss>https://github.com/selfthinker/dokuwiki_plugin_wrap/commits/master.atom date}} {{rss>https://github.com/selfthinker/dokuwiki_plugin_wrap/commits/master.atom date}}
  
 ==== Localization ==== ==== Localization ====
  
-You can help me with translations and [[http://translate.dokuwiki.org/plugin/wrap|update the language files]]. There are two files to translate:+You can help me with translations and [[https://translate.dokuwiki.org/plugin/wrap|update the language files]]. There are two files to translate:
  
   * [[https://github.com/selfthinker/dokuwiki_plugin_wrap/blob/master/lang/en/lang.php|lang/en/lang.php]] is for the explaining titles on the picker images.   * [[https://github.com/selfthinker/dokuwiki_plugin_wrap/blob/master/lang/en/lang.php|lang/en/lang.php]] is for the explaining titles on the picker images.
Line 320: Line 336:
   * The toolbar uses images from the [[http://www.famfamfam.com/lab/icons/silk/|Silk Icon Set]] and the [[http://www.damieng.com/icons/silkcompanion|Silk Companion Icon Set]].   * The toolbar uses images from the [[http://www.famfamfam.com/lab/icons/silk/|Silk Icon Set]] and the [[http://www.damieng.com/icons/silkcompanion|Silk Companion Icon Set]].
   * Thanks to [[https://github.com/selfthinker/dokuwiki_plugin_wrap/contributors|all contributors]].   * Thanks to [[https://github.com/selfthinker/dokuwiki_plugin_wrap/contributors|all contributors]].
 +
 +===== See also =====
 +
 +  * [[.:wrap:extensions|Useful extensions for the Wrap Plugin]]
 +  * [[.wrap:extensions?do=index|Sub pages to Wrap Plugin]]
  
 ===== Discussion ===== ===== Discussion =====
Line 328: Line 349:
  
 Not understand how works "tabs", I create the tabs but how I add the content of the tabs ? If I click on a tab redirect me to page that not exist.  --- [[user>adrianvesa|adrianvesa]] //2016-03-30 19:58// Not understand how works "tabs", I create the tabs but how I add the content of the tabs ? If I click on a tab redirect me to page that not exist.  --- [[user>adrianvesa|adrianvesa]] //2016-03-30 19:58//
 +
 +
 +Example how to add new button into the picker: [[http://webdev.d77.in/downloads/dokuwiki_wrap_prewrap.tar.gz|DokuWiki wrap plugin prewrap patch]]\\
 +This patch adds button for ''<WRAP prewrap>'' code. --- [[user>denisvs|DenisVS]] //2017-07-11 14:38//
 +
 +
 +Is it possible to edit the selection in the 'Toolbar Picker' I would like to add something. --- [[user>stud_med|stud_med]] //2021-01-19 19:42//
plugin/wrap.1459360754.txt.gz · Last modified: by adrianvesa
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

Global DokuWiki Links