Differences

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

--- wiki:explugins [2016/03/07 01:59]
madsiur
+++ wiki:explugins [2019/02/12 09:52] (current)
@@ Line 1: / Line 1: @@
-====== External Plugins installed ======
+====== Gallery Plugin ======
+[[https://www.dokuwiki.org/plugin:gallery]]
-===== Image Gallery =====
 ===== Syntax =====
@@ Line 102: / Line 101: @@
   * Use the [[plugin: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 [[: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 ====
@@ Line 132: / Line 133: @@
 As written above, you need to increase the [[config:fetchsize]] config option. Also make sure LibGD or ImageMagick are installed.
-===== Demo Installations =====
+====== Video Share Plugin ======
+[[https://www.dokuwiki.org/plugin:vshare]]
-Here are a few user provided examples of the gallery plugin in use:
+===== Usage/Syntax =====
-  * http://www.wikipeixes.com.br/  FIXME
+The basic syntax looks like this: ''%%{{%%//videosite//>//videoid//?//parameter1&parameter2//|title%%}}%%''
-  * http://eolienne.f4jr.org/medias/start
+  * Where ''//videosite//'' is one of the identifiers listed in [[#Supported Services]] chapter
-  * http://www.splitbrain.org/blog/2008-01/04-new_york_impressions
+  * and ''//videoid//'' is the identifier of the video at the respective site
-  * http://www.hemmerling.com/doku.php/en/repository.html
+  * The ''//parameters//'' are optional. You start these with a ''?'' and separate more of them by a ''&''. Look in [[#Parameters]] chapter
-  * http://urbangirlblue.org/ecscc/doku.php  FIXME
+  * 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 =====
@@ Line 157: / Line 227: @@
 It partly replaces: [[box]], [[button]], [[color]], [[columns]], [[fontcolor]], [[fontfamily]], [[fontsize2]], [[fontsize]], [[highlight]], [[layout]], [[note]], [[styler]], [[tab]], [[tablewidth]], [[typography]]
+===== Installation =====
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Syntax =====
@@ Line 165: / Line 240: @@
   </WRAP>
-  or
+  **or**
   <block classes #id width :language>
   "big" content
@@ Line 203: / Line 278: @@
 The following classes are currently available:
-{{ :plugin:wrap_plugin_example9.png?300&direct}}
+{{ :plugin:wrap_plugin_example10.png?300&direct}}
 ^ class name  ^ description/notes  ^
@@ Line 211: / Line 286: @@
 | **''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)  |
+| **''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 columns in a row, should be used in triplets  |
+| **''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!  ||
@@ Line 250: / Line 327: @@
 | **''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]]  |
-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.
+  * 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. The following syntax would produce two different kinds of emulated headlines inside any of the columns or boxes/notes:
+  * 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**//%%
@@ Line 272: / Line 348: @@
 ==== 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.
+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'' and ''quarter''. To work correctly they need another wrap around them. E.g.
+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>
@@ Line 304: / Line 380: @@
 ^ Option  ^ Description  ^ Default value ^
-|''noPrefix''  | Which (comma separated) class names should be excluded from being prefixed with "wrap_" | tabs, group |
+|''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 | //(empty)// |
+|''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 |
+|''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 |
 ===== ODT Support =====
+FIXME There have been more updates to the Wrap as well as the ODT plugin, so more stuff works. The below should be updated with what works and what doesn't.
 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:
@@ Line 342: / Line 421: @@
   * "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>%%''
+  * "clear floats" creates a ''%%<WRAP clear/>%%''
   * "especially emphasised, highlighted, less significant" creates the respective marks
@@ Line 356: / Line 435: @@
 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 ====
+====== PageList Plugin ======
+[[https://www.dokuwiki.org/plugin:pagelist]]
-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.
-====== PageList ======
 ===== Description =====
@@ Line 452: / Line 468: @@
 | ''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 |
+| ''showdiff''        ^ ''nodiff''    | no displaying of differences column ^ ''showdiff'' | displays the differences column with the diff icon linking to the corresponding diff page for each row |
+| ''image''        ^ ''noimage''    | show image of the page ^ ''image'' | needs [[pageimage|Pageimage Plugin]] installed. Can either be defined on page or image with same name as page will be used |
 ==== Example ====
@@ Line 475: / Line 492: @@
 ^ ''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 |
+^ ''showimage'' | Shows/hides the image column (requires the [[pageimage|Pageimage Plugin]] |
 ===== Helper Plugin =====
@@ Line 493: / Line 510: @@
   $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>
+====== newpagetemplate plugin ======
+[[https://www.dokuwiki.org/plugin:newpagetemplate]]
+===== Description =====
+This plugin loads into the edit window a template specified in the $_REQUEST “newpagetemplate” parameter. Effectively, this means that you can invoke a template, similar to the namespace template pages, either in the URL or in a POST form coded to create a new page.
+The [[plugin:openas]] plugin and the [[plugin:addnewpage]] plugin provide techniques which support the ''newpagetemplate'' plugin. The [[plugin:openas]] plugin includes a simple method of creating a form designed for use with the ''newpagetemplate'' plugin, making it possible for each user to assign unique values to the template's variables.
+===== Usage =====
+If a new page is created with the URL:
+  doku.php?id=:mynewpage&do=edit&rev=&newpagetemplate=:pagetemplates:yourtemplate&newpagevars=@HI@,Howdy!
+then the '':pagetemplates:yourtemplate'' page is pasted into the edit window.  If the "standardreplace" configuration option is true, then the substitutions noted below are performed.  If the "userreplace" configuration option is true, then you can also replace ''@HI@'' with ''Howdy!'', as this substitution was passed in newpagevars.  The format for newpagevars is:
+   newpagevars=key,value;key2,value2;key3,value3;
+See [[#configuration_options]] and [[#substitutions]] for a description of the standard and user replacements.
+===Example of syntax for a template page==
+If you create a template page ''yourtemplate'' with this markup in '':pagetemplates:''
+  This page is: @ID@
+  @HI@ @NAME@
+And if you paste the above URL into your browser's location bar, you will get a page in your browser that looks something like this:
+  This page is: mynewpage
+  Howdy! Joe
+''@ID@'' is one of the 'standardreplace' macros and ''@HI@'' is a 'userreplace' marcro.
+=== How to create a link using wiki syntax===
+Is it possible to use standard wiki-link syntax for this? For eg. like:
+  [[:mynewpage?do=edit&rev=&newpagetemplate=:pagetemplates:homepagetemplate&newpagevars=@HI@,Howdy!|New page with template]]
+Yes, you can do this. But you will have to substitute some url-encoded characters.  In particular, the comma must be represented as ''%2c''. So this would give you:
+  &newpagevars=@HI@%2CHowdy
+You may find with use that there are others.
+==== Substitutions ====
+As with the ''_template.txt'' [[:namespace_templates|namespace templates]], the following variables are replaced in your template.
+^ @ID@              | full ID of the page                                                                  |
+^ @NS@              | namespace of the page                                                                |
+^ @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                                              |
+^ @DATE@            | date and time when edit session started                                              |
+| %a %d-%m-%y etc.  | e.g. Thu 06-12-12. [[php>Strftime]] placeholders are replaced by page creation time  |
+===== Configuration Options =====
+^ userreplace        | Replace user defined macros as explained above in [[#usage]]                                           |
+^ standardreplace    | Replace standard macros as listed above in [[#substitutions]]                                          |
+^ prettytitles       | Replace underscores with spaces in the following standard macros %%@!PAGE@, @!!PAGE@,@!PAGE!@%%        |
+| skip_unset_macros  | Remove macros which have no substitution values, so that they don't appear in the newly created page.  |
+The ''prettytitles'' patch was contributed by  Matthias Bannach.