Docmint - The Documentation CMS

Docmint - The Documentation CMS

Select your language:  
    Search:   
<Importing a publication: Import Export        Export Docmint XML>

Print / Download:
Available languages: English Last update: 2006-02-03 15:25:50

Import from HTML

The publication tree structure is created based on the hierarchy of the headline tags. This mechanism makes sense if you write your documentation in OpenOffice or MS Word using the headlines in the style sheets. When exporting into HTML from these applications, the HTML document will import smoothly into Docmint. RTF does not seem to work.

Also, make sure that your HTML file is in the UTF-8 format. OpenOffice allows you to select this when saving the document.  If anybody knows how to do that in MS Word, please post a comment. Otherwise you might get trouble with your character sets after import, since Docmint supports only UTF-8. You are welcome to change this in the sources. We won't ;)

When you import a new file, you can decide if you want to delete the database or add the imported file as a new tree inside the document tree.

When importing, you have to follow a couple of steps:

  • Language of publication: here you have to select the language of the publication you are importing. There is no possibility to import multilingual publications right now. This will be added later when import and export to XML is implemented.
  • File type: is currently HTML only. The HTML header tags are being used to identify the tree of the publication. The procedure of importing splits the file into chunks, creates articles with these chunks, using the headline text as the article title, memorizing the level of the headline tag and building the tree with the articles just created.
  • Delete anchor tags (links): If you have one long HTML file with internal links, you might want to delete them, otherwise the lead nowhere. If you have external links only, you might want to keep them.
  • Delete image tags (IMG): You should delete them, as they are not imported. There is no mechanism by which the images are also uploaded and placed in the document.
  • File with publication: is the HTML file containing the data.
  • Delete existing database or add as new chapter: Decide if you want to drop the existing database altogether or create a new article in the tree underneath which the sections in your document are being inserted.
  • If new chapter, specify chapter name: If you decide to add the new sections under a new article in the tree, define the title here.
  • Delete special formatting in source (style,face,class,size): Might be useful to kill some of the word processor formatting.

Save and the file will be uploaded and parsed, you will get feedback on what is found and where it is placed. Then the success message and it's all in the database.

TIPP

  • Smart tags: When using Word or OpenOffice to write your documentation, make sure you have the smart tags option switched off to display straight apostrophes only.
  • Single line breaks: Also, make sure that if you include code examples inside the documentation, use the single line breaks not the paragraph breaks. In Word that means: hold down the shift-key while pressing enter for the line break.


add a note add a note User Contributed Notes
Import from HTML
There are no user contributed notes for this page.

<Importing a publication: Import Export Export Docmint XML>

  Last update: 2006-02-03 15:25:50
Website powered by Docmint Last update: 2006-02-03 15:25:50
Total page time: 0.199208021164