用户工具

站点工具


02-工程实践:cms:dokuwiki:wrap语法手册_en

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. <WRAP classes width :language> "big" content </WRAP> or <block classes width :language> "big" content </block> or <div classes width :language> "big" content </div> A lowercase **** (or alternatively **** or ****) creates a **''span''** and should be used for **"small"** containers, **inside** paragraphs, lists, tables, etc. <wrap classes width :language>"small" content</wrap> or <inline classes width :language>"small" content</inline> or <span classes width :language>"small" content</span> :!: 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. ===== Classes and Styles ===== ==== Columns and Floats ==== You can have columns easily by adding the class ''column'' and a width, e.g. <WRAP column 30%>...content...</WRAP> <WRAP column 30%> //**__Emulated Big Headline__**// You can emulate a big headline with italic, bold and underlined text, e.g. <code>//**__Emulated Big Headline__**//</code> //**Emulated Small Headline**// A smaller headline uses no underlining, e.g. <code>//**Emulated Small Headline**//</code> If you need text that is bold and italic, simply use it the other way around: <code>**//No Headline//**</code> </WRAP> <WRAP column 30%> //**__Different 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 </WRAP> <WRAP column 30%> //**__Widths__**// You can set any valid widths (but only on divs): ''%, px, em, ex, pt, pc, cm, mm, in'', but most of the time you'd only want either ^type^e.g.^note^ ^''%''|''30%''|makes sense in a liquid layout| ^''px''|''420px''|makes sense if your layout has a fixed pixel width or 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 or if your layout is em-based| A **table** inside a column or box will always be **100% wide**. This makes positioning and sizing tables possible. </WRAP> <wrap em>After using any of the float classes, you might come across something like this, where the following text protrudes into the space where only the floating containers should be ...</wrap> <WRAP clear></WRAP> ... to prevent that, you should simply add <WRAP clear></WRAP> after your last column. 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: Widths can cause problems and will often look different and break in some browsers. If you're not a web developer, you might not understand any problems regarding the [[http://en.wikipedia.org/wiki/Internet_Explorer_box_model_bug|box model]]. Just try to test your columns in all major browsers and make your widths smaller than you initially think they should be. All of those options will also work in the [[#boxes and notes]] wraps (see below). === Multi-columns === <WRAP col3> For modern browsers (Firefox, Chrome and Safari) you can use multi-columns. Just use **''col2''** for 2 columns, **''col3''** for 3 columns, **''col4''** for 4 columns and **''col5''** for 5 columns. :!: Note: Multi-columns don't make sense for spans. </WRAP> ==== Alignments ==== You can use these different text alignments: * ''leftalign'' * ''rightalign'' * ''centeralign'' * ''justify'' <WRAP centeralign> Center aligned text ... </WRAP> <WRAP rightalign> ... and right aligned. </WRAP> <code> <WRAP centeralign> Center aligned text ... </WRAP> <WRAP rightalign> ... and right aligned. </WRAP> </code> :!: You cannot add alignments to spans. ==== Boxes and Notes ==== <WRAP round box 570px center> //**__round box 570px center__**// * ''box'' creates a box around the container and uses the colours from the template's ''style.ini'' as default colours (''backgroundalt%% 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 Internet Explorer) </WRAP>

Info

<WRAP info></WRAP>

Tip

<WRAP tip></WRAP>

Important

<WRAP important></WRAP>

Alert

<WRAP alert></WRAP>

Help

<WRAP round help></WRAP>

Download

<WRAP download></WRAP>

Todo

<WRAP todo></WRAP>

Safety Notes:

Danger

<WRAP danger></WRAP>

Warning

<WRAP warning></WRAP>

Caution

<WRAP caution></WRAP>

Notice

<WRAP round notice></WRAP>

Safety

<WRAP round safety></WRAP>

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.

Miscellaneous

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.
<code>
Inside this code block the words will wrap to a new line although they are all in one line.
</code>
</WRAP>

Spoiler

Here follows a spoiler: Darth Vader is Luke's father.

Here follows a spoiler: <wrap spoiler>Darth Vader is Luke's father.</wrap>

Just select the text in the spoiler box to be able to read its content.

Hide

The following text is hidden: John, please revise that sentence.

The following text is hidden: <wrap hide>John, please revise that sentence.</wrap>

⚠ 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: <WRAP pagebreak></WRAP>

This has no effect on the browser screen. A 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: <WRAP nopagebreak>much content, belonging together (like a long table)</WRAP>

This also has no effect on the browser screen. It will try to avoid a page break in printouts.

Noprint

This text appears on the screen, but not in print.

<wrap noprint>This text appears on the screen, but not in print.</wrap>

Onlyprint

This text does not appear on the screen, but only in print.

<wrap onlyprint>This text does not appear on the screen, but only in print.</wrap>

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 emphasized and highlighted with a nested notice inside.

Text inside outer right box, but beneath inner left box.

Round tip box underneath, after a clear.

<WRAP box 350px right :en>
//**__Outer box floats right__**//

<WRAP 165px left>
Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with a nested <wrap notice>__notice__</wrap> inside</wrap>.
</WRAP>

Text inside outer right box, but beneath inner left box.

<WRAP clear></WRAP>

<WRAP round tip>
Round tip box underneath, after a ''clear''.
</WRAP>

</WRAP>

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:

<WRAP :he>
זה עברית. ((<wrap :en>This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].</wrap>))
</WRAP>

זה עברית. 1)

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.)

其他语言

其他语言中文简体
1)
This means “This is Hebrew.”, at least according to Google Translate.
02-工程实践/cms/dokuwiki/wrap语法手册_en.txt · 最后更改: 2020/04/07 06:34 由 annhe