The source lives here https://github.com/selfthinker/dokuwiki_plugin_wrap/blob/master/example.txt ====== Examples for the Wrap Plugin ====== ===== Basic syntax ===== An uppercase **%%%%** (or alternatively **%%%%** or **%%
%%**) creates a **''div''** and should be used for **"big"** containers, **surrounding** paragraphs, lists, tables, etc. "big" content or "big" content or
"big" content
A lowercase **%%%%** (or alternatively **%%%%** or **%%%%**) creates a **''span''** and should be used for **"small"** containers, **inside** paragraphs, lists, tables, etc. "small" content or "small" content or "small" content :!: Please note, some things **won't work with lowercase spans**: * **alignments** (including alignments generated by changing the text direction) * **multi-columns** * and **widths** if the according wrap isn't floated as well. A shorthand of uppercase **%%%%** and lowercase **%%%%** are available if the container is empty or unnecessary. or or
and or or ===== Classes and Styles ===== ==== Columns and Floats ==== You can have columns easily by adding the class ''column'' and a width, e.g. ...content... The example below uses the following structure: ...content... ...content... ...content... === Floating Options === Normally you would only need the class ''column'', but for more sophisticated uses (not only for columns, but for any other classes, like [[#boxes and notes]] as well) you can have several kinds of "floats": * **''column''** is the same as ''left'' in LTR languages and the same as ''right'' in RTL languages * **''left''** will let you float your wrap on the left * **''right''** will let the wrap float right * **''center''** will position the wrap in the horizontal center of the page === Widths === You can set any valid widths (but only on divs): ''%, px, em, rem, ex, ch, vw, vh, pt, pc, cm, mm, in'', but most of the time you'd only want either ^type^e.g.^note^ ^''%''|''30%''|makes sense in most cases| ^''px''|''420px''|makes sense if your container contains images with a certain width| ^''em''|''20em''|makes sense if you like your wrap container to grow and shrink with the font size| === Width Keywords === With certain width keywords you can fit your columns automatically to fill the available horizontal space. Those columns will also react to the screen size, so will be responsive and wrap underneath each other on mobile devices. There are four width keywords. These should not be combined with any other width, only ''third'' can be combined with ''twothirds''. * **''half''** fits two columns in a row * **''third''** fits three columns in a row * **''quarter''** fits four columns in a row * **''twothirds''** together with ''third'' fits a 2/3 and a 1/3 column in a row :!: Attention: In order to work properly, wraps with width keywords need an **additional ''%%%%'' around a set** of them. If you mix several types in one group, you might need a ''%%%%'' after a row. You can use the same options with spans (as each element that floats is automatically a block level element), but it probably doesn't make too much sense. :!: Widths on spans normally do not work (by design), but can make sense, when it is floating. :!: Attention: What is the difference between widths and width keywords and when is it best to use which? **Widths** can cause problems and will never fully add up, therefore will break the layout under some circumstances. (See [[http://en.wikipedia.org/wiki/Internet_Explorer_box_model_bug|box model]] for a technical explanation.) So, getting widths right will need some fiddling around and testing in various browsers. **Width keywords** on the other hand fit automatically and work better on mobile devices. But the drawback is that they need an extra wrap around them and don't work properly in older browsers (IE8 and under). All of those options will also work in the [[#boxes and notes]] wraps (see below). === Old Emulated Headline (deprecated) === When the ''emulatedHeadlines'' config option is enabled, every ''%%//**__text like this__**//%%'' or ''%%//**like that**//%%'' will create an "emulated headline" within a wrap. This feature is deprecated and will be removed at some point as standard headlines within wraps are supported for a while now. If that config options is enabled and you need text that is bold and italic, simply use it the other way around: ''%%**//No Headline//**%%''. === Multi-columns === Multi-columns work best in modern browsers (no IE9 and below) but should still be considered experimental as some browser behaviour is still inconsistent and buggy. Just use **''%%colsmall%%''** for small width columns, **''%%colmedium%%''** for medium width columns and **''%%collarge%%''** for large width columns. Or you can use **''%%col2%%''** for 2 columns, **''%%col3%%''** for 3 columns, **''%%col4%%''** for 4 columns and **''%%col5%%''** for 5 columns. The former type of column is determined by its width, the latter by its amount. The width-based columns are ideal for different layouts and device widths. :!: Note: Multi-columns don't make sense for spans. Don't use this for bigger columns containing more than just text. Use the [[#columns and floats]] mentioned above instead. ==== Alignments ==== You can use these different text alignments: * ''leftalign'' * ''rightalign'' * ''centeralign'' * ''justify'' Center aligned text ... ... and right aligned. Center aligned text ... ... and right aligned. :!: You cannot add alignments to spans. ==== Boxes and Notes ==== === round box 500px center === * ''box'' creates a box around the container and uses the colours from the template's ''style.ini'' as default colours (''%%__background_alt__%%'' and ''%%__text__%%'') * any of the classes ''info'', ''tip'', ''important'', ''alert'', ''help'', ''download'', ''todo'' will add a special note container with a corresponding icon * the classes ''danger'', ''warning'', ''caution'', ''notice'', ''safety'' use safety colours (and no icons) * ''round'' can be added to anything with a background colour or a border and will only work in modern browsers (no IE8 and under) === Info === %%%% === Tip === %%%% === Important === %%%% === Alert === %%%% === Help === %%%% === Download === %%%% === Todo === %%%% **Safety Notes:** Best only use simple markup in safety notes. === Danger === %%%% === Warning === %%%% === Caution === %%%% === Notice === %%%% === Safety === %%%% You can use notes and boxes also inside text with spans like this: info, help, alert, important, tip, download, todo and round box and danger, warning, caution, notice, safety. info, help, ... ==== Marks ==== You can mark text as highlighted, less significant and especially emphasised. You can mark text as highlighted, less significant and especially emphasised. :!: This might look ugly in some templates and should be adjusted accordingly. ==== Tabs ==== You can create a row of tabs by simply wrapping a list of links in ''%%%%''. * [[Some page]] * [[example|This page]] * [[Another page]] * [[Some page]] * [[example|This page]] * [[Another page]] :!: Please note, the styling of these tabs depend on the template you are using and not on the wrap plugin. If you only see a list of links and no tabs, please make sure to add "tabs" to the ''noPrefix'' config option and that your template supports at least the 2012-01-25 "Angua" DokuWiki release. ==== Miscellaneous ==== === Clear float === After using any of the float classes, you might come across following text protruding into the space where only the floating containers should be. To prevent that, you should simply add this after your last column: === Table width === You can set the width of a table via ''tablewidth'' as every table inside that wrap will always be 100% wide. This makes it possible to give tables any width by adding an additional width to the wrap (or none for 100%). ^ Table ^ is ^ | 80% | wide | ^ Table ^ is ^ | 80% | wide | === Indent === This text will appear indented. This text will appear indented. === Outdent === This text will appear "outdented". This text will appear "outdented". === Prewrap === Inside this code block the words will wrap to a new line although they are all in one line. Inside this code block the words will wrap to a new line although they are all in one line. === Spoiler === Here follows a spoiler: Darth Vader is Luke's father. Here follows a spoiler: Darth Vader is Luke's father. Just select the text in the spoiler box to be able to read its content. === Button links === A link that looks like a button: [[wiki:Syntax]] A link that looks like a button: [[wiki:Syntax]] === Hide === The following text is hidden: John, please revise that sentence. The following text is hidden: John, please revise that sentence. :!: Warning: The text will still appear in the source code, in non-modern browsers and is searchable. Do not hide any security risky secrets with it! === Pagebreak === The following will add a pagebreak: The following will add a pagebreak: This has no effect on the browser screen. A [[http://reference.sitepoint.com/css/page-break-after|pagebreak]] will force a new page in printouts. === Nopagebreak === The following will try to avoid a pagebreak: much content, belonging together (like a long table) The following will try to avoid a pagebreak: much content, belonging together (like a long table) This also has no effect on the browser screen. It will try to [[http://reference.sitepoint.com/css/page-break-inside|avoid a page break]] in printouts. === Noprint === This text appears on the screen, but not in print. This text appears on the screen, but not in print. === Onlyprint === This text does not appear on the screen, but only in print. This text does not appear on the screen, but only in print. ==== Combining and Nesting ==== You can combine and nest all classes and types of boxes, e.g. ===Outer box floats right === Inner nested box floats left and is partly __em__phasized and __hi__ghlighted with a nested __notice__ inside. Text inside outer right box, but beneath inner left box. Round tip box underneath, after a ''clear''. === Outer box floats right === Inner nested box floats left and is partly __em__phasized and __hi__ghlighted with a nested __notice__ inside. Text inside outer right box, but beneath inner left box. Round tip box underneath, after a ''clear''. ===== Language and Text Direction ===== You can change the language and the reading direction of a wrap container by simply adding a colon followed by the language code, like this: זה עברית. ((This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].)) זה עברית. ((This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].)) The text direction (''rtl'', right to left or ''ltr'', left to right) will get inserted automatically and is solely dependent on the language. The list of currently supported languages is taken from: http://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code (If you specify a language not listed there, it simply won't do anything.)