Commit e452af69 authored by Michael Andrewartha's avatar Michael Andrewartha

added userguide folder and moved documentation, removed html file

parent f60c06cb
<p>This page documents how to use the Document Converter module.</p>
<h2 id="usage">Usage</h2>
<p>Whether the document converter options will appear on your website it depends on how it has been set up. For this manual we will assume the conversion has been allowed globally.</p>
<p>First of all it is important to know that the import process will replace the content of the page your are importing to, and it also has a licence to remove and replace all its children. It will still be possible to get the content back from the version history of the CMS, but it's good to keep that in mind.</p>
<h3 id="interface">Interface</h3>
<div class="figure">
<img src="_images/interface.jpg" /><p class="caption"></p>
</div>
<p>If you upload the document straight away the simplest scenario will be executed:</p>
<ul>
<li>The content of the main page will be replaced by the imported markup</li>
<li>The original document will be removed afterwards</li>
<li>The page will remain in draft mode for you to preview the output</li>
<li>All images that came with the document will be stored in the top level directory of the assets</li>
</ul>
<p>The interface will allow you to fine tune your import options. Import will start as soon as you choose the file to import, so set up the options beforehand. The options are, from top to bottom:</p>
<ul>
<li><em>Split document into pages</em>: scans the document looking for level 1 or level 2 headings and puts each subsection into separate child page. It will cause the conversion process to replace the existing children pages completely. The initial part of the document until the first header occurence will be added to the main page instead.</li>
<li><em>Keep the original document</em>: prevents the removal of the uploaded document. The document will become available in the <em>Files</em> section of the CMS. Also, if the TOC has been enabled, the link will be automatically added to the main page.</li>
<li><em>Choose a folder to save this file</em>: asset directory to be used for storing the original document and the image files that came along with the document.</li>
<li><em>Replace this page with a Table of Contents</em>: will generate the Table of Contents and replace the main page content with it. Caution: this can remove some of the document content that would otherwise be added here (see the <em>Split document into pages</em> option above).</li>
<li><em>Publish modified pages</em>: in addition to performing all other actions it will publish the pages. Reviewing the conversion outcome is advised before publishing, so avoid this option unless you are sure what will be produced.</li>
</ul>
This page documents how to use the Document Converter module.
## Usage
Whether the document converter options will appear on your website it depends on how it has been set up. For this manual we will assume the conversion has been allowed globally.
First of all it is important to know that the import process will replace the content of the page your are importing to, and it also has a licence to remove and replace all its children. It will still be possible to get the content back from the version history of the CMS, but it's good to keep that in mind.
### Interface
![](_images/interface.jpg)
If you upload the document straight away the simplest scenario will be executed:
* The content of the main page will be replaced by the imported markup
* The original document will be removed afterwards
* The page will remain in draft mode for you to preview the output
* All images that came with the document will be stored in the top level directory of the assets
The interface will allow you to fine tune your import options. Import will start as soon as you choose the file to import, so set up the options beforehand. The options are, from top to bottom:
* *Split document into pages*: scans the document looking for level 1 or level 2 headings and
puts each subsection into separate child page. It will cause the conversion process to
replace the existing children pages completely. The initial part of the document until the
first header occurence will be added to the main page instead.
* *Keep the original document*: prevents the removal of the uploaded document. The document will become
available in the *Files* section of the CMS. Also, if the TOC has been enabled, the link will be
automatically added to the main page.
* *Choose a folder to save this file*: asset directory to be used for storing the original document and the
image files that came along with the document.
* *Replace this page with a Table of Contents*: will generate the Table of Contents and replace the main page
content with it. Caution: this can remove some of the document content that would otherwise be added here
(see the *Split document into pages* option above).
* *Publish modified pages*: in addition to performing all other actions it will publish the pages. Reviewing
the conversion outcome is advised before publishing, so avoid this option unless you are sure what will
be produced.
# Document Converter
## Contributing
### Translations
## Translations
Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.
......
title: Importing content from Microsoft Word
summary: You can easily publish Microsoft Word documents to your website using an import feature
## In this section:
* Usage information
* Interface overview
## Before we begin
Make sure that your SilverStripe installation has the documentconverter module installed.
*Warning: If you upload a document, the module will start converting automatically*
### Note:
See [formatting content](https://www.cwp.govt.nz/guides/content-management-system-guides/for-content-editors/en/creating-and-editing-content) if you are looking for instructions on how to copy and paste content from Microsoft Word correctly
You can easily publish Microsoft Word documents to your website using an import feature built into the content management system (CMS). It shall auto-convert the document into HTML pages, and provides an efficient way to upload long documents or multiple webpages of content. Items like tables, images, heading levels, and links are kept, while fonts and visual styles are transformed to the relevant visual styles of your website.
## Usage
Whether the document converter options will appear on your website it depends on how it has been set up. For this manual we will assume the conversion has been allowed globally.
First of all it is important to know that the import process will replace the content of the page your are importing to, and it also has a licence to remove and replace all its children. It will still be possible to get the content back from the version history of the CMS, but it's good to keep that in mind.
To import a document, visit any page of your website inside the CMS, choose the Import tab, and use the form shown below
## Interface
![](_images/interface.jpg)
If you upload the document straight away the simplest scenario will be executed:
* The content of the main page will be replaced by the imported markup
* The original document will be removed afterwards
* The page will remain in draft mode for you to preview the output
* All images that came with the document will be stored in the top level directory of the assets
The interface will allow you to fine tune your import options. Import will start as soon as you choose the file to import, so set up the options beforehand. The options are, from top to bottom:
* *Split document into pages*: scans the document looking for level 1 or level 2 headings and
puts each subsection into separate child page. It will cause the conversion process to
replace the existing children pages completely. The initial part of the document until the first header occurence will be added to the main page instead.
* *Keep the original document*: prevents the removal of the uploaded document. The document will become available in the *Files* section of the CMS. Also, if the TOC has been enabled, the link will be automatically added to the main page.
* *Choose a folder to save this file*: asset directory to be used for storing the original document and the image files that came along with the document.
* *Replace this page with a Table of Contents*: will generate the Table of Contents and replace the main page content with it. Caution: this can remove some of the document content that would otherwise be added here (see the *Split document into pages* option above).
* *Publish modified pages*: in addition to performing all other actions it will publish the pages. Reviewing the conversion outcome is advised before publishing, so avoid this option unless you are sure what will be produced.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment