Differences

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

--- wiki:explugins [2016/03/07 01:59]
madsiur [External Plugins installed]
+++ wiki:explugins [2018/12/13 12:54]
madsiur [Image Gallery]
@@ Line 1: / Line 1: @@
+====== Gallery Plugin ======
+[[https://www.dokuwiki.org/plugin:gallery]]
-===== Image Gallery =====
 ===== Syntax =====
-A basic gallery can be added by selecting a [[:namespaces|namespace]] like this:
+A basic gallery can be added by selecting a [[https://www.dokuwiki.org/namespaces|namespace]] like this:
   {{gallery>:namespace}}
@@ Line 29: / Line 28: @@
 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 [[config:fetchsize]] big enough to get the remote images downloaded.
+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 ====
@@ Line 42: / Line 41: @@
 | ''+//<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 [[:caching|cache]]. To disable the cache for the page showing the gallery, set ''nocache'' as option. |
+| ''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 |
@@ Line 84: / Line 83: @@
 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 [[: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.
+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 [[:exif|EXIF and IPTC metadata]] for details. By default, the following tags are used:
+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
@@ Line 99: / Line 98: @@
 Uploading images is beyond the scope of this plugin. Do not request any features regarding this.
-  * Use the [[:media manager|media manager popup]] or [[:fullscreen mediamanager|fullscreen media manager]] to upload multiple image at once with compatible browsers, otherwise one by one.
+  * 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 [[plugin:archiveupload]] plugin to upload multiple images in a Zip file
+  * 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 [[:pagenames]], all lowercase, no spaces or special chars!
+  * 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 [[:caching]] for details.
+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).
@@ Line 111: / Line 112: @@
 ==== EXIF Data Problems ====
-Problems with accessing [[: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.
+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 [[faq:toolbar]]. Also make sure you don't have any conflicting plugin installed. You should **not** install any additional lightbox plugin.
+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 ====
@@ Line 121: / Line 122: @@
 There are different reasons why thumbnails are not created:
-  * libGD extension is missing => Install the extension or configure DokuWiki to use [[config:im_convert|imagemagick]]
+  * 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
@@ Line 130: / Line 131: @@
 ==== External Images are not Resized ====
-As written above, you need to increase the [[config:fetchsize]] config option. Also make sure LibGD or ImageMagick are installed.
+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 =====
@@ Line 136: / Line 137: @@
 Here are a few user provided examples of the gallery plugin in use:
-  * http://www.wikipeixes.com.br/  FIXME
+  * 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
-  * http://urbangirlblue.org/ecscc/doku.php  FIXME
+====== 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''
@@ Line 154: / Line 284: @@
 It potentially replaces a lot of other plugins and is IMHO the better alternative for many.
-It fully replaces: [[class]], [[clearfloat]], [[div_span_shorthand]], [[divalign2]], [[divalign]], [[emphasis]], [[hide]], [[important_paragraf]], [[importanttext]], [[lang]], [[ltr]], [[noprint]], [[pagebreak]], [[side_note]], [[tip]], [[wpre]]
-It partly replaces: [[box]], [[button]], [[color]], [[columns]], [[fontcolor]], [[fontfamily]], [[fontsize2]], [[fontsize]], [[highlight]], [[layout]], [[note]], [[styler]], [[tab]], [[tablewidth]], [[typography]]
 ===== Syntax =====
@@ Line 420: / Line 549: @@
-====== PageList ======
+===== 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 =====
@@ Line 493: / Line 649: @@
   $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}}