Skip to content

Rhaptos Software Development

Personal tools
You are here: Home » Developer Blog » Brian's Sooth » Word Importer Best Practices

Word Importer Best Practices Word Importer Best Practices

Document Actions
Submitted by bnwest. on 2007-06-20 17:30. Documentation
Word Importer Best Practices

Our import process geneates the following CNXML tags:

  • <section>
  • <name>
  • <para>
  • <quote>
  • <list>
  • <item>
  • <note>
  • <figure>
  • <media>
  • <param>
  • <emphasis>
  • <code>
  • <table>, <tgroup>, <tbody>, <row>
  • <link>


DOs

  1. Use the CNX Word Template. This is documented somewhere on cnx.org. Using the Word Templte should facilitate the import of the CNXML tags: <cite>, <code>, <emphasis>, <foreign>, <quote> and <term>.
  2. Use the default Word equation editor for all math (especially subscripts and supescripts), so that MathML will be imported.
  3. Use the default Word styles.  Creating user defined Word styles may cause import problems.
  4. Use browser supported image types and not .wmf and .svg files.
  5. Use only straight forward tables.


DON'Ts

  1. Do not use MathType 5.0 equation Editor, since all of the MathType 5.0 equations will not be imported. After import, MathType 5.0 equation be copy from MathType 5.0 to the system clipboard (Elizabeth documented this, but I am unsure if that made to cnx.org) and pasted into the CNXML.
  2. Do not use lists or tables to format the document.  These constructs are literally imported.
  3. Do not add line breaks via cntl-Enter.
  4. Do not use tab-s.
  5. Do not have separate lists which use the same numbering, i.e. continue numbering across separate lists.
  6. Do not have lists or multiple paragraphs as a single table entry.
  7. Do not bold/italized/underline text.
  8. Do not use images that are hyperlinked.  Use local images.
  9. Do not use the 'wingding' font.
  10. Do not highlight multiple lines of code and format them "CNXML Code".


Re: Word Importer Best Practices

Posted by kef at 2007-06-21 12:30
CNXML .6 is going to help some of these. I am going to forward the new suggestions to Brian and Ray so that you can annotate some of this with what will be improved by moving to CNXML .6

Re: Re: Word Importer Best Practices

Posted by kef at 2007-06-21 12:32
Also, the current import process only supports one version of code and quote -- either inline or block. Make sure and document these carefully and also I think this would be a good area to improve the template.

Also, why not import all the bold as emphasis?
Developer Blog
« July 2008 »
Su Mo Tu We Th Fr Sa
    1 2 3 4 5
6 7 8 9 10 11 12
13 14 15 16 17 18 19
20 21 22 23 24 25 26
27 28 29 30 31    
2008-07-02
12:53-12:53 Performance tests of module PDF generation
Categories:
Content (55)
Copyright (0)
Deep Code (3)
Development (198)
Markup (22)
Metadata (1)
Printing (7)
Style (9)
Testing (2)
Usability (6)