To declare an attribute, follow the syntax :attribute: value
.
For example: :publisher: Ribose Inc.
Now it’s your turn. Fill the document with the following attributes:
Document title
Your name
Your organization using the :publisher:
attribute
Your organization’s address
The document class: standoc
The document type: document
The language
The copyright year
To declare an attribute, follow the syntax :attribute: value
.
For example: :publisher: Ribose Inc.
Look at the prepopulated Metanorma document. There are many clauses describing the content but there are sections missing to form a correct standard document.
Add the following sections:
Foreword on line 13
Introduction on line 21
Terms and definitions on line 27
Bibliography on line 60
Add lists to the prepopulated document.
Add an ordered list in lines 17-24.
Add an unordered list in lines 36-40.
Add a definition list in lines 46-48.
Ordered list items start with a dot, followed by a blank: . List item
.
Unordered list items start with an asterisk, followed by a blank: * List item
.
To write a definition list, follow the syntax:
term:: Definition
Create a term definition entry for the term "immature kernel":
Add an alternative term ("unripe kernel")
Add a deprecated term ("raw kernel")
Add a definition: kernel, whole or broken, which is unripe and/or underdeveloped.
The structure for a term definition looks like this:
=== Term
alt:[alternative term]
deprecated:[deprecated term]
definition
Let’s compare rice against wheat in a table:
Create an empty three column table with seven rows.
Add a table title: "Nutrient profile of rice vs. wheat"
Let’s make the first column a bit wider than the other two colums in the ratio 3:2:2 by using the cols
attribute.
Populate the table like this:
Nutrient |
Rice |
Wheat |
Energy (kJ) |
1736 |
1574 |
Protein (g) |
8.1 |
14.5 |
Fat (g) |
0.8 |
1.8 |
Carbohydrates (g) |
91 |
82 |
Fiber (g) |
1.5 |
14 |
Sugar (g) |
0.1 |
0.5 |
The structure for a three column table looks like this:
|===
|||
|||
|||
|===
Insert an image of a rice plant in line 17 by following the steps below:
Add an image macro.
Populate the image::
macro with this link:
https://upload.wikimedia.org/wikipedia/commons/2/27/Oryza_sativa_-_K%C3%B6hler%E2%80%93s_Medizinal-Pflanzen-232.jpg
Add a picture title (Oryza sativa)
Create a key with three entries
A:: Rice - A flowering specimen of the variety _melanoceras_ Alef. B:: blossom panicle C:: crop panicle
The syntax for images is: image::URL[]
.
Make sure to include the square brackets after the link.
Turn the existing text into admonitions:
Turn the text in line 15 into an IMPORTANT
admonition.
Turn the text in lines 17-19 into a WARNING
admonition.
Turn the text in line 21 into a NOTE
admonition.
To create admonitions that span several lines, you need to declare a block.
[NOTE]
====
This is a long note.
It contains three lines.
Line three.
====
There are some code samples in the document but they are not neatly packed into source
blocks, so they cause trouble.
Create a source block with the attribute ruby
for the code in lines 14-29.
Create a source block with the attribute python
for the code in line 32
Create a source block with the attribute java
for the code in lines 35-39.
Source code blocks look like this:
[source,language]
----
Code
----
Format the text using the following formatting:
Add underline formatting to "Earth institute" in line 18
Add bold formatting to "from Africa, for Africa" in line 20
Add italic formatting to The New York times and International Herald Tribune in line 21
Add smallcaps formatting to all instances of "NERICA"
Add a footnote on line 22 explaining the term "perennial". Footnote text: A perennial plant lives more than two years.
Let’s add some index entries to the text.
Add a visible index entry to "UN Millennium Development project" in line 17
Add an invisible three level index entry after NERICA in line 21: NERICA, economy, Green revolution
Add an invisible two level index entry in line 22 after rice: rice, perennial
Create a new index section at the bottom of the document
Visible index terms: ((Level 1 index term))
Hidden index terms: (((Level 1 index term, Level 2 index term, Level 3 index term)))
Let’s add some references to the sample document.
Internal references:
Create an anchor for the table called table1
Reference the table in lines 30 and 36.
Bibliographic references: The text references some standards which don’t have a matching entry in the bibliography section. Add the following references:
ISO712, ISO712:2009, Cereals and cereal products — Determination of moisture content — Reference method
ISO7301, ISO 7301:2011, Rice — Specification
IEC61010-2, IEC 61010-2:1998, Safety requirements for electric equipment for measurement, control, and laboratory use — Part 2: Particular requirements for laboratory equipment for the heating of material
Setting an anchor: [[anchor]]
Referencing an anchor: <<anchor>>
The text contains some typos. Mark the errors using comments.
Line 16: weter
Line 18: exseed
Line 20: eyes
Enter the command metanorma document.adoc
into the terminal and see what happens.
The following document doesn’t compile because there are some errors.
Enter metnanorma exercise-4.adoc
to trigger the build process
Have a look at the error messages
Try to debug the document. If you get stuck, have a look at the hints.
Once you solved the errors, run metanorma exercise-4.adoc
again to see if the document compiles.
Lines 12 and 43: Both sections have the anchor [[prefatory-clause]]
assigned.
You can solve this error by renaming the anchors.
Line 76: The file that should be included cannot be found. Since the scope section already contains text, you can delete the reference.
Line 420: The image attribute contains a whitespace after image::
, so the path is invalid. Delete the whitespace.