Skip to content

Commit 144098f

Browse files
committed
[doc/tutorial] Remove mapping chapter
1 parent 55db759 commit 144098f

File tree

1 file changed

+5
-32
lines changed

1 file changed

+5
-32
lines changed

doc/tutorial.rst

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -919,7 +919,7 @@ Advanced knowledge on Sections
919919
------------------------------
920920

921921
Links & Includes
922-
----------------
922+
****************
923923
(DEPRECATED; new version coming soon)
924924

925925
Sections can be linked to other Sections, so that they include their defined
@@ -956,36 +956,9 @@ Terminologies
956956
(deprecated; new version coming soon)
957957
odML supports terminologies that are data structure templates for typical use cases.
958958
Sections can have a ``repository`` attribute. As repositories can be inherited,
959-
the current applicable one can be obtained using the :py:meth:`odml.section.BaseSection.get_repository`
960-
method.
959+
the current applicable one can be obtained using the
960+
:py:meth:`odml.section.BaseSection.get_repository` method.
961961

962-
To see whether an object has a terminology equivalent, use the :py:meth:`odml.property.BaseProperty.get_terminology_equivalent`
962+
To see whether an object has a terminology equivalent, use the
963+
:py:meth:`odml.property.BaseProperty.get_terminology_equivalent`
963964
method, which returns the corresponding object of the terminology.
964-
965-
Mappings
966-
********
967-
(deprecated; new version coming soon)
968-
A sometimes obscure but very useful feature is the idea of mappings, which can
969-
be used to write documents in a user-defined terminology, but provide mapping
970-
information to a standard-terminology that allows the document to be viewed in
971-
the standard-terminology (provided that adequate mapping-information is provided).
972-
973-
See :py:class:`test.mapping.TestMapping` if you need to understand the
974-
mapping-process itself.
975-
976-
Mappings are views on documents and are created as follows::
977-
978-
>>> import odml
979-
>>> import odml.mapping as mapping
980-
>>> doc = odml.Document()
981-
>>> mdoc = mapping.create_mapping(doc)
982-
>>> mdoc
983-
P(<Doc None by None (0 sections)>)
984-
>>> mdoc.__class__
985-
<class 'odml.tools.proxy.DocumentProxy'>
986-
987-
Creating a view has the advantage, that changes on a Proxy-object are
988-
propagated to the original document.
989-
This works quite well and is extensively used in the GUI.
990-
However, be aware that you are typically dealing with proxy objects only
991-
and not all API methods may be available.

0 commit comments

Comments
 (0)