| Both sides previous revision Previous revision Next revision | Previous revision |
| wiki:plugins:wrap [2010/07/15 21:22] – becker | wiki:plugins:wrap [2012/03/29 09:10] (current) – external edit 127.0.0.1 |
|---|
| ====== Wrap Plugin ====== | ====== Wrap Plugin ====== |
| | http://www.dokuwiki.org/plugin:wrap |
| |
| ---- plugin ---- | ---- plugin ---- |
| It potentially replaces a lot of other plugins and is IMHO the better alternative for many. There is one exception: It currently lacks ODT support. If you need ODT support, you might want to take a look at similar plugins. | It potentially replaces a lot of other plugins and is IMHO the better alternative for many. There is one exception: It currently lacks ODT support. If you need ODT support, you might want to take a look at similar plugins. |
| |
| It fully replaces: [[http://www.dokuwiki.org/plugin:class]], [[http://www.dokuwiki.org/plugin:divalign]], [[http://www.dokuwiki.org/plugin:div_span_shorthand]], [[http://www.dokuwiki.org/plugin:side_note]], [[http://www.dokuwiki.org/plugin:tip]], [[http://www.dokuwiki.org/plugin:clearfloat]], [[http://www.dokuwiki.org/plugin:emphasis]], [[http://www.dokuwiki.org/plugin:hide]], [[http://www.dokuwiki.org/plugin:hilited]], [[http://www.dokuwiki.org/plugin:important_paragraf]], [[http://www.dokuwiki.org/plugin:important_text]], [[http://www.dokuwiki.org/plugin:noprint]], [[http://www.dokuwiki.org/plugin:pagebreak]], [[http://www.dokuwiki.org/plugin:wpre]], [[http://www.dokuwiki.org/plugin:lang]], [[http://www.dokuwiki.org/plugin:ltr]] \\ | It fully replaces: [[http://www.dokuwiki.org/plugin:class|class]], [[http://www.dokuwiki.org/plugin:divalign|divalign]], [[http://www.dokuwiki.org/plugin:div_span_shorthand|div_span_shorthand]], [[http://www.dokuwiki.org/plugin:side_note|side_note]], [[http://www.dokuwiki.org/plugin:tip|tip]], [[http://www.dokuwiki.org/plugin:clearfloat|clearfloat]], [[http://www.dokuwiki.org/plugin:emphasis|emphasis]], [[http://www.dokuwiki.org/plugin:hide|hide]], [[http://www.dokuwiki.org/plugin:hilited|hilited]], [[http://www.dokuwiki.org/plugin:important_paragraf|important_paragraph]], [[http://www.dokuwiki.org/plugin:important_text|inportant_text]], [[http://www.dokuwiki.org/plugin:noprint|noprint]], [[http://www.dokuwiki.org/plugin:pagebreak|pagebreak]], [[http://www.dokuwiki.org/plugin:wpre|wpre]], [[http://www.dokuwiki.org/plugin:lang]], [[http://www.dokuwiki.org/plugin:ltr|ltr]] \\ |
| It partly replaces: [[http://www.dokuwiki.org/plugin:box]], [[http://www.dokuwiki.org/plugin:layout]], [[http://www.dokuwiki.org/plugin:note]], [[http://www.dokuwiki.org/plugin:styler]], [[http://www.dokuwiki.org/plugin:typography]], [[http://www.dokuwiki.org/plugin:color]], [[http://www.dokuwiki.org/plugin:columns]], [[http://www.dokuwiki.org/plugin:fontcolor]], [[http://www.dokuwiki.org/plugin:fontfamily]], [[http://www.dokuwiki.org/plugin:fontsize]], [[http://www.dokuwiki.org/plugin:fontsize2]], [[http://www.dokuwiki.org/plugin:highlight]], [[http://www.dokuwiki.org/plugin:tab]], [[http://www.dokuwiki.org/plugin:tablewidth]] | It partly replaces: [[http://www.dokuwiki.org/plugin:box|box]], [[http://www.dokuwiki.org/plugin:layout|layout]], [[http://www.dokuwiki.org/plugin:note|note]], [[http://www.dokuwiki.org/plugin:styler|styler]], [[http://www.dokuwiki.org/plugin:typography|typeography]], [[http://www.dokuwiki.org/plugin:color|color]], [[http://www.dokuwiki.org/plugin:columns|columns]], [[http://www.dokuwiki.org/plugin:fontcolor|fontcolor]], [[http://www.dokuwiki.org/plugin:fontfamily|fontfamily]], [[http://www.dokuwiki.org/plugin:fontsize|fontsize]], [[http://www.dokuwiki.org/plugin:fontsize2]], [[http://www.dokuwiki.org/plugin:highlight|highlight]], [[http://www.dokuwiki.org/plugin:tab|tab]], [[http://www.dokuwiki.org/plugin:tablewidth|tablewidth]] |
| |
| |
| |
| ^class name^description/notes^ | ^class name^description/notes^ |
| ^__columns__ -- similar to [[http://www.dokuwiki.org/plugin:columns]], [[http://www.dokuwiki.org/plugin:side_note]], [[http://www.dokuwiki.org/plugin:styler]], [[http://www.dokuwiki.org/plugin:tip]]^^ | ^__columns__ -- similar to [[http://www.dokuwiki.org/plugin:columns|columns]], [[http://www.dokuwiki.org/plugin:side_note|side_note]], [[http://www.dokuwiki.org/plugin:styler|styler]], [[http://www.dokuwiki.org/plugin:tip|tip]]^^ |
| |**''column''** | same as ''left'' in LTR languages and same as ''right'' in RTL languages| | |**''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 | | |**''left''** | same as ''column'', will let you float your container on the left | |
| |**''right''** | will let the container float right | | |**''right''** | will let the container float right | |
| |**''center''** | will position the container in the horizontal center of the page | | |**''center''** | will position the container in the horizontal center of the page | |
| ^__alignments__ -- similar to [[http://www.dokuwiki.org/plugin:divalign]], [[http://www.dokuwiki.org/plugin:columns]], [[http://www.dokuwiki.org/plugin:styler]] -- :!: don't work with spans, i.e. lowercase ''%%<wrap>%%''s!^^ | ^__alignments__ -- similar to [[http://www.dokuwiki.org/plugin:divalign|divalign]], [[http://www.dokuwiki.org/plugin:columns|columns]], [[http://www.dokuwiki.org/plugin:styler|styler]] -- :!: don't work with spans, i.e. lowercase ''%%<wrap>%%''s!^^ |
| |**''leftalign''** | aligns text on the left | | |**''leftalign''** | aligns text on the left | |
| |**''rightalign''** | aligns text on the right | | |**''rightalign''** | aligns text on the right | |
| |**''centeralign''** | centers the text | | |**''centeralign''** | centers the text | |
| |**''justify''** | justifies the text | | |**''justify''** | justifies the text | |
| ^__boxes and notes__ -- similar to [[http://www.dokuwiki.org/plugin:box]], [[http://www.dokuwiki.org/plugin:note]], [[http://www.dokuwiki.org/plugin:tip]]^^ | ^__boxes and notes__ -- similar to [[http://www.dokuwiki.org/plugin:box|box]], [[http://www.dokuwiki.org/plugin:note|note]], [[http://www.dokuwiki.org/plugin:tip|tip]]^^ |
| |**''box''** | creates a box around the container (uses colours from ''style.ini'') | | |**''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 | | |**''info''** (was ''information'' in first version)| creates a blue box with an info icon | |
| |**''notice''** | creates a blue notice safety note | | |**''notice''** | creates a blue notice safety note | |
| |**''safety''** | creates a green safety note | | |**''safety''** | creates a green safety note | |
| ^__marks__ -- similar to [[http://www.dokuwiki.org/plugin:hilited]], [[http://www.dokuwiki.org/plugin:emphasis]], [[http://www.dokuwiki.org/plugin:important_paragraf]], [[http://www.dokuwiki.org/plugin:important_text]]^^ | ^__marks__ -- similar to [[http://www.dokuwiki.org/plugin:hilited|hilited]], [[http://www.dokuwiki.org/plugin:emphasis|emphasis]], [[http://www.dokuwiki.org/plugin:important_paragraf|important_paragraf]], [[http://www.dokuwiki.org/plugin:important_text|important_text]]^^ |
| |**''hi''** | marks text as highlighted | | |**''hi''** | marks text as highlighted | |
| |**''lo''** | marks text as less significant | | |**''lo''** | marks text as less significant | |
| |**''em''** | marks text as especially emphasised | | |**''em''** | marks text as especially emphasised | |
| ^__typography__ (not recommended) -- similar to [[http://www.dokuwiki.org/plugin:typography]], [[http://www.dokuwiki.org/plugin:styler]], [[http://www.dokuwiki.org/plugin:color]], [[http://www.dokuwiki.org/plugin:fontcolor]], [[http://www.dokuwiki.org/plugin:highlight]], [[http://www.dokuwiki.org/plugin:fontsize]], [[http://www.dokuwiki.org/plugin:fontsize2]], [[http://www.dokuwiki.org/plugin:fontfamily]]^^ | ^__typography__ (not recommended) -- similar to [[http://www.dokuwiki.org/plugin:typography|typography]], [[http://www.dokuwiki.org/plugin:styler|styler]], [[http://www.dokuwiki.org/plugin:color|color]], [[http://www.dokuwiki.org/plugin:fontcolor|fontcolor]], [[http://www.dokuwiki.org/plugin:highlight|hilight]], [[http://www.dokuwiki.org/plugin:fontsize|fontsize]], [[http://www.dokuwiki.org/plugin:fontsize2|fontsize2]], [[http://www.dokuwiki.org/plugin:fontfamily|fontfamily]]^^ |
| |''sansserif'', ''serif'', ''monospace'' | changes the font family | | |''sansserif'', ''serif'', ''monospace'' | changes the font family | |
| |''bigger'', ''muchbigger'', ''smaller'' | changes the font size | | |''bigger'', ''muchbigger'', ''smaller'' | changes the font size | |
| |''bgred'', ''bggreen'', ''bgblue'', ''bgcyan'', ''bgviolet'', ''bgyellow'', ''bggrey'', ''bgwhite'', ''bgblack'' | changes the background colour| | |''bgred'', ''bggreen'', ''bgblue'', ''bgcyan'', ''bgviolet'', ''bgyellow'', ''bggrey'', ''bgwhite'', ''bgblack'' | changes the background colour| |
| ^__miscellaneous__^^ | ^__miscellaneous__^^ |
| |**''clear''** | similar to [[clearfloat]], should preferably be used with divs, i.e. uppercase ''%%<WRAP>%%''s | | |**''clear''** | similar to [[http://www.dokuwiki.org/plugin:clearfloat|clearfloat]], should preferably be used with divs, i.e. uppercase ''%%<WRAP>%%''s | |
| |**''hide''** | hides the text per CSS (the text will still appear in the source code, in non-modern browsers and is searchable) | | |**''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]] | | |**''noprint''** | displays text on the screen, but not in print, similar to [[http://www.dokuwiki.org/plugin:noprint]] | |
| |**''onlyprint''** | displays text only in print, but not on the screen | | |**''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]] | | |**''pagebreak''** | forces a new page in printouts (not visible on the screen), similar to [[http://www.dokuwiki.org/plugin:pagebreak]] | |
| |**''nopagebreak''** | tries to avoid a pagebreak in printouts (not visible on the screen) | | |**''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 [[http://www.dokuwiki.org/plugin:hide]] | | |**''spoiler''** | shows white text on a white background, only to be revealed by highlighting it; similar to [[http://www.dokuwiki.org/plugin:hide]] | |
| |**''indent''** | indents the text, could be used instead of [[tab]] | | |**''indent''** | indents the text, could be used instead of [[http://www.dokuwiki.org/plugin:tab]] | |
| |**''outdent''** | "outdents" the text, could partly be used instead of [[outdent]] | | |**''outdent''** | "outdents" the text, could partly be used instead of [[http://www.dokuwiki.org/plugin:outdent]] | |
| |**''prewrap''** | wraps text inside pre-formatted code blocks, similar to [[wpre]] | | |**''prewrap''** | wraps text inside pre-formatted code blocks, similar to [[http://www.dokuwiki.org/plugin:wpre]] | |
| |
| All tables inside a column or box will always be 100% wide. This makes positioning and sizing tables possible and partly replaces [[http://www.dokuwiki.org/plugin:tablewidth]]. | All tables inside a column or box will always be 100% wide. This makes positioning and sizing tables possible and partly replaces [[http://www.dokuwiki.org/plugin:tablewidth|pagewidth]]. |
| |
| === Known restrictions === | === Known restrictions === |
| ===== Credits ===== | ===== Credits ===== |
| |
| * The code reuses parts of the [[box]] plugin. Thanks to [[chris@jalakai.co.uk|Christopher Smith]]. | * The code reuses parts of the [[http://www.dokuwiki.org/plugin:box]] plugin. Thanks to [[chris@jalakai.co.uk|Christopher Smith]]. |
| * The images for the notes are taken from the [[http://schollidesign.deviantart.com/art/Human-O2-Iconset-105344123|Human-O2 icon set]]. | * The images for the notes are taken from the [[http://schollidesign.deviantart.com/art/Human-O2-Iconset-105344123|Human-O2 icon set]]. |
| * Thanks to [[andi@splitbrain.org|Andreas Gohr]] for starting the toolbar picker. | * Thanks to [[andi@splitbrain.org|Andreas Gohr]] for starting the toolbar picker. |
| - chris | - chris |
| |
| > Yes, I thought about that, too. But as the [[plugin:blockquote]] plugin would be semantically much more correct, I recommend using that instead. --- //[[anika@selfthinker.org|Anika Henke]] 2009/09/18 00:37// | > Yes, I thought about that, too. But as the [[http://www.dokuwiki.org/plugin:blockquote]] plugin would be semantically much more correct, I recommend using that instead. --- //[[anika@selfthinker.org|Anika Henke]] 2009/09/18 00:37// |
| |
| |
| The result is the text of the info note is centered. If I use leftalign it aligns the whole box left. How do I get the box text to be left aligned and screen centered? peterennis [at] yahoo [dot] com | The result is the text of the info note is centered. If I use leftalign it aligns the whole box left. How do I get the box text to be left aligned and screen centered? peterennis [at] yahoo [dot] com |
| |
| > To position something you shouldn't use an alignment class, but one of the column classes. In this case it's "**center**" instead of "centeralign". (And whenever you use "center" you should also give a width.) If you only want the info box to be centred, you can use ''%%<WRAP center info 60%>%%'', and the image could be centred by using the normal [[:syntax#images_and_other_files|DokuWiki syntax]]. --- //[[anika@selfthinker.org|Anika Henke]] 2009/10/07 07:47// | > To position something you shouldn't use an alignment class, but one of the column classes. In this case it's "**center**" instead of "centeralign". (And whenever you use "center" you should also give a width.) If you only want the info box to be centred, you can use ''%%<WRAP center info 60%>%%'', and the image could be centred by using the normal [[:wiki:syntax#images_and_other_files|DokuWiki syntax]]. --- //[[anika@selfthinker.org|Anika Henke]] 2009/10/07 07:47// |
| |
| |
| Is there a way to make the emulated headlines contain "a name=..." anchors, similar to how the regular headlines have such anchors? | Is there a way to make the emulated headlines contain "a name=..." anchors, similar to how the regular headlines have such anchors? |
| |
| > No, this is currently not possible and is also not planned. As a work-around you can use the [[bookmark]] plugin. --- //[[anika@selfthinker.org|Anika Henke]] 2010/01/31 15:34// | > No, this is currently not possible and is also not planned. As a work-around you can use the [[http://www.dokuwiki.org/plugin:bookmark]] plugin. --- //[[anika@selfthinker.org|Anika Henke]] 2010/01/31 15:34// |
| |
| |