Versions Compared

Old Version 7

changes.mady.by.user Robin Dunford

Saved on

compared with

New Version 8

changes.mady.by.user Caitlin Gebhard (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip


Excerpt

This page gives examples of how to set up lists in Word so as to obtain optimal JATS XML. In particular, correct application of list labels and use of list levels are discussed.


See also List Styles for more information about the use of individual eXtyles NLM list styles.

Info
The examples highlight various aspects of how to set up lists in Word in order to obtain the optimal XML. The examples are taken from the sample document: Sample_6_List-setup.docx

List Labels

By default, eXtyles NLM does not store the text of the list label (i.e. the bullet, number, letter, etc.) in the XML. Instead, it assigns a @list-type attribute to the list, such as @list-type="bullet". This gives extra flexibility in rendering the XML, because the rendering engine can be set to use whatever bullet or label is required in a particular environment. This works well for "standard" bullet characters (•, o, various dashes) and numbering schemes (a, b, c; i, ii, iii; 1, 2, 3; etc.). However, if you need to support complex or "non-standard" list-numbering schemes, you may need to contact extyles-support@inera.com to discuss capturing the text of the list labels in your JATS XML.

This example shows a regular numbered list:


Code Block
languagexml
themeRDark
titleJATS XML Example
collapsetrue
<list id="L1" list-type="order">
	<list-item>
		<p>
			Fat new smallness few supposing suspicion two.
		</p>
	</list-item>
	<list-item>
		<p>
			Course sir people worthy horses add entire suffer.
		</p>
	</list-item>
	<list-item>
		<p>
			How one dull get busy dare far.
		</p>
	</list-item>
	<list-item>
		<p>
			At principle perfectly by sweetness do.
		</p>
	</list-item>
</list>


The table below shows the various values of the @list-type attribute that are applied by eXtyles NLM, depending on the labels used in the list in Word.

List labels@list-type
No labels"simple"
Bullets, dashes"bullet"
1, 2, 3"order"
a, b, c"alpha-lower"
A, B, C"alpha-upper"
i, ii, iii"roman-lower"
I, II, III"roman-upper"


Nested Lists

In eXtyles NLM, a group of contiguous list paragraphs will be exported as a single XML list. Nested lists should be styled carefully to ensure that the nesting is reflected in the paragraph styles used. See the following example of a nested list:


which yields this JATS XML:

Code Block
languagexml
themeRDark
titleJATS XML Example
collapsetrue
<list id="L1" list-type="bullet">
	<list-item>
		<p>
			Extrapyramidal dysfunction, including one or more of the following:
		</p>
		<list id="L2" list-type="bullet">
			<list-item>
				<p>
					Dystonia
				</p>
			</list-item>
			<list-item>
				<p>
					Rigidity
				</p>
			</list-item>
			<list-item>
				<p>
					Choreoathetosis
				</p>
			</list-item>
		</list>
	</list-item>
	<list-item>
		<p>
			Onset
		</p>
		<list id="L3" list-type="bullet">
			<list-item>
				<p>
					<bold>
						Classic form
					</bold>
					. Usually in first decade of life
				</p>
			</list-item>
			<list-item>
				<p>
					<bold>
						Atypical form
					</bold>
					. More often in the second or third decade of life
				</p>
			</list-item>
		</list>
	</list-item>
	<list-item>
		<p>
			Loss of ambulation
		</p>
		<list id="L4" list-type="bullet">
			<list-item>
				<p>
					<bold>
						Classic form
					</bold>
					. Often occurring within ten to 15 years of onset
				</p>
			</list-item>
			<list-item>
				<p>
					<bold>
						Atypical form
					</bold>
					. Often occurring within 15 to 40 years of onset
				</p>
			</list-item>
		</list>
	</list-item>
</list>

Note that the level-1 list L1 is not closed when the first of the level-2 list starts, and in the XML, lists L2, L3, and L4 are nested within list L1.

List Continued

If a single item in the list is made up of more than one paragraph, a List Continued style must be used for the continuation paragraphs; otherwise, the subsequent paragraphs will be exported as separate list items. See the following example:

 

which yields the following XML:

Code Block
languagexml
themeRDark
titleJATS XML Example
collapsetrue
<list id="L6" list-type="order">
	<list-item>
		<p>
			Branched learning so subjects mistress do appetite jennings be in.
		</p>
		<p>
			Esteems up lasting no village morning do offices.
		</p>
		<list id="L7" list-type="alpha-lower">
			<list-item>
				<p>
					Settled wishing ability musical may another set age.
				</p>
				<p>
					Diminution my apartments he attachment is entreaties announcing estimating.
				</p>
			</list-item>
			<list-item>
				<p>
					And total least her two whose great has which.
				</p>
				<p>
					Neat pain form eat sent good week.
				</p>
			</list-item>
		</list>
	</list-item>
	<list-item>
		<p>
			Led instrument sentiments she simplicity.
		</p>
	</list-item>
</list>


Lists in Tables

See Setting up Tables in Word for information on how to style lists in tables.