aboutsummaryrefslogtreecommitdiff
path: root/docs/tags.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tags.rst')
-rw-r--r--docs/tags.rst20
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/tags.rst b/docs/tags.rst
index 4b29467..17a9d05 100644
--- a/docs/tags.rst
+++ b/docs/tags.rst
@@ -20,20 +20,22 @@ There are a few public members you can define as a tag:
- ``raw``: the tag's content shall not be interpreted, which is generally
only useful when the content is preprocessed (see below). The default
is ``False`` if there is no preprocess method, and `True` otherwise;
+- ``noinline``: for raw tags, forbid inline tags (declared outside of the
+ tag) within the tag (*only works with ``raw = True``*!);
- ``generic``: the tag can be ended using the generic tag ending mark ``[/]``.
It is defined as ``True`` by default for all tags;
- ``notempty``: ignore the tag when its content is empty. By default, this
value is `False`;
- ``superblock``: is a super-block (for blocks) which means it adds a block
- level, and adds a paragraph tag implicitely.
+ level, and adds a paragraph tag implicitely;
- ``inlined``: if is a block, transforms automatically the surrounding block
- into a superblock while it's there.
-- ``procvalue``: process the value as normal text before passing it.
+ into a superblock while it's there;
+- ``procvalue``: process the value as normal text before passing it;
- ``not_within_itself``: make that if a tag is opened within itself (depth
- included), the tag above and all tags below are closed first.
-- ``only_in``: allow the tag to only be beneath certain tags.
-- ``allowed_tags``: allowed tags right beneath the current one.
-- ``no_text``: disable raw text within the tag.
+ included), the tag above and all tags below are closed first;
+- ``only_in``: allow the tag to only be beneath certain tags;
+- ``allowed_tags``: allowed tags right beneath the current one;
+- ``no_text``: disable raw text within the tag;
- ``expect_child``: make that all content below (without depth) that isn't
within the specified tags is ignored.
@@ -42,9 +44,9 @@ with the alternate name ``[hai]``, I'd start off by writing:
.. code-block:: python
- from .__base__ import *
+ from textoutpc import InlineTag as _InlineTag
- class TextoutHelloTag(TextoutInlineTag):
+ class TextoutHelloTag(_InlineTag):
""" The [hello] tag, which does things.
Example uses: