====== Editions Plugin ======

---- plugin ----
description: Compare several editions of the same text in different versions or languages
author     : Anika Henke 
email      : anika@selfthinker.org 
type       : action
lastupdate : 2016-04-03
compatible : 2023-04-04
depends    : purplenumbers
conflicts  : 
similar    : 
tags       : edition comparison version

downloadurl: https://github.com/selfthinker/dokuwiki_plugin_editions/zipball/master
bugtracker : https://github.com/selfthinker/dokuwiki_plugin_editions/issues
sourcerepo : https://github.com/selfthinker/dokuwiki_plugin_editions
donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=11071728

screenshot_img : 
----

===== Installation =====

Before this plugin can be used, you need to install the [[plugin:purplenumbers|PurpleNumbers plugin]] first.

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Configuration and Settings =====

Add a config file named ''editions.conf'' into [[config#configuration_files|your wiki's "conf" folder]] (not the plugin's "conf" folder) with edition name and language code per row, e.g.
<code>
laforgue        fr
machen          en
conrad          de
</code>

You need to have a certain namespace and page structure, i.e.
  - the edition namespace (configurable via the ''editionNamespace'' config option)
  - needs sub namespaces for each edition
  - all page names must be the same between the different editions
  - all paragraphs need to be in the same order across same pages

Example for a first chapter page:
<code>
edition:laforgue:001
edition:machen:001
edition:conrad:001
</code>

For every edition add one PNG icon (16x16) with the name of the edition as written in ''editions.conf'' to the "images" folder.

==== Settings for PurpleNumbers plugin ====

The [[PurpleNumbers]] plugin needs

  * either ''numbering'' set to ''consecutive'' **and** ''uniqueness'' set to ''page-wide''
  * **or** ''internalID'' needs to be switched on
===== Demo =====

The editions plugin is used on [[http://paralis.org/|Paralis.org]] within each edition of Casanova's Memoirs, e.g. http://paralis.org/edition:machen:001

===== Change Log =====

{{rss>https://github.com/selfthinker/dokuwiki_plugin_editions/commits/master.atom date}}

===== Discussion =====