Notation Commands
The SourceMarkup plugin defines several commands for denoting and highlighting source code components within the text. These are similar to the standard text styling commands for marking boldface and italics text, except these commands are used to indicate what a word or phrase represents rather than how they should look.
source module
\var{text}
Marks the text as representing a variable that is styled in a monospace font.
Example:
namePlugin: SourceMarkup
source module
\keyword{text}
Marks the text as representing a keyword in a programming language that is styled in a monospace font.
Example:
whilePlugin: SourceMarkup
source module
\fnct{text}
Marks the text as representing a the name of a function and styled in a monospace font.
Example:
strlenPlugin: SourceMarkup
source module
\param{text}
Marks the text as representing the name of a function or method parameter.
Example: name
Plugin: SourceMarkup
source module
\arg{text}
Marks the text as representing the name of an argument that is passed to a function or method.
Example:
sizePlugin: SourceMarkup
source module
\type{text}
Marks the text as representing the name of a data type.
Example:
floatPlugin: SourceMarkup
source module
\class{text}
Marks the text as representing the name of a class.
Example:
RecordPlugin: SourceMarkup
source module
\module{text}
Marks the text as representing the name of a module or package.
Example:
math.hPlugin: SourceMarkup
source module
\plugin{text}
Marks the text as representing the name of a plugin.
Example:
TextStylesPlugin: SourceMarkup
source module
\opmethod{text}
Marks the text as representing the name of a python operator method.
Example:
__str__Plugin: SourceMarkup