git.oblomov.eu Git - ikiwiki/blob - doc/tips/convert_MoinMoin_to_ikiwiki.mdwn

   1 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.
   2
   3 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).
   4
   5 The MoinMoin side of things was completely re-written by [[anarcat]] and is currently still in development. That version is available at:
   6
   7     git clone git://src.anarcat.ath.cx/moin2iki
   8
   9 It doesn't feature support to migrate from Tikiwiki anymore and focuses on MoinMoin support.
  10
  11 The software is made of two pieces:
  12
  13  * the importer (`moin2git`) - which converts the wiki pages into a git repository with full history
  14  * the converter (`moin2mdwn`) - which converts a set of moin-formatted text files into markdown + ikiwiki directives
  15
  16 ## MoinMoin importer features
  17
  18  * supports latest MoinMoin versions (tested with 1.9.x)
  19  * uses `git fast-import` to improve performance (10 minutes and 200M of ram for a 7 years old 2GB Moinmoin wiki)
  20  * multistep process allows bulk edit through git before markdown conversion, or staying with a
  21  * imports attachments as subpages
  22  * uses the per-page edit log
  23  * consistent: multiple runs will generate the same repository
  24  * re-entrant: can be run multiple times to import new changes
  25
  26 ## MoinMoin converter features
  27
  28  * most of the inline markup
  29  * links
  30  * attachment links
  31  * smileys
  32  * images (not well tested), into [[ikiwiki/directive/img]]
  33  * preformatted and code areas, including [[ikiwiki/directive/format]]
  34  * ordered, unordered and definition lists
  35  * tables (although only with HTML and no styles)
  36
  37 ### Supported macros
  38
  39  * TableOfContents, through [[ikiwiki/directive/toc]]
  40  * Navigation, through [[ikiwiki/directive/map]] (so as a nested
  41    vertical list instead of an horizontal list)
  42  * PageList, through [[ikiwiki/directive/map]]
  43  * MonthCalendar, partially, through [[ikiwiki/directive/calendar]]
  44  * FootNote, through markdown
  45  * Anchor, through markdown and plain HTML
  46  * `<<BR>>`, through the weird line ending thing
  47  * AttachList, through a weird [[ikiwiki/directive/inline]]
  48  * FullSearch, partially, only through [[ikiwiki/directive/inline]] (so no textual search)
  49  * Include, partially through [[ikiwiki/directive/inline]] (so missing boundary extraction and heading level generation)
  50  * PageCount, same name even :)
  51  * OrphanedPages, through [[ikiwiki/directive/oprhans]]
  52
  53 ### Supported parsers
  54
  55  * the main "moin wiki" markup
  56  * highlight parser, through the [[plugins/format]] plugin
  57  * other parsers may be supported if an equivalent plugin exists in Ikiwiki (example: [[plugin/rst]])
  58
  59 ## Current blocker and todos
  60
  61 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:
  62
  63  * 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
  64
  65 There are also significant pieces missing:
  66
  67  * inline parsers and hackish styled tables
  68  * turn categories into tags
  69  * name converted page to the right name depending on the `#format` parameter on top of page
  70  * finish a full converter run on the Koumbitwiki
  71  * improve the output of the converter (too much debugging)
  72
  73 ## MoinMoin features missing from ikiwiki
  74
  75 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.
  76
  77  * [[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
  78  * [[todo/internal_definition_list_support/]] - includes tabling the results ([MoinMoin's DictColumns macro](http://moinmo.in/MacroMarket/DictColumns))
  79  * [[todo/per page ACLs]] - ([MoinMoin's ACLs](http://moinmo.in/HelpOnAccessControlLists))
  80  * [MailTo](http://moinmo.in/HelpOnMacros/MailTo) macro spam protection
  81  * list pages based on full text page search
  82  * extract part of other pages with the inline macro
  83  * specifying a template when creating a page (as opposed to matching a pagespec)
  84  * specifying a style for a sub-section (MoinMoin's inline parsers
  85    allow the user to specify a CSS class - very useful see
  86    [the documentation](http://moinmo.in/HelpOnMoinWikiSyntax#Using_the_wiki_parser_with_css_classes)
  87    to get an idea)
  88  * the above also keeps the SectionParser from being properly supported
  89  * regex matching all over the place: pagespec, basically, but all
  90    full text search (which is missing anyways, see above)
  91
  92 Missing macros:
  93
  94  * RandomPage(N) - lists N random pages, skipped
  95  * Gallery() - skipped
  96  * Gettext - translates the string accordign to internal translation
  97    system, ignored
  98  * AdvancedSearch - an elaborate search form provided by MoinMoin
  99  * Goto - a simple "jump to page" macro
 100
 101 Comments and feedback always welcome! --[[anarcat]]