Author#

Qualified name: rsm.nodes.Author

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

Bases: Node

An author of the manuscript.

Notes

A Manuscript may have more than one Author node.

Examples

:author: {
  :name: Melvin J. Noir
  :affiliation: ACME University
  :email: 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.
`orcid`	ORCID identifier.
`author_note`	Author note (e.g., 'Equal contribution').
`affiliation_number`	Affiliation number assigned by transformer (auto-deduped).
`note_symbol`	Note symbol assigned by transformer (, †, ‡, §, ¶, ‖, *, ††, etc.).
`nodeid`	Node id - always exists (unlike label), automatically assigned, unique within the tree.
`label`	Unique identifier.
`classes`	CSS classes for this node.
`handrail_depth`	The number of ancestors of this node that have a handrail.
`number`	Node number.
`nonum`	Whether this node should be automatically given a number.
`reftext_template`	Reftext template, or "" to use `classreftext`.
`start_point`	The start point of the corresponding concrete syntax tree node.
`end_point`	The end point of the corresponding concrete syntax tree node.

affiliation: str[source]#: Institutional affiliation.

affiliation_number: int | None[source]#: Affiliation number assigned by transformer (auto-deduped).

author_note: str[source]#: Author note (e.g., ‘Equal contribution’).

email: str[source]#: Contact information.

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

newmetakeys: ClassVar[set] = {'affiliation', 'author_note', 'email', 'name', 'orcid'}[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

note_symbol: str[source]#: Note symbol assigned by transformer (, †, ‡, §, ¶, ‖, *, ††, etc.).

orcid: str[source]#: ORCID identifier.

Author#

This Page