doc/tips/convert_moinmoin_to_ikiwiki.mdwn

   1 [[!meta date="2008-10-20 16:55:39 -0400"]]
   2
   3 This MoinMoin converter converts wikis to ikiwikis backed by a git repository, including full history. It simply parses the wiki pages into markdown using the MoinMoin engine.
   4
   5 The converter was originally written by [[JoshTriplett]] and included support for Tikiwiki, for which it parses the wiki pages to HTML then back into markdown using the `libhtml-wikiconverter` Perl package. That original version from Josh is still available from [his wiki page](/users/JoshTriplett).
   6
   7 The MoinMoin side of things was completely re-written by [[anarcat]] and is currently still in development. That version is available at:
   8
   9     git clone https://gitlab.com/anarcat/moin2iki/
  10
  11 It doesn't feature support to migrate from Tikiwiki anymore and focuses on MoinMoin support.
  12
  13 Issues can be filed on the [project page](https://gitlab.com/anarcat/moin2iki/).
  14
  15 [[!toc levels=2]]
  16
  17 ## Usage
  18
  19 Usage instructions are in the `README` file.
  20
  21 ## MoinMoin importer features
  22
  23  * supports latest MoinMoin versions (tested with 1.9.x)
  24  * uses `git fast-import` to improve performance (10 minutes and 200M of ram for a 7 years old 2GB Moinmoin wiki)
  25  * multistep process allows bulk edit through git before markdown conversion, or staying with a
  26  * imports attachments as subpages
  27  * uses the per-page edit log
  28  * consistent: multiple runs will generate the same repository
  29  * re-entrant: can be run multiple times to import new changes
  30
  31 ## MoinMoin converter features
  32
  33  * most of the inline markup
  34  * links
  35  * attachment links
  36  * smileys
  37  * images (not well tested), into [[ikiwiki/directive/img]]
  38  * preformatted and code areas, including [[ikiwiki/directive/format]]
  39  * ordered, unordered and definition lists
  40  * tables (although only with HTML and no styles)
  41
  42 ### Supported macros
  43
  44  * TableOfContents, through [[ikiwiki/directive/toc]]
  45  * Navigation, through [[ikiwiki/directive/map]] (so as a nested
  46    vertical list instead of an horizontal list)
  47  * PageList, through [[ikiwiki/directive/map]]
  48  * MonthCalendar, partially, through [[ikiwiki/directive/calendar]]
  49  * FootNote, through multimarkdown (`[^foo]` → `[^foo]: this is the footnote`)
  50  * Anchor, through markdown and plain HTML
  51  * `<<BR>>`, through the weird line ending thing
  52  * AttachList, through a weird [[ikiwiki/directive/inline]]
  53  * FullSearch, partially, only through [[ikiwiki/directive/inline]] (so no textual search)
  54  * Include, partially through [[ikiwiki/directive/inline]] (so missing boundary extraction and heading level generation)
  55  * PageCount, same name even :)
  56  * OrphanedPages, through [[ikiwiki/directive/orphans]]
  57  * Date and Datetime, should be through [[plugins/date]] instead of
  58    current hack
  59
  60 ### Supported parsers
  61
  62  * the main "moin wiki" markup
  63  * highlight parser, through the [[plugins/format]] plugin
  64  * other parsers may be supported if an equivalent plugin exists in Ikiwiki (example: [[plugins/rst]])
  65
  66 ## Current blocker
  67
  68 This script is being used to test the conversion of the venerable [Koumbit wiki](https://wiki.koumbit.net/) into Ikiwiki, and so far progress is steady but difficult. The current blocker is:
  69
  70  * figuring out exactly which pages should exist and which should not, as there is ambiguity in the internal datastructures of MoinMoin, which become apparent when running the conversion script, as files a missing
  71
  72 ## Todos
  73
  74 There are also significant pieces missing:
  75
  76  * inline parsers and hackish styled tables
  77  * turn categories into tags
  78  * name converted page to the right name depending on the `#format` parameter on top of page
  79  * finish a full converter run on the Koumbitwiki
  80  * improve the output of the converter (too much debugging)
  81
  82 ## MoinMoin features missing from ikiwiki
  83
  84 The importer is pretty much complete, but the converter can only go so far as what features ikiwiki supports. Here are the MoinMoin features that are known to be missing from ikiwiki. Note that some of those features are available in MoinMoin only through third-party extensions.
  85
  86  * [[todo/do_not_make_links_backwards/]] - MoinMoin and Creole use `\[[link|text]]`, while ikiwiki uses `\[[text|link]]` - for now the converter generates [[markdown]] links so this is not so much an issue, but will freak out users
  87  * [[todo/internal_definition_list_support/]] - includes tabling the results ([MoinMoin's DictColumns macro](http://moinmo.in/MacroMarket/DictColumns))
  88  * [[todo/per page ACLs]] - ([MoinMoin's ACLs](http://moinmo.in/HelpOnAccessControlLists))
  89  * [MailTo](http://moinmo.in/HelpOnMacros/MailTo) macro spam protection
  90  * list pages based on full text page search
  91  * extract part of other pages with the inline macro
  92  * specifying a template when creating a page (as opposed to matching a pagespec)
  93  * specifying a style for a sub-section (MoinMoin's inline parsers
  94    allow the user to specify a CSS class - very useful see
  95    [the documentation](http://moinmo.in/HelpOnMoinWikiSyntax#Using_the_wiki_parser_with_css_classes)
  96    to get an idea)
  97  * the above also keeps the SectionParser from being properly supported
  98  * regex matching all over the place: pagespec, basically, but all
  99    full text search (which is missing anyways, see above)
 100
 101 ### Missing macros
 102
 103  * RandomPage(N) - lists N random pages, skipped
 104  * Gallery() - skipped
 105  * Gettext - translates the string accordign to internal translation
 106    system, ignored
 107  * AdvancedSearch - an elaborate search form provided by MoinMoin
 108  * Goto - a simple "jump to page" macro
 109
 110 Comments and feedback always welcome! --[[anarcat]]