Differences

This shows you the differences between two versions of the page.

--- wiki:explugins [2018/12/13 12:54]
madsiur [Image Gallery]
+++ wiki:explugins [2019/02/12 09:52]
@@ Line 1: / Line 1: @@
-====== Gallery Plugin ======
-[[https://www.dokuwiki.org/plugin:gallery]]
-===== Syntax =====
-A basic gallery can be added by selecting a [[https://www.dokuwiki.org/namespaces|namespace]] like this:
-  {{gallery>:namespace}}
-All image files in the selected namespace will be added to the image gallery. Don't forget the ":" in front of the namespace.
-Instead of using a whole namespace of images, you can also specify a single image -- this makes more sense when combined with the lightbox mode (see below).
-  {{gallery>:namespace:someimage.jpg}}
-The created gallery can be aligned by using white space (defaults to centered):
-  {{gallery> namespace}} (right aligned)
-  {{gallery>namespace }} (left aligned)
-  {{gallery> namespace }} (centered)
-Instead of a namespace, you can also give an HTTP(s) URL to any [[wp>Media RSS]] or ATOM feed with enclosures (as produced by most photo sharing sites like Flickr). The images will then be pulled from that feed instead:
-  {{gallery>http://www.23hq.com/rss/schabloni}}
-Note: since the question mark is used to separate the parameters (see next section) the URL can not contain any question mark. To use such a feed URL with the gallery plugin, just use one of the many short URL services like [[http://bit.ly]].
-E.g. instead of ''%%http://api.flickr.com/services/feeds/photos_public.gne?id=22019303@N00&lang=en-us&format=rss_200%%'' use a shortened URL like ''%%http://bit.ly/HurZM%%''.
-Additionally, to have thumbnail creation correctly working you need to set [[https://www.dokuwiki.org/config:fetchsize|fetchsize]] big enough to get the remote images downloaded.
-==== Parameters ====
-A number of parameters can be set by appending them with ''?'' character to the namespace or image. Each parameter needs to be separated with a ''&'' character. Defaults for all parameters can be set in the config manager. If a parameter is enabled by default it can be disabled in the syntax by prefixing it with the syllable ''no''. E.g. the parameter ''cache'' is usually enabled and can be disabled using the keyword ''nocache''. Below is a list of all recognized parameters
-^ Parameter                      ^ Default         ^ Description    ^
-| ''//<number>//x//<number>//''  | ''%%120x120%%'' | Sets the size for thumbnails. Unless the crop option is set, this is a boundary box into which the thumbnail will be fitted, maintaining the correct aspect ratio. |
-| ''//<number>//X//<number>//''  | ''%%800X600%%'' | Sets the size for the linked images in ''direct'' mode. This is a boundary box into which the image will be fitted, maintaining the correct aspect ratio. Note the uppercase ''X''.|
-| ''//<number>//''               | ''5''           | The number images per row in the gallery table. If you specify a 0 no table is used instead all thumbnails are added in a sequence. |
-| ''=//<number>//''              | ''=0''          | Limits the output to the given number of images. ''0'' means all. |
-| ''+//<number>//''              | ''+0''          | Skip the first number of images. Useful with the option above. |
-| ''~//<number>//''              | ''~0''          | Add a pagination for the thumbnails displaying the number of given thumbnails per page. ''0'' disables pagination. Pagination is added through JavaScript - when no JavaScript is available all thumbnails are displayed |
-| ''cache''                      | enabled         | Usually the output of the created gallery is cached. When the images in your selected namespace change, you have to manually force an update of the gallery page's [[https://www.dokuwiki.org/caching|cache]]. To disable the cache for the page showing the gallery, set ''nocache'' as option. |
-| ''crop''                       | disabled        | Make thumbnails the exact given thumbnail size big, cropping when needed. |
-| ''direct''                     | disabled        | Link thumbnails with the bigger sized images not with their detail page |
-| ''lightbox''                   | disabled        | Show images in a fancy JavaScript modal browsing window, see below for details. Setting this option automatically implies the ''direct'' mode |
-| ''reverse''                    | disabled        | Reverse the order of the displayed images |
-| ''recursive''                  | enabled         | Find images in the given namespace and all sub namespaces |
-| ''random''                     | disabled        | Sort images randomly. You might want to use ''nocache'' as well |
-| ''modsort''                    | disabled        | Sort images by file modification date |
-| ''datesort''                   | disabled        | Sort images by EXIF date |
-| ''titlesort''                  | disabled        | Sort images by EXIF title |
-| ''showname''                   | disabled        | Show filename below thumbnails |
-| ''showtitle''                  | disabled        | Show the EXIF tag ''Headline'' as title below thumbnails |
-| anything containing a ''*''    | jpg,gif,png images | This can be used to filter the list of files found in the given namespace. ''*'' work as simple wildcard symbol. |
-=== Example ===
-  {{gallery>images:vacation?image_*.jpg&80x80&crop&lightbox}}
-This displays all images beginning with ''image_'' and ending in ''.jpg'' from the namespace ''images:vacation''. Thumbnails are cropped to 80x80 pixels and images will be opened in lightbox mode.
-=== Example ===
-  {{gallery>?crop&lightbox}}
-This displays all images in the current namespace using 2 parameters. Parameterlist begins with ''?'' additional ones are concatenated with ''&''.
-===== About the Lightbox mode =====
-This mode will open the clicked picture inside the current browser window without leaving the current page.
-You can close the picture view by clicking the X button in the upper right corner. You can move to the next or previous image by using the arrow buttons in the lower bar. You can also use the keyboard shortcuts listed below for navigation and closing. Mobile users can swipe to navigate and use the back button to close the gallery.
-The following keys can be used to navigate:
-^ Key     ^ Action ^
-| ''->''  | next image |
-| ''<-''  | previous image |
-| ''ESC'' | close the image view |
-===== Manipulate EXIF Tags =====
-If you want to show a title below the image using the parameter ''showtitle'' it may appear that the title shown is not as you expected (e.g. ''einstein.jpg'' instead of ''Albert Einstein'').
-If you want to adapt the image's subtitle shown in the gallery, you have to manipulate the EXIF Tag called ''Headline''.  This can be done with the [[https://www.dokuwiki.org/fullscreen_mediamanager|fullscreen media manager]].  Alternatives include [[http://owl.phy.queensu.ca/~phil/exiftool/|ExifTool]] for which even a [[http://u88.n24.queensu.ca/~bogdan/|Windows GUI]] exists to adapt the EXIF data to your needs. On //Windows//, the small picture viewer [[http://www.irfanview.com/|IrfanView]] can also be used to change only IPTC values.
-Note that the EXIF-tags used for display can be changed. See [[https://www.dokuwiki.org/exif|EXIF and IPTC metadata]] for details. By default, the following tags are used:
-  * ''IPTC:Headline'' for the title
-  * ''IPTC:Caption-Abstract'' for the description below the picture in lightbox-mode
-  * ''IPTC:By-line'' for the photographer name
-  * ''IPTC:CopyrightNotice'' for the copyright
-  * ''IPTC:Keywords'' for keyword list
-===== Known Limitations and Caveats =====
-==== Uploading Images ====
-Uploading images is beyond the scope of this plugin. Do not request any features regarding this.
-  * Use the [[https://www.dokuwiki.org/media_manager|media manager popup]] or [[https://www.dokuwiki.org/fullscreen_mediamanager|fullscreen media manager]] to upload multiple image at once with compatible browsers, otherwise one by one.
-  * Use the [[https://www.dokuwiki.org/plugin:archiveupload|archiveupload]] plugin to upload multiple images in a Zip file
-  * Upload the files manually via FTP to the ''data/media'' directory. Keep in mind that image names need to be valid [[https://www.dokuwiki.org/pagename|pagenames]], all lowercase, no spaces or special chars!
-  * Images previously rotated 90˚ and saved in that orientation no longer appear that way when used in dokuwiki.
-==== Caching ====
-The gallery output is cached by default. When you add pictures later, they may not show up in the gallery: add ''&purge=true'' to the end of the URL to clear the cache. See [[https://www.dokuwiki.org/caching|caching]] for details.
-Optionally use the ''nocache'' parameter of the plugin (not recommended).
-==== EXIF Data Problems ====
-Problems with accessing [[https://www.dokuwiki.org/exif|EXIF or IPTC]] data in the images, should be reported as DokuWiki bugs and not for this plugin. All EXIF handling is in DokuWiki core. Currently EXIF Data is expected in UTF-8 encoding.
-==== Lightbox Problems ====
-When the lightbox mode doesn't work and instead images are simply opened in the same window, the JavaScript was not correctly loaded. This is most likely a Browser-Cache issue. Simply follow the steps described for fixing a similar problem with the [[https://www.dokuwiki.org/faq:toolbar|toolbar]]. Also make sure you don't have any conflicting plugin installed. You should **not** install any additional lightbox plugin.
-==== Images are not Resized ====
-There are different reasons why thumbnails are not created:
-  * libGD extension is missing => Install the extension or configure DokuWiki to use [[https://www.dokuwiki.org/config:im_convert|imagemagick]]
-  * libGD extension is installed, but the source image size + overhead is larger than memory_limit set in php.ini => Lower the source image size or increase the memory_limit
-==== MediaRSS feed displays "nothing found" ====
-When no images from your feed are shown, be sure you don't have a question mark in your URL. Use an URL shortener as suggested above. Also be sure your feed URL (before shortening) starts with %%http://%% or %%https://%% and not with %%feed://%%. The latter is just a renamed HTTP link - simply rename it back.
-==== External Images are not Resized ====
-As written above, you need to increase the [[https://www.dokuwiki.org/config:fetchsize|fetchsize]] config option. Also make sure LibGD or ImageMagick are installed.
-===== Demo Installations =====
-Here are a few user provided examples of the gallery plugin in use:
-  * http://adam.nz
-  * http://eolienne.f4jr.org/medias/start
-  * http://www.splitbrain.org/blog/2008-01/04-new_york_impressions
-  * http://www.hemmerling.com/doku.php/en/repository.html
-====== Discussion Plugin ======
-===== Description =====
-The Discussion plugin adds a discussion section after your wiki page for user comments. This is useful to separate page content and the discussion thereof and also, if you don't want to give normal users the right to edit the page but still want user contributed notes.
-A second component of this plugin shows a list of all pages in a namespace with a discussion section (called discussion threads) ordered by most recent comments. This allows you to create a very simple discussion forum in your wiki.
-===== Components =====
-==== Comments-section ====
-This is the main part of the plugin. By including the ''%%~~DISCUSSION~~%%'' instruction in your wiki page, a discussion section will be appended after the normal wiki page content. To turn it off again, use ''%%~~DISCUSSION:off~~%%''. If you want to show the existing discussion but don't want to allow new comments / replies, use ''%%~~DISCUSSION:closed~~%%''.
-  ~~DISCUSSION~~
-  ~~DISCUSSION:off~~
-  ~~DISCUSSION:closed~~
-A custom title can be appended after the separator %%|%%.
-  ~~DISCUSSION|Custom Title String~~
-  ~~DISCUSSION:closed|Custom Title String~~
-After each comment in the discussion section there may be up to three buttons (depending on your rights):
-  * Reply: To reply to a comment (vs. commenting on the wiki page content), click the ''Reply'' button. The comment entry form will then be placed accordingly.
-  * Edit: Registered users can edit their comments; admins can edit all comments. To remove a comment, just edit it, clear the text and save the empty comment -- like you would do with a wiki page.
-  * Delete: Registered users and admin all comments. \\ //Attention: If there are replies to a comment, removing it will also remove all replies!//
-  * Hide / Show: Admins can deactivate and reactivate comments easily by this button. Hidden comments aren't shown to normal users and are displayed dimmed to admins. Registered users can only hide their own comments.
-Of course, the whole DokuWiki [[:wiki:syntax|syntax]] can be used in comments as well. But there are problems with headers and footnotes as they may produce conflicting IDs and thus invalid XHTML. I'm looking for a way to either allow only a subset of the wiki syntax or automatically create unique IDs.
-==== Threads syntax====
-This displays a list of all pages of the given namespace with a discussion section. The list is sorted by the most recent comment.
-  {{threads>[namespace]&[count=n]&[flags]&skipempty}}
-^ [namespace] | the namespace for which you want a discussion thread list; '':'' is the top namespace, ''.'' is the same namespace as the page lies in, ''*'' the whole wiki | required |
-^ [count=n] | the number of discussions which should be displayed (valid values: n > 0) | optional |
-^ [flags] | pagelist flags delimited by ''&'', see [[https://www.dokuwiki.org/plugin:pagelist#flags|flags]] | optional |
-^ skipempty | Do not print discussions with no comments | optional |
-Default a //new thread form// is shown below the list. See ''threads_formposition'' setting for moving it to the top of the list, or to disable this form.
-====== Video Share Plugin ======
-===== Usage/Syntax =====
-The basic syntax looks like this: ''%%{{%%//videosite//>//videoid//?//parameter1&parameter2//|title%%}}%%''
-  * Where ''//videosite//'' is one of the identifiers listed in [[#Supported Services]] chapter
-  * and ''//videoid//'' is the identifier of the video at the respective site
-  * The ''//parameters//'' are optional. You start these with a ''?'' and separate more of them by a ''&''. Look in [[#Parameters]] chapter
-  * The title is optional as well. Look in [[#Examples]] chapter
-  * The video can be aligned by adding spaces on the left or right inside the curly brackets (like in the image syntax). Look in [[#Examples]] chapter
-A toolbar button pops up a prompt where you can simply paste the full URL to the page of the video you want to embed. The plugin will then try to figure out the video ID by itself
-=== Parameters ===
-  * The ''//size//'' parameter is the best supported parameter. You can either give it in the form:
-    * ''//width//x//height//'' like ''500x300''
-    * or use the keywords ''small'', ''medium'' or ''large''
-  * Some other additional parameters are supported (depending on video service) as well:
-    * Start point of video: ''&start=<seconds>'' (YouTube, DailyMotion) or ''&initial_time=<seconds>'' (TwitchTV)
-    * End point of video segment: ''&end=<seconds>'' (YouTube)
-    * Auto play: ''&autoplay=1'' (Vimeo, YouTube, DailyMotion, Bambuser) or ''&ap=1''(MetaCafe)
-    * Do not show related videos when playback ends: ''&rel=0'' (YouTube)
-    * Start slide: ''&startSlide=5'' (SlideShare)
-==== Examples ====
-Display a YouTube Video:
-  {{youtube>L-WM8YxwqEU}}
-Show a larger player:
-  {{youtube>L-WM8YxwqEU?large}}
-Right-align the player:
-  {{ youtube>L-WM8YxwqEU}}
-Show a small, centered player:
-  {{ youtube>L-WM8YxwqEU?small }}
-Show a small, centered player with a title (look for right space!):
-  {{ youtube>L-WM8YxwqEU?small |Some funny video}}
-Some other additional parameters are supported (depending on video service) as well:
-  {{youtube>L-WM8YxwqEU?small&start=30&end=45|A random segment of 15 seconds}}
-===== Supported Services =====
-Copy paste the video url in the toolbar pop-up prompt to generate the syntax
-^ Identifier  ^ Website  ^ Supported parameters ^
-| 5min        | [[http://www.5min.com/|5min]]                |  |
-| archiveorg  | [[https://archive.org/|Archive.org]]         |  |
-| bambuser    | [[http://bambuser.com|Bambuser]]             | autoplay |
-| bliptv      | [[http://blip.tv/|Blip.TV]]                  |  |
-| break       | [[http://www.break.com|Break]]               |  |
-| clipfish    | [[http://www.clipfish.de/|Clipfish]]         |  |
-| dailymotion | [[http://www.dailymotion.com/|Daily Motion]] | start |
-| gtrailers   | [[http://www.gametrailers.com|GameTrailers]] |  |
-| metacafe    | [[http://www.metacafe.com/|MetaCafe]]        | ap |
-| msoffice    | [[http://office.microsoft.com/en-us/support/training-FX101782702.aspx|Microsoft Office Training]] | |
-| myspacetv   | [[http://vids.myspace.com/|MySpaceTV]]       |  |
-| rcmovie     | [[http://www.rcmovie.de|RCMovie]]            |  |
-| scivee      | [[http://scivee.tv|Scivee.tv]]               |  |
-| twitchtv    | [[http://www.twitch.tv|Twitch.tv]]           | chapter_id, initial_time  |
-| slideshare  | [[http://www.slideshare.com|Slideshare]]     | startSlide  |
-| ustream     | [[http://ustream.tv|Ustream.TV]]             |  |
-| veoh        | [[http://www.veoh.com/|Veoh]]                |  |
-| viddler     | [[http://www.viddler.com|Viddler]]           | offsetTime |
-| vimeo       | [[http://www.vimeo.com/|Vimeo]]              | autoplay |
-| youtube     | [[http://www.youtube.com/|YouTube]]          | start, end, rel, autoplay |
-Additional sites can be added to the ''sites.conf'' file in the plugin directory. Video ID recognition patterns for the toolbar button are configured in ''sites.js''
-====== Wrap Plugin ======
-===== One plugin to rule them all =====
-This plugin gives you the ability to wrap wiki text inside containers (divs or spans) and give them
-  - a certain class (with loads of useful preset classes)
-  - a width
-  - a language with its associated text direction
-It potentially replaces a lot of other plugins and is IMHO the better alternative for many.
-===== 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_example9.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 (2, 3, 4 or 5), only works in modern browsers (Firefox, Chrome and Safari)  |
-^ __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 columns in a row, should be used in triplets  |
-| **''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>%%''s  |
-| **''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  |
-| **''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]]  |
-All tables inside a column or box will always be 100% wide. This makes positioning and sizing tables possible and partly replaces [[tablewidth]].
-=== Known restrictions ===
-  * WRAPs won't export in ODT format.
-  * 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. The following syntax would produce two different kinds of emulated headlines inside any of the columns or boxes/notes:
-    * %%//**__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, ex, 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'' 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://fotki.yandex.ru/next/users/alexgearbox/album/189832/view/740257|“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_" | tabs, group |
-|''restrictedClasses'' | restrict usage of plugin to these (comma separated) classes | //(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 |
-===== ODT Support =====
-Since version 2015-06-13 the Wrap plugin supports exporting most of its functionality/styling to ODT when using at least version 2015-06-29 of the [[odt|ODT Plugin]]. By default, Wrap syntax will be exported to ODT using 'print' CSS styles. This means the exported Wrap elements will look the same when printing a wiki page. If you want to have the ODT exported Wrap elements look like displayed in the browser (i.e. with 'screen' CSS styles), then use the following ODT plugin configuration settings:
-  * add wrap to the 'usestyles' config setting
-  * set the 'media_sel' setting to 'screen'
-If you prefer a user defined CSS style for the Wrap ODT export, then simply place a file 'odt.css' into the Wrap plugin folder with your own CSS code (and set config setting 'media_sel' to 'print').
-Here is what is currently **not** supported:
-  * columns: left/right/center/column is partly supported; they are positioned correctly, but content is not floating around them
-  * widths are not supported except % and half/third/quarter
-  * boxes and notes: hardly any formatting inside them is supported, therefore emulated headings also don't work
-  * tabs will just show a list of links
-  * noprint
-  * nopagebreak
-  * onlyprint only works on boxes
-  * languages are set correctly but do not seem to affect text alignment
-  * shorthand syntax
-  * Not supported because not relevant in ODT: clear, prewrap
-===== 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></WRAP>%%''
-  * "especially emphasised, highlighted, less significant" creates the respective marks
-===== Extend with custom styles =====
-If you like to add your own classes and styles to the plugin, you can simply add the styles for your class preceded by "''wrap_''" to your [[devel:css#user styles]]. Please note, any classes need to be **lower case**.
-E.g. if you need a ''%%<WRAP myclass>%%'', you edit (or create if it doesn't exist) your ''conf/userstyle.css'' and add your ''.wrap_myclass{}'' with its style definitions to it. (If necessary, edit ''conf/userprint.css''(( ''conf/printstyle.css'' in Anteater)) for the print view, ''conf/userrtl.css''(( ''conf/rtlstyle.css'' in Anteater)) for RTL languages and ''conf/userall.css''(( ''conf/allstyle.css'' in Anteater)) for all styles as well.)
-User permissions for every file used must be similar to original DokuWiki files.
-Since version 2010-03-14 you have the possibility to exclude certain class names from being prefixed with "wrap_". Just add a comma separated list of class names into the config option "noPrefix" in the configuration manager.
-==== Examples ====
-in style.css
-<code css>
-.dokuwiki div.wrap_note{ /* added */
-    background-color: #eee;
-    color: #000;
-    padding: .5em .5em .5em .5em;
-    margin-bottom: 1em;
-    overflow: hidden;
-}
-</code>
-call in DW-page:
-  <WRAP note>...</WRAP>
-Here are some [[plugin:wrap:extensions|useful wrap extensions]] created by users of this plugin.
-==== Add former typography classes ====
-The old typography classes were removed in version 2011-05-15. If you need something similar, use the [[Block]] plugin instead. Or you can use your own and copy them to your own user styles (see [[#Extend with custom styles|above]]).
-===== How to use the helper =====
-From version 2011-05-15 on the plugin includes a helper plugin which you can use to add classes, width and lang/dir to any other plugin.
-==== Example how to get just one kind of attribute ====
-<code php>
-// get lang from wrap helper plugin
-$lang = '';
-if(!plugin_isdisabled('wrap')) {
-    $wrap = plugin_load('helper', 'wrap');
-    $attr = $wrap->getAttributes($data);
-    if($attr['dir']) $lang = ' lang="'.$attr['lang'].'" xml:lang="'.$attr['lang'].'" dir="'.$attr['dir'].'"';
-}
-// add lang to your plugin's output
-$renderer->doc .= '<span '.$lang.' class="foo">';
-</code>
-''getAttributes()'' expects the string with "classes #id width :language". It returns an array with
-  * ''$attr['class']'': CSS class(es)
-  * ''$attr['id']'': CSS ID
-  * ''$attr['width']'': width
-  * ''$attr['lang']'' and ''$attr['dir']'': language and text direction
-==== Example how to get all attributes ====
-<code php>
-// get attributes from wrap helper plugin
-$attr = '';
-if(!plugin_isdisabled('wrap')) {
-    $wrap = plugin_load('helper', 'wrap');
-    $attr = $wrap->buildAttributes($data, 'additionalClass');
-}
-// add those attributes to your plugin's output
-$renderer->doc .= '<div '.$attr.'">';
-</code>
-''buildAttributes()'' expects the same string as above ("classes #id width :language") and an optional string for additional classes, in case your plugin has CSS classes of its own which it needs to reuse. It returns a string with all the attributes prepared for HTML.
-===== Development =====
-==== Done ====
-[[https://github.com/selfthinker/dokuwiki_plugin_wrap/commits/master.atom|{{http://img529.imageshack.us/img529/5725/feedm.png?16x16 |Recent commits to Wrap Plugin (RSS feed)}}]]
-{{rss>https://github.com/selfthinker/dokuwiki_plugin_wrap/commits/master.atom date}}
-==== Localization ====
-You can help me with translations and [[http://translate.dokuwiki.org/plugin/wrap|update the language files]]. There are two files to translate:
-  * [[https://github.com/selfthinker/dokuwiki_plugin_wrap/blob/master/lang/en/lang.php|lang/en/lang.php]] is for the explaining titles on the picker images.
-  * [[https://github.com/selfthinker/dokuwiki_plugin_wrap/blob/master/lang/en/settings.php|lang/en/settings.php]] is for the configuration options.
-===== Credits =====
-  * The code reuses parts of the [[box]] plugin by [[chris@jalakai.co.uk|Christopher Smith]].
-  * The ODT support was implemented by [[https://github.com/LarsGit223|LarsDW223]].
-  * The images for the notes are taken from the [[http://schollidesign.deviantart.com/art/Human-O2-Iconset-105344123|Human-O2 icon set]].
-  * The toolbar uses images from the [[http://www.famfamfam.com/lab/icons/silk/|Silk Icon Set]] and the [[http://www.damieng.com/icons/silkcompanion|Silk Companion Icon Set]].
-  * Thanks to [[https://github.com/selfthinker/dokuwiki_plugin_wrap/contributors|all contributors]].
-===== Discussion =====
-Before reporting any issues (bugs or requests), please first take a look at the [[faq:pluginproblems|FAQ on plugin problems]].
-You can report any issues either on the [[https://github.com/selfthinker/dokuwiki_plugin_wrap/issues|Issue Tracker]] or on the separate [[.:wrap:discussion]] page.
-====== PageList Plugin ======
-===== Description =====
-The Pagelist Plugin takes a list of wiki pages and provides a nicely formatted table with information about them. The plug-in has a number of flags that can be used to control the information and format of the page list. The user can provide a list of specific page references as can some popular helper plugins such the [[Blog]], [[Discussion]], [[Editor]], [[Tag]], [[Task]] and [[Dir]] plugins.
-===== Syntax =====
-Just wrap a regular unordered list of internal links with the ''%%<pagelist>%%'' tag. You may provide specific internal page references or have plug-ins supply them as in the example below:
-  <pagelist&[flags]>
-    * [[..:blog:|Blog Plugin]]
-    * [[..:discussion:|Discussion Plugin]]
-    * [[..:editor:|Editor Plugin]]
-    * [[..:tag:|Tag Plugin]]
-    * [[..:wrap|Wrap Plugin|This is shown in the description cell]]
-  </pagelist>
-^ [flags]  | flags can be used to alter the appearance of the pagelist, [[#flags]]  | optional  |
-==== Flags ====
-^ Setting ^ Default ^^ Alternative ^^
-| ''style'' ^ ''default'' | table with horizontal lines ^ ''table'', ''list'' or ''simplelist'' | standard DokuWiki table or list style |
-| ''showheader'' ^ ''noheader'' | hide the heading row of the pagelist table ^ ''header'' | show the header |
-| ''showdate'' ^ ''date'' | show the creation or last modification date ^ ''nodate'' | hide the date |
-| ''showuser'' ^ ''user'' | show creator or contributors ^ ''nouser'' | hide the user |
-| ''showdesc'' ^ ''nodesc'' | hide the description ^ ''desc'' | show the description (from metadata) |
-| ''showcomments'' ^ ''nocomments'' | hide the number of comments ^ ''comments'' | show the number of comments (if [[discussion|Discussion Plugin]] is installed) |
-| ''showtags'' ^ ''notags'' | hide the tags ^ ''tags'' | show the tags (if [[tag|Tag Plugin]] is installed) |
-| ''showfirsthl'' ^ ''firsthl'' | show the first headline ^ ''nofirsthl'' | show the page name |
-| ''rsort/sort''        ^ ''nosort''    | no sortation of pages ^ ''rsort/sort'' | sorts the pages (reverse) alphabetically by pagename |
-| ''showdiff''        ^ ''missing''    | no displaying of differences column ^ ''showdiff'' | displays the differences column with the diff icon linking to the corresponding diff page for each row |
-==== Example ====
-  <pagelist&header&comments>
-      //an unordered list of pages to display//
-  </pagelist>
-In the example above, pagelist will display information about the provided pages in  a table with a header line and a comments column (if the [[plugin:discussion|Discussion Plugin]] is installed). The user (or a plugin) must supply the specific pages to display in the list.
-===== Configuration =====
-The plugin can be configured using the DokuWiki configuration manager available in the admin menu. The settings also apply to plugins which use the helper component of the pagelist plugin, like for example the archive component of the [[plugin:blog]] plugin.
-^ ''style'' | List style (default, table, table/list, simplelist) |
-^ ''showheader'' | Show table header |
-^ ''showdate'' | Shows/hides the date column (hide, creation date, modification date) |
-^ ''showuser'' | Shows/hides the user column (hide, creator, contributors) |
-^ ''showdesc'' | Shows/hides a short description taken from the first paragraph of a page (hide, max. 160 characters, max. 500 characters) |
-^ ''showcomments'' | Shows/hides comments of a page (requires the [[plugin:discussion]] plugin) |
-^ ''showlinkbacks'' | Shows/hides linkbacks of a page (requires the [[http://foosel.org/snippets/dokuwiki/linkback|linkback]] plugin) |
-^ ''showtags'' | Shows/hides tags of a page (requires the [[plugin:tag]] plugin) |
-^ ''sort''     | Sorts the pages alphabetically by pagename |
-^ ''showdiff'' | Displays a differences column with the diff icon linking to the corresponding diff page for each row |
-===== Helper Plugin =====
-You can easily use the functionality of the Pagelist Plugin in your own plugins. Here is a basic code snippet:
-<code php>
-  $pages = array(
-    array('id' => 'wiki:dokuwiki'),
-    array('id' => 'wiki:syntax'),
-  );
-  $pagelist =& plugin_load('helper', 'pagelist');
-  if (!$pagelist) return false; // failed to load plugin
-  $pagelist->startList();
-  foreach ($pages as $page){
-    $pagelist->addPage($page);
-  }
-  $renderer->doc .= $pagelist->finishList();
-</code>
-Since release ''2017-08-24'' the function ''startList()'' has got an optional parameter to specify a CSS class for adding it to the class of the table element:
-<code php>
-  $pagelist->startList('myclass');
-</code>
-===== Bugs / Feature Requests =====
-Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-pagelist/issues|Bug tracker]].
-===== Further Resources =====
-  * [[https://github.com/dokufreaks/plugin-pagelist/tree/master|Git Repository]]
-  * [[https://github.com/dokufreaks/plugin-pagelist/issues|Bug Tracker]]
-===== Changes =====
-{{rss>https://github.com/dokufreaks/plugin-pagelist/commits/master.atom date author}}