Author#

Qualified name: rsm.nodes.Author

class rsm.nodes.Author(name='', affiliation='', email='', **kwargs)[source]#

Bases: Node

An author of the manuscript.

Notes

A Manuscript may have more than one Author node.

Examples

:manuscript:

   :author:
     :name: Melvin J. Noir
     :affiliation: ACME University
     :email: mel@acme.edu
   ::

::

Melvin J. Noir

ACME University

mel@acme.edu

Methods

Attributes

`newmetakeys`	Meta keys to add to those of the parent class.
`name`	Full name of the author.
`affiliation`	Institutional affiliation.
`email`	Contact information.

affiliation: str[source]#: Institutional affiliation.

email: str[source]#: Contact information.

name: str[source]#: Full name of the author.

newmetakeys: ClassVar[set] = {'affiliation', 'email', 'name'}[source]#

Meta keys to add to those of the parent class.

Important

Only use this when defining a new Node subclass. When dealing with Node isntances, do not access this attribute directly neither for reading nor writing. Always use metakeys() in that case.

See also

metakeys()

Examples

The keys in newmetakeys are added to the meta keys of the parent class.

>>> nodes.Heading.newmetakeys
{'title'}
>>> nodes.Heading.metakeys() == nodes.Node.metakeys() | {"title"}
True

The intended use, and only supported use, of newmetakeys is at the time of class definition.

>>> class NewNode(nodes.Node):
...     newmetakeys = {"newkey"}
>>> NewNode.metakeys() == nodes.Node.metakeys() | {"newkey"}
True