Differences

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

--- wiki:explugins [2017/09/02 03:04]
madsiur
+++ wiki:explugins [2018/12/13 12:54]
madsiur [Image Gallery]
@@ Line 1: / Line 1: @@
-====== Image Gallery ======
+====== Gallery Plugin ======
+[[https://www.dokuwiki.org/plugin: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 27: / 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 40: / 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 82: / 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 97: / 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.
@@ Line 105: / Line 106: @@
 ==== 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 137: / Line 138: @@
   * http://adam.nz
-  * http://www.wikipeixes.com.br/  FIXME
   * 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 =====
-Be sure to read the [[#Known Limitations and Caveats]] section first. Questions should be asked in the [[http://forum.dokuwiki.org|forum]]. Bugs and feature wishes should be reported in the [[https://github.com/splitbrain/dokuwiki-plugin-gallery/issues|issue tracker]]. Any comments/discussions on this page will be removed.
+====== 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.
@@ Line 226: / Line 268: @@
 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''
-==== Changes ====
-{{rss>https://github.com/splitbrain/dokuwiki-plugin-vshare/commits/master.atom date}}
-Please report bugs and request features at the [[https://github.com/splitbrain/dokuwiki-plugin-vshare/issues|issue tracker]]
@@ Line 244: / 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]]
-===== Installation =====
-Download and install the plugin using the [[plugin:plugin|Plugin Manager]] using the URL given above. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Syntax =====
@@ Line 543: / Line 577: @@
 ====== 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}}