Skip to content

Commit

Permalink
added example to documentation #89
Browse files Browse the repository at this point in the history
  • Loading branch information
proycon committed Dec 17, 2020
1 parent f4269f2 commit b9363b5
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/source/style_annotation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Specification
:Version History: since v0.10
:**Element**: ``<t-style>``
:API Class: ``TextMarkupStyle`` (`FoLiApy API Reference <https://foliapy.readthedocs.io/en/latest/_autosummary/folia.main.TextMarkupStyle.html>`_)
:Required Attributes:
:Required Attributes:
:Optional Attributes: * ``xml:id`` -- The ID of the element; this has to be a unique in the entire document or collection of documents (corpus). All identifiers in FoLiA are of the `XML NCName <https://www.w3.org/TR/1999/WD-xmlschema-2-19990924/#NCName>`_ datatype, which roughly means it is a unique string that has to start with a letter (not a number or symbol), may contain numbers, but may never contain colons or spaces. FoLiA does not define any naming convention for IDs.
* ``set`` -- The set of the element, ideally a URI linking to a set definition (see :ref:`set_definitions`) or otherwise a uniquely identifying string. The ``set`` must be referred to also in the :ref:`annotation_declarations` for this annotation type.
* ``class`` -- The class of the annotation, i.e. the annotation tag in the vocabulary defined by ``set``.
Expand All @@ -34,7 +34,7 @@ Specification
* ``xlink:href`` -- Turns this element into a hyperlink to the specified URL
* ``xlink:type`` -- The type of link (you'll want to use ``simple`` in almost all cases).
:Accepted Data: ``<comment>`` (:ref:`comment_annotation`), ``<desc>`` (:ref:`description_annotation`), ``<br>`` (:ref:`linebreak_annotation`)
:Valid Context:
:Valid Context:

Explanation
-------------------------
Expand All @@ -52,4 +52,11 @@ Example
:linenos:
:language: xml

In the next example, features are used rather than nested styles:

.. literalinclude:: ../../examples/style-features.2.4.2.folia.xml
:linenos:
:language: xml



0 comments on commit b9363b5

Please sign in to comment.