사용자 도구

사이트 도구


wiki:plugins

차이

문서의 선택한 두 판 사이의 차이를 보여줍니다.

차이 보기로 링크

양쪽 이전 판이전 판
다음 판
이전 판
wiki:plugins [2023/09/22 07:46] zasfewiki:plugins [2025/10/22 05:14] (현재) – [Mermaid Plugin] zasfe
줄 1: 줄 1:
 ====== plugins ====== ====== plugins ======
  
 +===== incloud plugin Syntax =====
  
 +
 +''%%{{page>wiki:syntax#Tables}}%%'' will include the section about tables of the syntax page.
 +
 +''%%{{namespace>project_foo}}%%'' will include all pages in the ''project_foo'' namespace.
 +
 +''%%{{page>blog:mypage&tags&comments}}%%'' will include the page ''blog:mypage'' and show the tags from the [[tag]] plugin and the number of comments from the [[discussion]] plugin. Both plugins need to be installed for this example.
 +
 +''%%{{tagtopic>testtag}}%%'' will include all pages with the tag ''testtag'', the [[tag]] plugin needs to be installed for this example.
 +
 +===== Syntax =====
 +
 +The plugin offers four syntaxes, ''%%{{page>...}}%%'' , ''%%{{section>...}}%%'' , ''%%{{namespace>...}}%%'' and ''%%{{tagtopic>...}}%%''.
 +
 +Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces. Tagtopic includes all pages with a ''tagtopic'' ''tag''.
 +
 +  {{page>[id]&[flags]}}
 +  {{section>[id]#[section]&[flags]}}
 +  {{namespace>[namespace]#[section]&[flags]}}
 +  {{tagtopic>[tag]&[flags]}}
 +
 +^ [id] | page ID of the page to include; some [[#macros]] are possible; shortcuts are resolved ('':'', ''.'', ''..'') | required |
 +^ [section] | limits the included page to a specific section and its subsections | optional; default is the whole page , this can be used with namespace (if matches)|
 +^ [tag]|include pages with tag topic tag, requires [[plugin:tag]] |required |
 +^ [flags] | flags delimited by ''&'', see [[#Configuration and Flags|flags]] | optional |
 +
 +
 +===== Configuration and Flags =====
 +
 +The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the [[plugin:blog]] plugin which uses the include plugin to generate the blog page. For most settings there are flags that allow to override the setting. Some features are only available as flag.
 +
 +^ Configuration option  ^ Flags                                                            ^ Description                                                                                                                                                                                                                                                                                                                                                                      ^
 +^ ''noheader''          | ''noheader''/ (''show'')''header''                               | Don't display the header of the inserted section                                                                                                                                                                                                                                                                                                                                 |
 +^ ''firstseconly''      | ''firstsec''(''tion'')''only''/ ''fullpage''                     | Display only the first section of the included page                                                                                                                                                                                                                                                                                                                              |
 +^ ''readmore''          | ''readmore''/''noreadmore''                                      | Show "read more" link in case of firstsection only                                                                                                                                                                                                                                                                                                                               |
 +^ ''showtaglogos''      | -                                                                | Show/hide an image for the first tag (if the page has tags)                                                                                                                                                                                                                                                                                                                      |
 +^ ''showfooter''        | ''footer''/''nofooter''                                          | Show/hide page footer below the included page                                                                                                                                                                                                                                                                                                                                    |
 +^ ''showlink''          | ''link''/''nolink''                                              | Makes the first headline of a included page/section a link to the included page/section                                                                                                                                                                                                                                                                                          |
 +^ ''showpermalink''     | ''permalink''/ ''nopermalink''                                   | Show/hide a permalink to the included page in the page footer                                                                                                                                                                                                                                                                                                                    |
 +^ ''showdate''          | ''date''/''nodate''                                              | Show/hide creation date of the page in the page footer                                                                                                                                                                                                                                                                                                                           |
 +^ ''showmdate''         | ''mdate''/''nomdate''                                            | Show/hide modification date of the page in the page footer                                                                                                                                                                                                                                                                                                                       |
 +^ ''showuser''          | ''user''/''nouser''                                              | Show/hide user name of the page creator in the page footer                                                                                                                                                                                                                                                                                                                       |
 +^ ''showcomments''      | ''comments''/''nocomments''                                      | Show/hide number of comments in the page footer (requires the [[plugin:discussion]] plugin)                                                                                                                                                                                                                                                                                      |
 +^ ''showlinkbacks''     | ''linkbacks''/''nolinkbacks''                                    | Show/hide number of linkbacks in the page footer (requires the [[plugin:linkback|linkback]] or [[plugin:backlinks]] plugin)                                                                                                                                                                                                                                                     |
 +^ ''showtags''          | ''tags''/''notags''                                              | Show/hide tags in the page footer (requires the [[plugin:tag]] plugin)                                                                                                                                                                                                                                                                                                           |
 +^ ''showeditbtn''       | ''editbtn'' or ''editbutton''/''noeditbtn'' or ''noeditbutton''  | Show/hide edit buttons (section edit buttons, edit button below the included page)                                                                                                                                                                                                                                                                                               |
 +^ ''doredirect''        | ''redirect''/''noredirect''                                      | Redirect back to original page after an edit                                                                                                                                                                                                                                                                                                                                     |
 +^ ''usernamespace''     | -                                                                | Namespace for user pages (see ''showuser'' configuration) (default ''user''                                                                                                                                                                                                                                                                                                    |
 +^ ''doindent''          | ''indent''/''noindent''                                          | Indent included pages relative to the section of the page they get included in                                                                                                                                                                                                                                                                                                   |
 +^ ''linkonly''          | ''linkonly''/''nolinkonly'' or ''include_content''               | Display only a link instead of the whole page content                                                                                                                                                                                                                                                                                                                            |
 +^ '' title''            | ''title''/''notitle''                                            | Show the title instead of the page id                                                                                                                                                                                                                                                                                                                                            |
 +^ ''pageexists''        | ''pageexists''/ ''nopageexists''                                 | Only list page ids of existing pages (see ''existlink''                                                                                                                                                                                                                                                                                                                        |
 +^ -                     | ''existlink''                                                    | Display a link and do so only if page page-id exists (combination of ''linkonly'' and ''pageexists''                                                                                                                                                                                                                                                                           |
 +^ ''parlink''           | ''parlink''/''noparlink''                                        | (Don't) put the link into a paragraph environment (for inline lists)                                                                                                                                                                                                                                                                                                             |
 +^ ''order''             | ''order=OPTION''                                                 | Ordering criteria for namespace includes, possible options: page ID (''id''), title (''title''), date created (''created''), date modified (''modified''), [[plugin:indexmenu#metadata_tag_syntax|indexmenu sort order]] (''indexmenu''), custom sort order using the ''%%{{include_n>[number]}}%%'' on the pages that are included similar to the indexmenu tags (''custom'').  |
 +^ ''rsort''             | ''rsort''/''sort''                                               | Reverse the sort order in namespace includes.                                                                                                                                                                                                                                                                                                                                    |
 +^ ''depth''             | ''depth=DEPTH''                                                  | The maximum depth of subnamespaces of which pages are included in namespace includes, default is ''1'' for only the specified namespace, ''0'' is for unlimited depth.                                                                                                                                                                                                           |
 +^ -                     | ''inline''                                                       | Don't close/open sections when including a page. This flag should be used when the include syntax is used inside other syntax elements like lists or tables or inside other plugin syntax.                                                                                                                                                                                       |
 +^ -                     | ''beforeeach=ENTITY''/ ''aftereach=ENTITY''                      | Display an [[:entities|entity]] before/after each included page. The entity is printed outside the section/include environment, this is mainly for adding custom HTML code (when the text isn't recognized as entity it is directly displayed but escaped so you can't directly use HTML code here).                                                                             |
 +^ ''safeindex''         | -                                                                | Don't index metadata of included pages that are non-public. This can cause problems with other plugins that use the metadata index and can be safely disabled in wikis where the permissions of the included pages match the permissions of the parent pages.                                                                                                                    |
 +^ -                     | ''exclude=/REGEX/''                                              | Regular expression to exclude certain pages, will match on full page ID. E.g. to exclude ''ns:page_name'' use ''/ns:page_name/'' as value. Use a [[https://regex101.com/|regex tester]] to debug complicated patterns.                                                                                                                                                           |
 +
 +
 +Examples:
 +
 +  {{page>concept&firstseconly&footer}}
 +  {{page>mypage&noindent}}
 +  {{namespace>myns&order=modified}}
 +  {{namespace>myns&exclude=/myns:subns:.+|myns:page/}}
 +
 +
 +===== Macros =====
 +
 +Simple macros are possible to serve a page on a per user or per date base. These are:
 +
 +^ @USER@  | username |
 +^ @NAME@  | full name of user |
 +^ @GROUP@ | first group the user belongs to |
 +^ @YEAR@  | 4-digit year |
 +^ @MONTH@ | 2-digit month |
 +^@WEEK@ |2-digit ISO week number |
 +^ @DAY@   | 2-digit day |
 +^ @DATE<expr>@ | use a calculated date instead of today in date macros |
 +
 +<expr> in **''@DATE<expr>@''** can be one of:
 +
 +^ PYEAR | previous year |
 +^ NYEAR | next year |
 +^ PMONTH | previous month |
 +^ NMONTH | next month |
 +^ PWEEK | previous week |
 +^ NWEEK | next week |
 +^ YESTERDAY | yesterday's date |
 +^ TOMORROW | tomorrow's date |
 +
 +Examples:
 +
 +  {{page>@MONTH@:@DAY@:birthdays}}
 +includes the page ''birthdays'' in namespace <month>:<day>: eg. ''10:15: birthdays'' for the 15th of october.
 +
 +  {{page>@USER@:message}}
 +includes the page ''message'' from the namespace <user> of the logged in user
 +
 +  {{page>foo@DATENWEEK@@YEAR@:@WEEK@}}
 +includes the page <weekno> from the namespace ''foo<year>'' with next week's date  e.g.  foo2012:01 for the 27th of december 2011
  
  
줄 73: 줄 178:
  
 <code> <code>
-This is example text. +This is example text. ++++ Title |
- +
-++++ Title |+
  
  
줄 85: 줄 188:
 </code> </code>
  
-This is example text. +This is example text. ++++ Title |
- +
-++++ Title |+
  
  
줄 95: 줄 196:
  
 ++++ ++++
 +
 +This is example ++title| formatted text ++ text.
 + 
 +
  
 ^  ^ Inline ^ Block ^ ^  ^ Inline ^ Block ^
줄 198: 줄 303:
     * smartTabs: (Default true)     * smartTabs: (Default true)
     * tabSize: (Default 4)     * tabSize: (Default 4)
 +
 +<code>
 +<sxh php; highlight: [11-15]>
 +    /**
 +     * [Custom event handler which performs action]
 +     *
 +     * @param Doku_Event $event  event object by reference
 +     * @param mixed      $param  [the parameters passed as fifth argument to register_hook() when this
 +                               handler was registered]
 +     * @return void
 +     */
 +
 +    public function handle_metaheader(Doku_Event &$event, $param) {
 +        // Add SyntaxHighlighter theme.
 +        $event->data['link'][] = array('rel' => 'stylesheet',
 +            'type' => 'text/css',
 +            'href' => DOKU_BASE . 'lib/plugins/syntaxhighlighter4/dist/'.$this->getConf('theme'),
 +        );
 +
 +        // Register SyntaxHighlighter javascript.
 +        $event->data["script"][] = array("type" => "text/javascript",
 +            "src" => DOKU_BASE . "lib/plugins/syntaxhighlighter4/dist/syntaxhighlighter.js",
 +            "_data" => ""
 +        );
 +    }
 +</sxh>
 +</code>
 +
 +
 +<sxh php; highlight: [11-15]>
 +    /**
 +     * [Custom event handler which performs action]
 +     *
 +     * @param Doku_Event $event  event object by reference
 +     * @param mixed      $param  [the parameters passed as fifth argument to register_hook() when this
 +                               handler was registered]
 +     * @return void
 +     */
 +
 +    public function handle_metaheader(Doku_Event &$event, $param) {
 +        // Add SyntaxHighlighter theme.
 +        $event->data['link'][] = array('rel' => 'stylesheet',
 +            'type' => 'text/css',
 +            'href' => DOKU_BASE . 'lib/plugins/syntaxhighlighter4/dist/'.$this->getConf('theme'),
 +        );
 +
 +        // Register SyntaxHighlighter javascript.
 +        $event->data["script"][] = array("type" => "text/javascript",
 +            "src" => DOKU_BASE . "lib/plugins/syntaxhighlighter4/dist/syntaxhighlighter.js",
 +            "_data" => ""
 +        );
 +    }
 +</sxh>
 +
 +
  
  
줄 209: 줄 369:
  
  
-==== plantumlparser Plugin ====+===== plantumlparser Plugin ====
 + 
 + 
 +https://www.dokuwiki.org/plugin:plantumlparser
  
 <code> <code>
줄 230: 줄 393:
  
  
 +<code>
 +
 +<uml>
 +
 +
 +@startmindmap
 +caption figure 1
 +title My super title
 +
 +* <&flag>Debian
 +** <&globe>Ubuntu
 +*** Linux Mint
 +*** Kubuntu
 +*** Lubuntu
 +*** KDE Neon
 +** <&graph>LMDE
 +** <&pulse>SolydXK
 +** <&people>SteamOS
 +** <&star>Raspbian with a very long name
 +*** <s>Raspmbc</s> => OSMC
 +*** <s>Raspyfi</s> => Volumio
 +
 +header
 +My super header
 +endheader
 +
 +center footer My super footer
 +
 +legend right
 +  Short
 +  legend
 +endlegend
 +@endmindmap
 +</uml>
 +
 +</code>
 +
 +
 +<uml>
 +
 +
 +@startmindmap
 +caption figure 1
 +title My super title
 +
 +* <&flag>Debian
 +** <&globe>Ubuntu
 +*** Linux Mint
 +*** Kubuntu
 +*** Lubuntu
 +*** KDE Neon
 +** <&graph>LMDE
 +** <&pulse>SolydXK
 +** <&people>SteamOS
 +** <&star>Raspbian with a very long name
 +*** <s>Raspmbc</s> => OSMC
 +*** <s>Raspyfi</s> => Volumio
 +
 +header
 +My super header
 +endheader
 +
 +center footer My super footer
 +
 +legend right
 +  Short
 +  legend
 +endlegend
 +@endmindmap
 +</uml>
 +
 +
 +<code>
 +<uml>
 +@startmindmap
 ++ root
 +**:right_1.1
 +right_1.2;
 +++ right_2
 +
 +left side
 +
 +-- left_1
 +-- left_2
 +**:left_3.1
 +left_3.2;
 +@endmindmap
 +</uml>
 +</code>
 +
 +
 +<uml>
 +@startmindmap
 ++ root
 +**:right_1.1
 +right_1.2;
 +++ right_2
 +
 +left side
 +
 +-- left_1
 +-- left_2
 +**:left_3.1
 +left_3.2;
 +@endmindmap
 +</uml>
 +
 +
 +===== gh Plugin - Embed files from a GitHub repository =====
 +
 +<code>
 +{{gh>https://github.com/splitbrain/dokuwiki-plugin-gh/blob/master/syntax.php 5-10}}
 +</code>
 +
 +{{gh>https://github.com/splitbrain/dokuwiki-plugin-gh/blob/master/syntax.php 5-10}}
 +
 +위의 구문은 GitHub의 이 플러그인 저장소에서 파일의 5~10번째 줄을 임베드합니다 syntax.php. 줄 번호를 생략하여 전체 파일을 임베드할 수 있습니다.
 +
 +구문 강조는 파일 확장자에 따라 수행됩니다.
 +
 +<code>
 +{{gh>https://github.com/zasfe/Labs/blob/a52e6bec9ca6288455ae14c7bbe743295a3e74f9/tomcat/archive_tomcat_log.sh#L1-L17}}
 +</code>
 +
 +{{gh>https://github.com/zasfe/Labs/blob/a52e6bec9ca6288455ae14c7bbe743295a3e74f9/tomcat/archive_tomcat_log.sh#L1-L17}}
 +
 +===== TemplatePageName Plugin =====
 +
 +  * [[https://www.dokuwiki.org/plugin:templatepagename|TemplatePageName Plugin]]
 +    * https://www.dokuwiki.org/namespace_templates 기본 템플릿 기능을 개선하는 플러그
 +
 +이 플러그인은 네임스페이스 템플릿(스캐폴딩)의 이름을 변경하여 템플릿 사용을 개선합니다.
 +
 +위키 사용자는 일반 편집기를 통해 네임스페이스에 c_template 및 i_template 위키 페이지를 추가할 수 있습니다. DokuWiki는 이 페이지들을 새로 생성되는 페이지의 템플릿으로 사용합니다.
 +
 +DokuWiki는 기본적으로 템플릿 페이지 이름인 _template과 %%__template%%을 사용하지만, 이 플러그인은 이를 다음과 같이 변경합니다.
 +
 +  * c_template(현재 네임스페이스의 새 페이지에 대한 템플릿)
 +  * 및 i_template(상위 네임스페이스에서 상속된 템플릿)
 +
 +
 +**Replacement patterns**
 +
 +Inside of the file, you may also use some replacement patterns to make the template a little more dynamic.
 +
 +^ @ID@              | full ID of the page                                                                    |
 +^ @NS@              | namespace of the page                                                                  |
 +^ @CURNS@           | last part of the namespace of the page                                                 |
 +^ @!CURNS@          | same as above but with the first character uppercased                                  |
 +^ @!!CURNS@         | same as above but with the first character of all words uppercased                     |
 +^ @!CURNS!@         | same as above but with all characters uppercased                                       |
 +^ @PAGE@            | page name (ID without namespace and underscores replaced by spaces)                    |
 +^ @!PAGE@           | same as above but with the first character uppercased                                  |
 +^ @!!PAGE@          | same as above but with the first character of all words uppercased                     |
 +^ @!PAGE!@          | same as above but with all characters uppercased                                       |
 +^ @FILE@            | page name (ID without namespace, underscores kept as is)                               |
 +^ @!FILE@           | same as above but with the first character uppercased                                  |
 +^ @!FILE!@          | same as above but with all characters uppercased                                       |
 +^ @USER@            | ID of user who is creating the page                                                    |
 +^ @NAME@            | name of user who is creating the page                                                  |
 +^ @MAIL@            | mail address of user who is creating the page                                          |
 +^ @DATE@            | date and time when edit session started                                                |
 +^ %a %d-%m-%y etc.  | e.g. Thu 06-12-12. [[phpfn>strftime]] placeholders are replaced by page creation time  |
 +^ %%                | a literal ''%'' character appears in your template                                     |
 +
 +
 +
 +===== Mermaid Plugin =====
 +
 +  * https://www.dokuwiki.org/plugin:mermaid
 +
 +
 +Mermaid supports multiple other diagrams besides the shown flowchart, for example:
 +  * Sequence diagrams
 +  * Gantt diagrams
 +  * Class diagrams
 +  * Git graphs
 +  * User Journey diagrams
 +
 +**Size Adjustments**
 +
 +The width and height of the container of the diagram can be adjusted using
 +
 +  <mermaid #width #height>
 +
 +where ''#width'' and ''#height'' can take any value supported by CSS, for example:
 +
 +  <mermaid 100% 1cm>
 +
 +**Raw Mode**
 +
 +If needed, the Mermaid code can be passed on without any processing or rendering by DokuWiki. Insert a line containing only the word ''raw'' before the Mermaid code:
 +
 +  <mermaid>
 +    raw
 +    graph TD
 +      A(**mermaid**)-->B((__plugin__))
 +      A-->C(((//for//)))
 +      B-->D[["[[https://www.dokuwiki.org/dokuwiki|Dokuwiki]]"]]
 +      C-->D
 +  </mermaid>
 +
 +
 +
 +<mermaid>
 +  graph TD
 +    A(**mermaid**)-->B((__plugin__))
 +    A-->C(((//for//)))
 +    B-->D[["[[https://www.dokuwiki.org/dokuwiki|Dokuwiki]]"]]
 +    C-->D
 +</mermaid>
 +
 +
 +<code>
 +<mermaid>
 +  graph TD
 +    A(**mermaid**)-->B((__plugin__))
 +    A-->C(((//for//)))
 +    B-->D[["[[https://www.dokuwiki.org/dokuwiki|Dokuwiki]]"]]
 +    C-->D
 +</mermaid>
 +</code>
 +
 +
 +===== Wrap Plugin =====
 +
 +
 +==== Basic syntax ====
 +
 +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 width :language>
 +  "big" content
 +  </WRAP>
 +  
 +  or
 +  <block classes width :language>
 +  "big" content
 +  </block>
 +  
 +  or
 +  <div classes width :language>
 +  "big" content
 +  </div>
 +
 +A lowercase **%%<wrap>%%** (or alternatively **%%<inline>%%** or **%%<span>%%**) 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 (''%%__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 Internet Explorer)
 +</WRAP>
 +
 +
 +<WRAP info 220px left>
 +//**Info**//
 +  <WRAP info></WRAP>
 +</WRAP>
 +
 +
 +<WRAP tip 220px left>
 +//**Tip**//
 +  <WRAP tip></WRAP>
 +</WRAP>
 +
 +
 +<WRAP important 220px left>
 +//**Important**//
 +  <WRAP important></WRAP>
 +</WRAP>
 +
 +
 +<WRAP alert 220px left>
 +//**Alert**//
 +  <WRAP alert></WRAP>
 +</WRAP>
 +
 +
 +<WRAP round help 220px left>
 +//**Help**//
 +  <WRAP round help></WRAP>
 +</WRAP>
 +
 +
 +<WRAP download 220px left>
 +//**Download**//
 +  <WRAP download></WRAP>
 +</WRAP>
 +
 +
 +<WRAP todo 220px left>
 +//**Todo**//
 +  <WRAP todo></WRAP>
 +</WRAP>
 +
 +
 +<WRAP clear></WRAP>
 +
 +
 +**Safety Notes:**
 +
 +<WRAP danger 27% left>
 +//**Danger**//
 +  <WRAP danger></WRAP>
 +</WRAP>
 +
 +<WRAP warning 27% left>
 +//**Warning**//
 +  <WRAP warning></WRAP>
 +</WRAP>
 +
 +<WRAP caution 27% left>
 +//**Caution**//
 +  <WRAP caution></WRAP>
 +</WRAP>
 +
 +<WRAP round notice 27% left>
 +//**Notice**//
 +  <WRAP round notice></WRAP>
 +</WRAP>
 +
 +<WRAP round safety 27% left>
 +//**Safety**//
 +  <WRAP round safety></WRAP>
 +</WRAP>
 +
 +<WRAP clear></WRAP>
 +
 +
 +You can use notes and boxes also inside text with spans like this:
 +<wrap info>info</wrap>, <wrap help>help</wrap>, <wrap alert>alert</wrap>, <wrap important>important</wrap>, <wrap tip>tip</wrap>, <wrap download>download</wrap>, <wrap todo>todo</wrap> and <wrap round box>round box</wrap> and <wrap danger>danger</wrap>, <wrap warning>warning</wrap>, <wrap caution>caution</wrap>, <wrap notice>notice</wrap>, <wrap safety>safety</wrap>.
 +  <wrap info>info</wrap>, <wrap help>help</wrap>, ...
 +
 +=== Marks ===
 +
 +You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>.
 +
 +  You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>.
 +
 +:!: This might look ugly in some templates and should be adjusted accordingly.
 +
 +=== Miscellaneous ===
 +
 +== Indent ==
 +
 +<wrap indent>This text will appear indented.</wrap>
 +
 +  <wrap indent>This text will appear indented.</wrap>
 +
 +== Outdent ==
 +
 +<wrap outdent>This text will appear "outdented".</wrap>
 +
 +  <wrap outdent>This text will appear "outdented".</wrap>
 +
 +== Prewrap ==
 +
 +<WRAP prewrap 250px>
 +<code>
 +Inside this code block the words will wrap to a new line although they are all in one line.
 +</code>
 +</WRAP>
 +
 +  <WRAP prewrap 250px>
 +  <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: <wrap spoiler>Darth Vader is Luke's father.</wrap>
 +
 +  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: <wrap hide>John, please revise that sentence.</wrap>
 +
 +  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: <WRAP pagebreak></WRAP>
 +
 +  The following will add a pagebreak: <WRAP pagebreak></WRAP>
 +
 +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: <WRAP nopagebreak>much content, belonging together (like a long table)</WRAP>
 +
 +  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 [[http://reference.sitepoint.com/css/page-break-inside|avoid a page break]] in printouts.
 +
 +== Noprint ==
 +
 +<wrap noprint>This text appears on the screen, but not in print.</wrap>
 +
 +  <wrap noprint>This text appears on the screen, but not in print.</wrap>
 +
 +== Onlyprint ==
 +
 +<wrap onlyprint>This text does not appear on the screen, but only in print.</wrap>
 +
 +  <wrap onlyprint>This text does not appear on the screen, but only in print.</wrap>
 +
 +=== Typography ===
 +
 +I advice against using the following typography classes. It's better to create semantic classes that reflect their meaning instead.
 +
 +  * font family: ''sansserif'', ''serif'', ''monospace''
 +  * font size: ''bigger'', ''muchbigger'', ''smaller''
 +  * font colour: ''fgred'', ''fggreen'', ''fgblue'', ''fgcyan'', ''fgviolet'', ''fgyellow'', ''fggrey'', ''fgwhite'', ''fgblack''
 +  * background colour: ''bgred'', ''bggreen'', ''bgblue'', ''bgcyan'', ''bgviolet'', ''bgyellow'', ''bggrey'', ''bgwhite'', ''bgblack''
 +
 +
 +=== Combining and Nesting ===
 +
 +You can combine and nest all classes and types of boxes, e.g.
 +
 +<WRAP box bggreen fgblack 350px right :en>
 +//**__Outer green box floats right__**//
 +
 +<WRAP 165px left>
 +Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with nested <wrap bigger>__bigger__ text</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>
 +
 +
 +<code>
 +<WRAP box bggreen fgblack 350px right :en>
 +//**__Outer green box floats right__**//
 +
 +<WRAP 165px left>
 +Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with nested <wrap bigger>__bigger__ text</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>
 +</code>
 +
 +
 +=== 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:
 +
 +<code>
 +<WRAP :he>
 +זה עברית. ((<wrap :en>This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].</wrap>))
 +</WRAP>
 +</code>
  
 +<WRAP :he>
 +זה עברית. ((<wrap :en>This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].</wrap>))
 +</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 specify a language not listed there, it simply won't do anything.)
wiki/plugins.1695368781.txt.gz · 마지막으로 수정됨: 저자 zasfe

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki