[doc/tutorial] Add new '__repr__' style changes

Author: mpsonntag

doc/tutorial.rst

@@ -237,18 +237,18 @@ The Document
 If you loaded the example odML file, let's have a first look at the Document::
 
     >>> print odmlEX
-    <Doc 42 by D. N. Adams (2 sections)>
+    Document 42 {author = D. N. Adams, 2 sections}
 
 As you can see, the printout gives you a short summary of the Document of the
 loaded example odML file.
 
 The print out gives you already the follwing information about the odML file:
 
-- ``<...>`` indicates that you are looking at an object
-- ``Doc`` tells you that you are looking at an odML Document
+- ``Document`` tells you that you are looking at an odML Document
 - ``42`` is the user defined version of this odML file
-- ``by D. N. Adams`` states the author of the odML file
-- ``(2 sections)`` tells you that this odML Document has 2 Section directly
+- ``{...}`` provides ``author`` and number of attached sections
+- ``author`` states the author of the odML file, "D. N. Adams" in the example case
+- ``2 sections`` tells you that this odML Document has 2 Section directly
   appended
 
 Note that the Document printout tells you nothing about the depth of the
@@ -289,7 +289,7 @@ Let's check out all attributes with the following commands::
     >>> print(odmlEX.date)
     1979-10-12
     >>> print(odmlEX.document)
-    <Doc 42 by D. N. Adams (2 sections)>
+    Document 42 {author = D. N. Adams, 2 sections}
     >>> print(odmlEX.parent)
     None
     >>> print(odmlEX.repository)
@@ -307,7 +307,8 @@ Sections were attached to the Document of our example odML file using the
 following command::
 
     >>> print(odmlEX.sections)
-    [Section[4/2] {name = TheCrew, type = crew, id = ...}, Section[1/7] {name = TheStarship, type = starship, id = ...}]
+    [Section[4|2] {name = TheCrew, type = crew, id = ...},
+     Section[1|7] {name = TheStarship, type = starship, id = ...}]
 
 As expected from the Document printout our example contains two Sections. The
 printout and attributes of a Section are explained in the next chapter.
@@ -324,13 +325,13 @@ look at the first Section in the sections list attached to the Document in our
 example odML file::
 
     >>> print(odmlEX.sections['TheCrew'])
-    Section[4/2] {name = TheCrew, type = crew, id = ...}
+    Section[4|2] {name = TheCrew, type = crew, id = ...}
     >>> print(odmlEX.sections[0])
-    Section[4/2] {name = TheCrew, type = crew, id = ...}
+    Section[4|2] {name = TheCrew, type = crew, id = ...}
     >>> print(odmlEX['TheCrew'])
-    Section[4/2] {name = TheCrew, type = crew, id = ...}
+    Section[4|2] {name = TheCrew, type = crew, id = ...}
     >>> print(odmlEX[0])
-    Section[4/2] {name = TheCrew, type = crew, id = ...}
+    Section[4|2] {name = TheCrew, type = crew, id = ...}
 
 In the following we will call Sections explicitly by their name using the
 short cut notation.
@@ -339,7 +340,7 @@ The printout of a Section is similar to the Document printout and gives you
 already the following information:
 
 - ``Section`` tells you that you are looking at an odML Section
-- ``[4/2]`` states that this Section has four Sections and two Properties directly attached to it
+- ``[4|2]`` states that this Section has four Sections and two Properties directly attached to it
 - ``{...}`` provides ``name``, ``type`` and ``id`` of the Section
 - ``name`` is the name of this Section, 'TheCrew' in the example case
 - ``type`` provides the type of the Section, 'crew' in the example case
@@ -394,9 +395,9 @@ Let's have a look at the attributes for the Section 'TheCrew'::
     >>> print(odmlEX['TheCrew'].definition)
     Information on the crew
     >>> print(odmlEX['TheCrew'].document)
-    <Doc 42 by D. N. Adams (2 sections)>
+    Document 42 {author = D. N. Adams, 2 sections}
     >>> print(odmlEX['TheCrew'].parent)
-    <Doc 42 by D. N. Adams (2 sections)>
+    Document 42 {author = D. N. Adams, 2 sections}
     >>> print(odmlEX['TheCrew'].type)
     crew
     >>> print(odmlEX['TheCrew'].reference)
@@ -414,27 +415,28 @@ To see which Sections are directly attached to the Section 'TheCrew' again use
 the following command::
 
     >>> print(odmlEX['TheCrew'].sections)
-    [Section[0/5] {name = Arthur Philip Dent, type = crew/person, id = ...},
-     Section[0/5] {name = Zaphod Beeblebrox, type = crew/person, id = ...},
-     Section[0/5] {name = Tricia Marie McMillan, type = crew/person, id = ...},
-     Section[0/5] {name = Ford Prefect, type = crew/person, id = ...}]
+    [Section[0|5] {name = Arthur Philip Dent, type = crew/person, id = ...},
+     Section[0|5] {name = Zaphod Beeblebrox, type = crew/person, id = ...},
+     Section[0|5] {name = Tricia Marie McMillan, type = crew/person, id = ...},
+     Section[0|5] {name = Ford Prefect, type = crew/person, id = ...}]
 
 Or, for accessing these sub-Sections::
 
     >>> print(odmlEX['TheCrew'].sections['Ford Prefect'])
-    Section[0/5] {name = Ford Prefect, type = crew/person, id = ...}
+    Section[0|5] {name = Ford Prefect, type = crew/person, id = ...}
     >>> print(odmlEX['TheCrew'].sections[3])
-    Section[0/5] {name = Ford Prefect, type = crew/person, id = ...}
+    Section[0|5] {name = Ford Prefect, type = crew/person, id = ...}
     >>> print(odmlEX['TheCrew']['Ford Prefect'])
-    Section[0/5] {name = Ford Prefect, type = crew/person, id = ...}
+    Section[0|5] {name = Ford Prefect, type = crew/person, id = ...}
     >>> print(odmlEX['TheCrew'][3])
-    Section[0/5] {name = Ford Prefect, type = crew/person, id = ...}
+    Section[0|5] {name = Ford Prefect, type = crew/person, id = ...}
 
 As you learned, besides sub-Sections, a Section can also have Properties
 attached. Let's see which Properties are attached to the Section 'TheCrew'::
 
     >>> print(odmlEX['TheCrew'].properties)
-    [Property: {name = NameCrewMembers}, Property: {name = NoCrewMembers}]
+    [Property: {name = NameCrewMembers},
+     Property: {name = NoCrewMembers}]
 
 The printout and attributes of a Property are explained in the next chapter.
 
@@ -518,7 +520,7 @@ Let's check which attributes were defined for the Property 'NoCrewMembers'::
     >>> print(odmlEX['TheCrew'].properties['NoCrewMembers'].definition)
     Number of crew members
     >>> print(odmlEX['TheCrew'].properties['NoCrewMembers'].document)
-    <Doc 42 by D. N. Adams (2 sections)>
+    Document 42 {author = D. N. Adams, 2 sections}
     >>> print(odmlEX['TheCrew'].properties['NoCrewMembers'].values)
     [4]
     >>> print(odmlEX['TheCrew'].properties['NoCrewMembers'].dtype)
@@ -586,7 +588,7 @@ You can check if your new Document contains actually what you created by using
 some of the commands you learned before::
 
     >>> MYodML
-    >>> <Doc None by None (0 sections)>
+    >>> Document None {author = None, 0 sections}
 
 As you can see, we created an "empty" Document where the version and the author
 attributes are not defined and no section is yet attached. You will learn how to create
@@ -623,7 +625,7 @@ Check if your new Document contains actually all attributes now::
     >>> print(MYodML.date)
     1979-10-12
     >>> print(MYodML.document)
-    <Doc 42 by D. N. Adams (0 sections)>
+    Document 42 {author = D. N. Adams, 0 sections}
     >>> print(MYodML.parent)
     None
     >>> print(MYodML.repository)
@@ -663,14 +665,14 @@ updated::
     >>> MYodML.append(sec1)
 
     >>> print(MYodML)
-    <Doc 42 by Douglas Adams (1 sections)>
+    Document 42 {author = D. N. Adams, 1 sections}
     >>> print(MYodML.sections)
-    [Section[0/0] {name = TheCrew, type = crew, id = ...}]
+    [Section[0|0] {name = TheCrew, type = crew, id = ...}]
 
     >>> print(sec1.document)
-    <Doc 42 by D. N. Adams (1 sections)>
+    Document 42 {author = D. N. Adams, 1 sections}
     >>> print(sec1.parent)
-    <Doc 42 by D. N. Adams (1 sections)>
+    Document 42 {author = D. N. Adams, 1 sections}
 
 It is also possible to connect a Section directly to a parent object.
 Let's try this with the next Section we create::
@@ -681,12 +683,12 @@ Let's try this with the next Section we create::
                             parent=sec1)
 
     >>> print(sec2)
-    Section[0/0] {name = Arthur Philip Dent, type = crew/person, id = ...}
+    Section[0|0] {name = Arthur Philip Dent, type = crew/person, id = ...}
 
     >>> print(sec2.document)
-    <Doc 42 by D. N. Adams (1 sections)>
+    Document 42 {author = D. N. Adams, 1 sections}
     >>> print(sec2.parent)
-    [Section[1/0] {name = TheCrew, type = crew, id = ...}
+    [Section[1|0] {name = TheCrew, type = crew, id = ...}
 
 Note that all of our created Sections do not contain any Properties yet. Let's 
 see if we can change this...
@@ -751,9 +753,9 @@ automatically update its parent attribute::
     >>> MYodML['TheCrew']['Arthur Philip Dent'].append(prop1)
 
     >>> print(prop1.document)
-    <Doc 42 by D. N. Adams (1 sections)>
+    Document 42 {author = D. N. Adams, 1 sections}
     >>> print(prop1.parent)
-    Section[0/1] {name = Arthur Philip Dent, type = crew/person, id = ...}
+    Section[0|1] {name = Arthur Philip Dent, type = crew/person, id = ...}
 
 Next, let us create a Property with multiple metadata entries::