www-apps/pmwiki/cookbook/XMLPageStore/readme.txt

   1 >>recipeinfo<<
   2 Summary: Store pages as XML files
   3 Version: 2011-04-21
   4 Prerequisites:
   5 Status: Beta
   6 Maintainer:  [[~Anomen]]
   7 Categories: [[!Administration]], [[!CustomPageStore]]
   8 Users: {$Users} ([[{$FullName}-Users|view]] / [[{$FullName}-Users?action=edit|edit]])
   9 Discussion: [[{$Name}-Talk]]
  10 >><<
  11 !! Questions answered by this recipe
  12 Store pages as XML.
  13
  14 Advantages:
  15 * pages easily editable in plain text editor
  16 * better handled by versioning systems (text is no longer single long line)
  17 * export/import pages using various tools with XML support
  18
  19 [[#desc]]
  20 !! Description
  21 The Attach:XMLPageStore.php script stores pmwiki pages into xml files in the ''wiki.d/'' directory.
  22
  23 The recipe is still under development, so use direct link to git repository:
  24 [[http://repo.or.cz/w/anomen-overlay.git/blob_plain/HEAD:/www-apps/pmwiki/cookbook/XMLPageStore/XMLPageStore.php | XMLPageStore.php]]
  25
  26 [[#install]]
  27 !! Installation
  28 To use this script, simply place it in your ''cookbook'' directory and add the following lines to ''local/config.php'':
  29
  30 [@
  31   $EnablePageStoreXML = 1;
  32   include_once('cookbook/XMLPageStore.php');
  33   $WikiDir = new XMLPageStore('wiki.d/{$FullName}');
  34 @]
  35
  36 There's no need to convert or modify your existing pages;
  37 ''xmlpagestore.php'' can read existing  pages without any difficulty.
  38 As pages are edited and saved, they will be then saved as XML files in ''wiki.d/''.
  39 Please make sure the above cookbook script is loaded before other scripts.
  40
  41 [[#config]]
  42 !! Configuration
  43 Use @@$EnablePageStoreXML@@ variable to enable/disable writing xml files.
  44
  45 [[#usage]]
  46 !! Usage
  47
  48 [[#notes]]
  49 !! Notes
  50
  51 [[#relnotes]]
  52 !! Change log / Release notes
  53 * 2011-04-22 15:53 - added to PmWiki Cookbook
  54
  55 [[#seealso]]
  56 !! See also
  57 : git repo : http://repo.or.cz/w/anomen-overlay.git/tree/HEAD:/www-apps/pmwiki/cookbook/XMLPageStore
  58
  59 * [[Category/CustomPageStore]] category
  60
  61 [[#contributors]]
  62 !! Contributors
  63 * [[~Anomen]] - original script
  64
  65 [[#comments]]
  66 !! Comments
  67 See discussion at [[{$Name}-Talk]]
  68
  69 [[#faq]]
  70 >>faq display=none<<
  71
  72 Q:
  73 A: