====== wordimport Plugin ======

---- plugin ----
description: Import Microsoft Word Documents into DokuWiki
author     : Andreas Gohr
email      : dokuwiki@cosmocode.de
type       : action, cli
lastupdate : 2024-07-25
compatible : Kaos
depends    : 
conflicts  : 
similar    : 
tags       : word, docx, import

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-wordimport/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-wordimport/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-wordimport/
donationurl: 

screenshot_img : # URL to a screenshot of the plugin in action
----

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

This plugin allows you to import Microsoft Word documents as pages into the Wiki. The contents are converted into DokuWiki Syntax.

Currently implemented Features:

  * Headers
  * Basic text formatting
  * Tables
  * Lists
  * Images (imported as media files)
  * Code Blocks (detected by monospace font)


===== Installation =====

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

===== Usage =====

Once installed a new icon is displayed in the page menu. Clicking it opens a dialog to upload a word document. It is imported as a new revision of the current page.

The import button is only shown for users with DELETE permissions to the current namespace.
===== Configuration and Settings =====

Word has no predefined style for code blocks. So they are detected by a certain font applied to a whole paragraph. Which fonts are recognized can be set in the config settings

===== Limitations =====

You need to use proper semantic styling for your headers. Eg. mark them as "Heading 1" instead of just formatting them as big and bold.

Stuff that might be interpreted as Wiki syntax in your word doc will be imported as is. Might be worth to see if we could at least escape some common things. Contact us if that's of interest to you.

Many things that DokuWiki understands (eg. Links, Footnotes, etc) are currently not imported. Feel free to hire us if you're missing something.

The word parser is written from scratch. It might not cover all the details of the format. Best keep your docs simple.

Only the new .docx Format is supported.