Benutzer-Werkzeuge

Webseiten-Werkzeuge


wiki:syntax-addon

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

wiki:syntax-addon [2020/06/07 13:55] (aktuell)
Zeile 1: Zeile 1:
 +====== Syntax AddOn's ======
 +
 +===== Rechte für den Upload von Bildern =====
 +Derzeit gibt es nur drei Gruppen von Benutzern. Mehr war (bisher) noch nicht notwendig. 
 +
 +  * **Gäste**: Können alle Seiten besuchen und lesen, aber keine Änderungen vornehmen.
 +
 +  * **User**: Wenn sich jemand registriert hat, so hat er die Möglichkeit Texte zu verändern, neue Seiten anzulegen bzw. zu löschen. Der Upload von Bildern oder anderen Dateien ist nicht möglih.
 +
 +  * **Admin**: Kann alles, Seiten/Artikel editieren und Bilder sowie anderen Dateien hochladen.
 +
 +----
 +
 +===== color syntax plugin =====
 +Möglichkeit 1: Ihr verwendet das Icon am oberen Rand des Eingabefeldes oder \\
 +Möglichkeit 2: Ihr verwendet nachfolgende Syntax:
 +<code>
 +<color green>text</color
 +<color blue/lightgrey>text</color>
 +<color #FF0000>tex</color>
 +<color /#FFff00>text</color>
 +<color rgb(80%,0%,0%)/rgb(100%,80%,100%)>text</color>
 +<color hsl(120,100%,30%)/hsl(180,50%,90%)>text</color>
 +</code>
 +
 +----
 +
 +===== spoiler plugin =====
 +Ermöglicht es Inhalte in einem Spoiler zu verstecken. 
 +<code>
 +<spoiler> Inhalte </spoiler>
 +</code>
 +
 +----
 +
 +===== rss =====
 +Ermöglicht das einbinden von RSS-Feeds anderer Seiten.
 +<code>
 +<rss feed="your-link-to-feed" />
 +</code>
 +
 +----
 +
 +===== NavBox Plugin =====
 +Ermöglicht das erstellen einer NavBox im Stil von Wikipedia. 
 +
 +==== Basic Tags ====
 +^ Syntax Tag  ^ Example Usage  ^ Result  |
 +^  <code><navbox></code>  |   | Initiates the NavBox Container.  |
 +^  <code>#</code>  | <code># My NavBox</code>  | Sets the title of the NavBox, at the top.  |
 +^  <code>##</code>  | <code>## Group 1 Title</code>  | Sets the title of a group of links, in the left column.  |
 +^  <code>###</code>  | <code>### SubGroup A Title</code>or<code>### !ns</code> | Sets the title of a subgroup. \\ **Note:** This must follow either a Group Title Tag (##) or a list of links and must also have a list of links following (or one of the [[#Advanced Tags]]), otherwise it will not form a proper group.  |
 +^  <code>[[links]]</code>  | <code>[[link1|Links]][[another|More]]</code>  | A list of links, which can be simply listed one after the other (as per example), or separated by <code>,</code> or <code>;</code>  |
 +^  <code></navbox></code>  | | The closing tag for the container.  |
 +
 +=== Example of Basic NavBox ===
 +^ Code Sample  ^ Output  |
 +| <code>
 +<navbox>
 +# Animals
 +## Birds
 +### Carnivorous Birds
 +[[falcon]],[[eagle]],[[vulture]]
 +### Little Birds
 +[[hummingbird]],[[canary]]
 +</navbox>
 +</code> | {{https://i.imgur.com/H1Q6qjV.png}} |
 +
 +==== Advanced Tags ====
 +Using an advanced tag will create it's own Group (equivalent of the ## tag) unless it is specified as a Sub Group (preceeded by the ### tag). It will close the previously created group, and after the Advanced Tag a new group will need to be created for further links.
 +
 +Example:
 +<code>
 +<navbox>
 +# Title
 +## Group 1
 +[[some links]]
 +!ns                <<< This creates a new Group
 +## Group 3
 +### SubGroup 1
 +[[sub links]]
 +### !ns            <<< This creates a Sub Group inside Group 3 after SubGroup 1
 +</navbox>
 +</code>
 +=== Namespace Tag (!ns) ===
 +Creates a list of links in the current namespace, automatically creates the group name based on the lowest level of the current namespace. For example, if you are building the NavBox on animals:birds:carnivorous:start it will name the group "Carnivorous". There are various modifiers that can be used below.
 +^ Modifier  ^ Example  ^ Result  |
 +^  <code>###</code>  |  <code>### !ns</code>  | This is combined with the Sub Group tag, which indicates that the listing should be contained in the previously created group. This can be combined with the below modifiers as well. |
 +^  <code>+n</code>  |  <code>!ns+n [[other:namespace]]</code> | This will force the plugin to list all pages contained in the specified namespace. |
 +^  <code>+t</code>  |  <code>!ns+t Different Title</code> | This will override the automatically created title (or subgroup title) for the listing. |
 +^  <code>+nt</code>  |  <code>!ns+nt [[other:namespace|Custom Title]]</code> | Performs both actions of the +n and +t modifiers. |
 +
 +----
 +
 +===== WRAP-Plugin-Syntax =====
 +
 +Basic Syntax:
 +  <WRAP classes #id width :language>
 +  "big" content
 +  </WRAP>
 +  
 +  **or**
 +  <block classes #id width :language>
 +  "big" content
 +  </block>
 +  
 +  or
 +  <div classes #id width :language>
 +  "big" content
 +  </div>
 +An uppercase **%%<WRAP>%%** (or alternatively **%%<block>%%** or **%%<div>%%**) creates a **''div''** and should be used for **"big"** containers, **surrounding** paragraphs, lists, tables, etc.
 +  
 +  <wrap classes #id width :language>"small" content</wrap>
 +  
 +  or
 +  <inline classes #id width :language>"small" content</inline>
 +  
 +  or
 +  <span classes #id width :language>"small" content</span>
 +A lowercase **%%<wrap>%%** (or alternatively **%%<inline>%%** or **%%<span>%%**) creates a **''span''** and should be used for **"small"** containers, **inside** paragraphs, lists, tables, etc.
 +
 +Since version 2013-06-13 there is also a shorthand syntax (for wraps without content):
 +
 +  <WRAP classes #id /> or <block classes #id /> or <div classes #id />
 +
 +and
 +
 +  <wrap classes #id /> or <inline classes #id /> or <span classes #id />
 +
 +:!: Please note, some things **won't work with spans**: **alignments** (including alignments generated by changing the text direction), **multi-columns** and **widths** if the according wrap isn't floated as well.
 +
 +==== Examples ====
 +
 +The plugin comes with an example page, which should explain a lot and looks like this in the default template (see below).
 +
 +==== Classes ====
 +
 +The following classes are currently available:
 +
 +{{ :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 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>%%'' |
 +| **''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 ===
 +
 +  * WRAPs export to ODT format but not everything works 100%
 +  * Round corners only work in modern browsers (no IE8 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).
 +  * 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.)
 +    * %%//**Small Headline**//%%
 +
 +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]].
 +
 +The classes are easily adjustable and extensible. Any wishes are welcome.
 +
 +==== Widths ====
 +
 +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>...
 +All except percentages will be reduced to have the maximum width available on smaller screens.
 +
 +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 half column>...</WRAP>
 +    <WRAP half column>...</WRAP>
 +  </WRAP>
 +will result in two columns next to each other, which will wrap underneath each other on smaller screens and mobile devices.
 +
 +==== Languages and Text Directions ====
 +
 +You can change the language and the direction of a container by simply adding a colon followed by the language code, like this:
 +
 +  <wrap :en>This text is explicitly marked as English.</wrap>
 +
 +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 like to mark a text with a different text direction than the default one, you should use divs, i.e. uppercase ''%%<WRAP>%%''s. Otherwise the text alignment won't change as well.
 +
 +This makes it a better replacement of [[ltr]] (and [[lang]]).
 +
 +===== Demo =====
 +
 +You can see a demo of the plugin on [[http://demo.selfthinker.org/plugin:wrap|demo.selfthinker.org]].
 +
 +[[https://yadi.sk/i/ycbENWFjWEduTA|“Examples” (demo) in Russian]] (for v2011-05-15). [[http://pastebin.com/C9xjaEH9|Source]].
 +
 +==== Configuration options ====
 +
 +^ Option  ^ Description  ^ Default value ^
 +|''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 (* and ? wildcards allowed) | //(empty)// |
 +|''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) |
 +|''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 |
 +|''emulatedHeadlines''  | Use emulated headings? (deprecated) | 0 |
 +
 +==== Toolbar picker ====
 +
 +{{ :plugin:wrap_plugin_toolbar_picker.png?nolink}}
 +
 +The wrap picker in the editing toolbar adds the most common wrap syntaxes.
 +
 +  * "columns" creates a set of half columns
 +  * "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)
 +  * "clear floats" creates a ''%%<WRAP clear/>%%''
 +  * "especially emphasised, highlighted, less significant" creates the respective marks
 +
  
/var/www/virtual/ed-wiki.tk/htdocs/data/pages/wiki/syntax-addon.txt · Zuletzt geändert: 2020/06/07 13:55 (Externe Bearbeitung)