Skip to content

Commit ad886c7

Browse files
committed
[doc/tutorial] Update document section
1 parent 8a3456c commit ad886c7

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

doc/tutorial.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Basic knowledge on odML
156156

157157
Before we start, it is important to know the basic structure of an odML
158158
file. Within an odML file metadata are grouped and stored in a
159-
hierarchical tree structure which consists of four different odML
159+
hierarchical tree structure which consists of three basic odML
160160
objects.
161161

162162
Document:
@@ -208,6 +208,7 @@ In the IPython shell, first import the odml package::
208208
>>> import odml
209209

210210
Second, load the example odML file with the following command lines::
211+
211212
>>> to_load = './doc/example_odMLs/THGTTG.odml'
212213
>>> odmlEX = odml.load(to_load)
213214

@@ -221,10 +222,10 @@ Section, Property).
221222

222223
How you can create the different odML objects on your own and how to connect
223224
them to build your own metadata odML file will be described in later chapters.
224-
Further advanced functions you can use to navigate threw your odML files, or to
225+
Further advanced functions you can use to navigate through your odML files, or to
225226
create an odML template file, or to make use of common odML terminologies
226227
provided via `the G-Node repository
227-
<http://portal.g-node.org/odml/terminologies/v1.0/terminologies.xml>`_ can also
228+
<http://portal.g-node.org/odml/terminologies/v1.1/terminologies.xml>`_ can also
228229
be found later on in this tutorial.
229230

230231
But now, let us first have a look at the example odML file (THGTTG.odml)!
@@ -259,8 +260,8 @@ author
259260
- Returns the author (returned as string) of this odML file.
260261

261262
date
262-
- Returns ta user defined date (returned as string). Could for example be
263-
used to state the date of first creation or the date of last changes.
263+
- Returns ta user defined date. Could for example be used to state
264+
the date of first creation or the date of last changes.
264265

265266
document
266267
- Returns the current Document object.
@@ -276,11 +277,16 @@ repository
276277
version
277278
- Returns the user defined version (returned as string) of this odML file.
278279

280+
id
281+
- id is a UUID (universally unique identifiers) that uniquely identifies
282+
the current document. If not otherwise specified, this id is automatically
283+
created and assigned.
284+
279285
Let's check out all attributes with the following commands::
280286

281287
>>> print(odmlEX.author)
282288
D. N. Adams
283-
>>> print(odmlfile.date)
289+
>>> print(odmlEX.date)
284290
1979-10-12
285291
>>> print(odmlEX.document)
286292
<Doc 42 by D. N. Adams (2 sections)>
@@ -301,7 +307,7 @@ Sections were attached to the Document of our example odML file using the
301307
following command::
302308

303309
>>> print(odmlEX.sections)
304-
[<Section TheCrew[crew] (4)>, <Section TheStarship[crew] (1)>]
310+
[<Section TheCrew[crew] (4)>, <Section TheStarship[starship] (1)>]
305311

306312
As expected from the Document printout our example contains two Sections. The
307313
printout and attributes of a Section are explained in the next chapter.

0 commit comments

Comments
 (0)