Difference between revisions of "DokuWiki Migration"

(Add a guide for converting imagejdocu -> imagej.net)
(No difference)

Revision as of 16:51, 4 January 2020

The ImageJ Documentation Wiki will no longer be available at location https://imagejdocu.tudor.lu, as the CRP Henri Tudor has merged to become the Luxembourg Institute of Science and Technology five years ago and the old domain will be discontinued. We want to take this as an opportunity to merge the resources on https://imagejdocu.tudor.lu with those here at https://imagej.net.

This guide covers the process of migrating a page from the ImageJ Documentation Wiki (DocuWiki) to this ImageJ wiki (MediaWiki).

  1. Create an ImageJ wiki account if you do not already have one, by visiting the Special:CreateAccount page.
  2. Identify the ImageJ Documentation Wiki page you are migrating. For this walkthrough, we'll choose the Colocalization Finder page.
  3. Grab the path to the page by selecting it in the address bar and copying it to the clipboard. Here, this is plugin/analysis/colocalizationfinder/start.
  4. Grab the converted MediaWiki markup. We have done a preliminary conversion of the wiki markup from DocuWiki format to MediaWiki format, and placed it online for you. Find your converted page at https://raw.githubusercontent.com/imagej/imagejdocu/master/[your-page].wiki, replacing [your-page] with the snippet from the previous step. For Colocalization Finder, the URL will be https://raw.githubusercontent.com/imagej/imagejdocu/master/plugin/analysis/colocalizationfinder/start.wiki. Copy the entire markup code to your clipboard.
  5. Navigate to the destination ImageJ wiki page. On the ImageJ wiki, page names are capitalized with underscores. (Underscores become spaces in the page title.) For our migrated Colocalization Finder page, we'll use https://imagej.net/Colocalization_Finder. You should see a message like this:
    Creating-a-new-page.png
    Click "edit this page" to continue.
  6. Paste the converted wiki markup into the empty text area:
    Add-wiki-markup.png
  7. Preview the results. Scroll down below the text field, and click the "Show preview" button (in between "Save page" and "Show changes").
  8. Migrate needed images:
    1. Right-click and "Save Image As..." the images from your page on the ImageJ Documentation Wiki. For Colocalization Finder, there are two images: cf_images.png and cf_table.png.
    2. In a separate browser tab, open the Special:Upload page and upload the images one by one. The Colocalization Finder images will become available from URLs https://imagej.net/File:Cf_images.png and https://imagej.net/File:Cf_table.png. Notice that MediaWiki always capitalizes the first letter of resources, including image files.
    3. Back in our new Colocalization Finder page, we now replace the DocuWiki image link syntax with MediaWiki's syntax: e.g. {{:plugin:analysis:colocalizationfinder:cf_images.png?nolink&400|}} becomes [[File:Cf_images.png|400px|link=]]. See MediaWiki's Help:Images page for further details on formatting your images.
  9. Fix any remaining errors and imperfections. Inspect the rendered page, noting any problems. Then scroll down below the page to find the text box containing the wiki markup code.
  10. Click "Show preview" again, as many times as needed, until everything looks good.
  11. Save the page when finished. The "Save page" button locks in your new page!