Web Manuals has developed a convenient function that allows the users to import/convert existing Microsoft Word documents (“.doc/.docx”) into the Web Manuals environment. This is a quick guide on how to edit pre-existing documents before converting the Word-documents into a web-based format. The import function interprets the original document and then, based on these interpretations, it creates a strikingly similar copy of the docuemtn in the Web Manuals system.
The purpose of pre-editing the Word documents before commencing the import, is to save time for the post-import editing. This guide will set guidelines on how the Word document should be setup before importing. Also note that it’s possible to import documents which do not follow these exact standards that are presented below.
It is required to the user performing the import has a Google Chrome browser with an Internet connection and a proper level of access to the Web Manuals system.
Import Process Chart
Start off by editing the Word document according to the recommended format settings by reading this manual. The goal is to minimize the time spent at the Post-Editing stage.
When the document is as close as possible to the recommended settings, the document is ready for import.
After each import, it will always take a bit of time to edit pages for minor issues. Most of the issues are been covered here in this manual.
The final stage of the import procedure is to verify that each module is up-to-date and then check for simple errors.
The import function aims to support the following formats in a Word document:
- Text formatting bold, italic, underline
- Bulleted lists
- Numbered lists
- Images (but not all options on positioning the image)
- Simple tables
The following formatting options in a Word document will or may not be properly imported:
- Tables with complex layouts
- Contents in Headings / footers
- Foot notes
- Fonts (Will be replaced by predefined defaults)
- Indents (Better to apply these manually)
- Dotted tabs
- Hyperlinks (Add manually after the import)
- Track changes
The file formats that is supported by this function are currently .doc (2003 and older Word documents) and the newer .docx (2007 and newer Word documents). The first thing you should do is to open the document that is supposed to be imported and then Save as and create a new identical document with a new name. This is mainly to avoid accidentally destroying the original file.
Web Manuals plan for the future is to also support to import other file format, such as the various
Adobe InDesign formats.
Set correct headings
The single most important thing to consider when starting configuring the Word documents for import is to
set the correct title headings.
This is a screenshot from the default headings of Word 2013.
Also note that these headings must be named exactly as the Word defaults, Heading 1, Heading 2, etc. Otherwise they will be imported incorrectly. Since these heading names are included in the default styles for Word, it should not be difficult to find these heading style sheets. If the manuals are using other custom-made headings, please change all the heading instances to the corresponding headings that you see on the screenshot above.
The list below is the most important things to think about:
- Heading 1:
This is the most important heading, since it will set the basic page structure in the system. All pages under this heading will be sub-pages to that page that contains the Heading 1. Set this heading on the first page of each chapter. The Headings 1 title that you write on the first chapter page will also disappear as text and be put in the chapter title Headings, which is at the top of each chapter page. The first Heading 1 will become Chapter 1-0… and the second Heading 1 will become Chapter 2-0…, assuming 0-n as page numbering format.
- Headings 2, 3, etc:
Using the other heading styles, will put them as sub-pages to the most recent Heading 1 chapter page. Until the next chapter starts, then the next pages will become sub pages to that chapter. The numbering on the imported manual will be like the familiar format 2.1 (Headings 2), 2.1.1 (Headings 3), 184.108.40.206 (Headings 4). The screenshot below will illustrate on how this might work on the internal
This is an example on how page structures can look like, after import, assuming 0-n numbering format.
In the example above, the second chapter of this manual was called Limitations and used Heading 1 and therefore the page 2-1 Limitations was created. The next page 2-2 Limitations did not start with a new Headings level and therefore it is named the same again. The reason for this can be that there is some kind of module on that page, such as the Table of Content. But the following pages contains other subheadings, for example 2.1 General on page 2-3 General. When the next chapter begins Normal Procedures, it creates a new tree of sub pages, just like the previous one.
Remove numbers in headings
Remove all numbers in the headings and numbered lists on the document that are supposed to be imported. The Web Manuals import function does not need those numbers, so unless the heading numbers are removed, they will be included in the import and headings will be numbered twice.
If Word is automatically generating heading numbers, right click on the heading style in the Styles box in Word and select modify and remove the numbering.
The text format will not be imported into the Web Manuals system. The text format will be the pre-defined format that the customer sets for their site. This means that not much consideration has to be taken into account, when setting the text format on the text. However, if the font or text size differs too much from the pre-defined format at Web Manuals than the pages might need some re-balancing of the text.
Hyperlinks is something that needs to be edited manually afterwards. Remove footnotes, since they can be imported, but not as footnotes.
Indentation and numbering
Please consider removing unnecessary indents, both in the text of in the headings before importing. The import function does support indentation, to a certain extent, but it’s not as reliable as it should be right now. So the most consistent way is to manually input indentation afterwards, if needed.
Some customers use numbered/bulleted lists to create artificial indents inside the manual, these should also be removed due for the same reasons stated before.
Also note that the current beta version doesn’t properly translate numbered lists such as “a, b, c” properly. Instead the lists will become “1, 2, 3” (or whatever has been configured as your default numbering scheme) when the document is imported. This easily fixed manually later on in Web Manuals, by right clicking the list properties in the section editor.
There are a number of reasons why the import can't handle certain types of images. When this happens, do as follows:
- Screenshot the page and use a program like Paint to crop the image correctly and save it.
- Go to the correct page in the document and upload the image, using the tool in the text section to add the picture. Here you find detailed instructions of how to upload an image.
- Click on the Upload tab and then browse to save image.
- Select the width to be 700 (which is normally the width of a default manual page), this may differ
depending in which context the pictures has.
This image illustrates our Image Properties found in the text section module.
Dotted underlines are not suitable for web-based environments. There a solution for this in Web Manuals, but it is not as good as the decimal tabs in Word. Before importing, remove any dotted/decimal tabs.
Word has a built-in function to allow the editor to create revisionary comments on each change, much like Web Manuals, however these comments must be removed before commencing the import. The import function will include all hidden revision comments in the import, which means that all comments should be removed to decrease the post-import editing.
Creating a template table
One of the main challenges with document import from Word is the matter of advanced/complex tables. Unfortunately, the import function has trouble importing these types of tables.
One solution is to create a revised form of that type of table and use it as a template. It may be slightly tricky to adjust these tables as it does require some time and effort to create a good template to use for revising multiple complex tables of the same kind. Extensive experience with Word and Web Manuals will help the importer to understand and get a better result eventually. Down below an example with be described, regarding common Minimum Equipment Lists (MEL):
- Leave the table unchanged in the Word document and just import them as they are. The purpose of this is just to get the correct number of pages when importing the document.
- After the import, delete the sections with imported tables, but keep the pages.
- Then create a template of the table in MS Word, based on the original table.
- Firstly, show every border of the table (the current editor for tables cannot hide specific borders of cells).
- Secondly, right click on the table in Word and select width to 100%. Then copy the table into the page in the Web Manuals application, the width will automatically be correct.
- After creating the template, select the whole table and copy it (Ctrl+C) from Word and then paste it (Ctrl+V) into the text editor at the manual page. Check that it looks good and tweak some minor things if needed.
Another benefit of having a template is that it’s possible to re-use the template for other complex tables in Word. Additionally the user can use the template to all complex tables by copying and pasting the information for each table into the template and then copying the table into the manual page.
Look at the example below; compare the original to the template, to see how a template can look like:
The left picture is the original and the right picture is the table of that very same table.
Built-in MEL tables
Instead of creating the MELs yourself (which can be a tedious task) you can use the template MELs that are built-in for Web Manuals. At the time of writing there are about 100 pieces of MELs in different categories to choose from.
To add a MEL do the following:
- Click the icon Add MEL in the menu.
- Choose MEL Style (Portrait, Portrait Compact, Landscape or Landscape Compact).
- Type the number of rows.
- Choose a ATA Chapter.
- Click OK to add the MEL to the page.
- Fill in the data in the fields and Save the page.
Adding a MEL from the text section menu.
An added MEL where we have just started to type data in the fields.
Convert Multi-column Lists into tables
There are some situations when importing text lists that do not work very well, one such example is the advanced multi-column lists.
One solution to this is to convert multi-column lists into tables before importing. There are functionalities in MS Word that are helpful to the user with that specific conversion, called Insert table, usually found under the Insert tab.
To use this table conversion, do the following:
- Select the area of the list.
- Click the Insert table function.
- Adjust table borders to get the desired look.
- Import the document, be ready for some post-editing as well.
If this is done properly, then it will save time, but if it’s too complicated or the list-to-table conversion is not working properly, then look at the second solution down below. It is possible to hide borders inside Web Manuals.
Manually create Multi-column Lists with tables
Another solution is to manually create the table with our easy-to-use table tools in the text section module. Usually there are some type post-import editing when it comes to tables anyway.
Regardless of which solution the you choose to use, please leave the table just as it is, since it will create a page for it anyway, which have to be done regardless and it is easy to delete the content afterwards if the you choose to start over.
This list is an example of what type of list that would benefit from making into a table before importing.
The table above should most likely become a six column table. Since it can be tricky to convert these type of lists into tables, it would be beneficial if the editor is quite Word-savvy.
Checklist is a feature you find in the text module that lets you create checklists. These lists use dotted lines to make them easy to read.
To create a checklist you do the following:
- Click at the checklist icon in the menu.
- Choose Checklist Style (Plain, Bullets, Numbered).
- Type number of rows.
- Click OK to add the checklist to the page.
- Fill in the data in the fields and Save the page.
Adding a checklist from the text section menu
An example of a checklist.
When the Word document is ready for import and modified according to these recommendations, continue with this step. There are two possible ways to import the manual, either by importing the whole manual all at once or by importing each chapter one at a time. Either way you need to start with creating a new document with the appropriate settings (no pre-defined page structure, the document should only have one page) or open up a document you want to add imported content to.
Complete document import
The first option is to import one complete Word document, this is the easiest and most straight-forward option. However, it comes with a few risks as well, since there will be more to verify and import at the same time, which takes longer and there is a risk that one forgets smaller tasks within the big document. Once the target manual is
ready for import, then you can start the import.
- Click Choose File and select the Word document to be imported.
- Select Use Heading 1 as chapter dividers.
- Select whether or not to include table borders. If complex tables are not created correctly try this, which will create the tables with a different processing tool. It will however prolong the import time.
- Click Import to start the import.
Partial manual import
The second option is to split each chapter into its own Word document and import each chapter one at a time. Each chapter/document should start with “Heading 1” on the first page to ensure that the page structure after the import will still be correct.
Follow the steps under Complete document import but select Import file as a new chapter instead, and give the chapter a name. It is easier to work with one chapter at a time, and the editor gets the chance to apply new insights, tips and tricks to change to the following documents before importing them as well. It is also beneficial if the editor accidently imported the wrong chapter, then it just has to delete that chapter and not the whole manual.
However, be careful so that you don’t import a full manual as a chapter, as the page structure will be troublesome to restore.
After you have started the import of your word document a progress bar will be displayed.
Once the import is finished the system will inform you and give you instructions on how to proceed.
Copy from document
Instead of importing content from a Word document you can import content from another Web document. To do this click Copy from document, choose Document and Page (not mandatory). Click Import to copy/import the content from the document.
Remember that not all of these consideration might be suitable or needed for your specific document. The purpose of this guide is to save time and in some cases, it might be faster to adjust post-import than pre-import. Creating solutions for advanced tables for instance can save a lot of time if the target document consist of many of its type, but if it is only one advanced document, then it might be faster to just create one manually within the system itself. The key is to be systematic and consider the trade-offs of risks and benefits when editing documents before and after import.