- Generated on Fri Aug 28 2020 14:54:17 for Open Journal Systems by
1.8.17
|
Open Journal Systems
3.3.0
|
Namespaces | |
| CiteProc | |
| Collection | |
Class CiteProc \CiteProc
Class AbstractConstraint \CiteProc\Constraint @noinspection PhpUnused
Interface ConstraintInterface \CiteProc\Constraint
Class Disambiguate When set to “true” (the only allowed value), the element content is only rendered if it disambiguates two otherwise identical citations. This attempt at disambiguation is only made when all other disambiguation methods have failed to uniquely identify the target source.
\CiteProc\Constraint
Class Factory \CiteProc\Constraint
Class IsNumeric \CiteProc\Choose\Constraint
Class isUncertainDate Tests whether the given date variables contain approximate dates.
\CiteProc\Constraint
Class Jurisdiction \CiteProc\Constraint
Class Locator
Tests whether the locator matches the given locator types (see Locators). Use “sub-verbo” to test for the “sub verbo” locator type.
@codeCoverageIgnore
\CiteProc\Constraint
Class Position
Tests whether the cite position matches the given positions (terminology: citations consist of one or more cites to individual items). When called within the scope of cs:bibliography, position tests “false”. The positions that can be tested are:
Whenever position=”ibid-with-locator” tests true, position=”ibid” also tests true. And whenever position=”ibid” or position=”near-note” test true, position=”subsequent” also tests true.
\CiteProc\Constraint
Class Type \CiteProc\Choose\Constraint
Class Variable \CiteProc\Choose\Constraint
Class Context \CiteProc
Class DataList
\CiteProc\Data
Class CiteProcException \CiteProc\Exception
Class ClassNotFoundException \CiteProc\Exception
@codeCoverageIgnore
Class Locale
While localization data can be included in styles, locale files conveniently provide sets of default localization data, consisting of terms, date formats and grammar options. These default localizations are drawn from the “locales-xx-XX.xml” located in locales folder (which is included as git submodule). These default locales may be redefined or supplemented with cs:locale elements, which should be placed in the style sheet directly after the cs:info element.
TODO: implement Locale Fallback (http://docs.citationstyles.org/en/stable/specification.html#locale-fallback)
\CiteProc\Locale
Trait LocaleXmlParserTrait \CiteProc\Locale
Class Term \CiteProc\Locale
Class Choose
\CiteProc\Node
Class ChooseElse \CiteProc\Node\Choose
Class ChooseElseIf \CiteProc\Node\Choose
Class ChooseIf \CiteProc\Node\Choose
Class Date \CiteProc\Rendering
Class DatePart \CiteProc\Rendering\Date
Class DatePartRenderer
\CiteProc\Rendering\Date\DateRange
Class DayRenderer \CiteProc\Rendering\Date\DateRange
Class MonthDayRenderer \CiteProc\Rendering\Date\DateRange
Class DateRangeMonthRenderer \CiteProc\Rendering\Date
Class YearDayRenderer \CiteProc\Rendering\Date\DateRange
Class YearMonthDayRenderer \CiteProc\Rendering\Date\DateRange
Class YearMonthRenderer \CiteProc\Rendering\Date\DateRange
Class DateRangeYearRenderer \CiteProc\Rendering\Date
Class Group The cs:group rendering element must contain one or more rendering elements (with the exception of cs:layout). cs:group may carry the delimiter attribute to separate its child elements, as well as affixes and display attributes (applied to the output of the group as a whole) and formatting attributes (transmitted to the enclosed elements). cs:group implicitly acts as a conditional: cs:group and its child elements are suppressed if a) at least one rendering element in cs:group calls a variable (either directly or via a macro), and b) all variables that are called are empty. This accommodates descriptive cs:text elements.
\CiteProc\Rendering
Interface HasParent \CiteProc\Rendering
Class Label \CiteProc\Rendering
Class Layout
\CiteProc\Rendering
Class EtAl Et-al abbreviation, controlled via the et-al-... attributes (see Name), can be further customized with the optional cs:et-al element, which must follow the cs:name element (if present). The term attribute may be set to either “et-al” (the default) or to “and others” to use either term. The formatting attributes may also be used, for example to italicize the “et-al” term.
\CiteProc\Rendering\Name
Class Name
The cs:name element, an optional child element of cs:names, can be used to describe the formatting of individual names, and the separation of names within a name variable.
\CiteProc\Rendering\Name
Class NamePart
The cs:name element may contain one or two cs:name-part child elements for name-part-specific formatting. cs:name-part must carry the name attribute, set to either “given” or “family”.
If set to “given”, formatting and text-case attributes on cs:name-part affect the “given” and “dropping-particle” name-parts. affixes surround the “given” name-part, enclosing any demoted name particles for inverted names.
If set to “family”, formatting and text-case attributes affect the “family” and “non-dropping-particle” name-parts. affixes surround the “family” name-part, enclosing any preceding name particles, as well as the “suffix” name-part for non-inverted names.
The “suffix” name-part is not subject to name-part formatting. The use of cs:name-part elements does not influence which, or in what order, name-parts are rendered.
\CiteProc\Rendering\Name
Class Names
\CiteProc\Rendering\Name
Class Substitute The optional cs:substitute element, which must be included as the last child element of cs:names, adds substitution in case the name variables specified in the parent cs:names element are empty. The substitutions are specified as child elements of cs:substitute, and must consist of one or more rendering elements (with the exception of cs:layout).
A shorthand version of cs:names without child elements, which inherits the attributes values set on the cs:name and cs:et-al child elements of the original cs:names element, may also be used.
If cs:substitute contains multiple child elements, the first element to return a non-empty result is used for substitution. Substituted variables are suppressed in the rest of the output to prevent duplication. An example, where an empty “author” name variable is substituted by the “editor” name variable, or, when no editors exist, by the “title” macro: <macro name="author"> <names variable="author"> <substitute> <names variable="editor"> <text macro="title"> </substitute> </names> </macro> \CiteProc\Rendering\Name
Class Number \CiteProc\Rendering
Interface RenderingInterface
Defines "render" function.
\CiteProc\Rendering
Class Term
\CiteProc\Node\Style
RenderingState defines the mode in which mode the processor currently works. There are three modes:
\CiteProc
Class Root \CiteProc\Style
Class Bibliography
The cs:bibliography element describes the formatting of bibliographies, which list one or more bibliographic sources. The required cs:layout child element describes how each bibliographic entry should be formatted. cs:layout may be preceded by a cs:sort element, which can be used to specify how references within the bibliography should be sorted (see Sorting).
\CiteProc
Class Citation
The cs:citation element describes the formatting of citations, which consist of one or more references (“cites”) to bibliographic sources. Citations appear in the form of either in-text citations (in the author (e.g. “[Doe]”), author-date (“[Doe 1999]”), label (“[doe99]”) or number (“[1]”) format) or notes. The required cs:layout child element describes what, and how, bibliographic data should be included in the citations (see Layout).
\CiteProc\Node\Style
Class InheritableNameAttributesTrait
Attributes for the cs:names and cs:name elements may also be set on cs:style, cs:citation and cs:bibliography. This eliminates the need to repeat the same attributes and attribute values for every occurrence of the cs:names and cs:name elements.
The available inheritable attributes for cs:name are and, delimiter-precedes-et-al, delimiter-precedes-last, et-al-min, et-al-use-first, et-al-use-last, et-al-subsequent-min, et-al-subsequent-use-first, initialize, initialize-with, name-as-sort-order and sort-separator. The attributes name-form and name-delimiter correspond to the form and delimiter attributes on cs:name. Similarly, names-delimiter corresponds to the delimiter attribute on cs:names.
\CiteProc\Style
Class Macro
Macros, defined with cs:macro elements, contain formatting instructions. Macros can be called with cs:text from within other macros and the cs:layout element of cs:citation and cs:bibliography, and with cs:key from within cs:sort of cs:citation and cs:bibliography. It is recommended to place macros after any cs:locale elements and before the cs:citation element.
Macros are referenced by the value of the required name attribute on cs:macro. The cs:macro element must contain one or more rendering elements.
\CiteProc\Rendering
Class GlobalOptionsTrait \CiteProc\Style
Class DemoteNonDroppingParticle
Sets the display and sorting behavior of the non-dropping-particle in inverted names (e.g. “Koning, W. de”). Some names include a particle that should never be demoted. For these cases the particle should just be included in the family name field, for example for the French general Charles de Gaulle:
\CiteProc\Style
Class PageRangeFormats
Activates expansion or collapsing of page ranges: “chicago” (“321–28”), “expanded” (e.g. “321–328”), “minimal” (“321–8”), or “minimal-two” (“321–28”) (see also Appendix V - Page Range Formats). Delimits page ranges with the “page-range-delimiter” term (introduced with CSL 1.0.1, and defaults to an en-dash). If the attribute is not set, page ranges are rendered without reformatting.
\CiteProc\Style
Class SubsequentAuthorSubstituteRule
Specifies when and how names are substituted as a result of subsequent-author-substitute.
\CiteProc\Style
Class Key
The cs:sort element must contain one or more cs:key child elements. The sort key, set as an attribute on cs:key, must be a variable (see Appendix IV - Variables) or macro name. For each cs:key element, the sort direction can be set to either “ascending” (default) or “descending” with the sort attribute. The attributes names-min, names-use-first, and names-use-last may be used to override the values of the corresponding et-al-min/et-al-subsequent-min, et-al-use-first/et-al-subsequent-use-first and et-al-use-last attributes, and affect all names generated via macros called by cs:key.
\CiteProc\Style\Sort
Class Sort
cs:citation and cs:bibliography may include a cs:sort child element before the cs:layout element to specify the sorting order of respectively cites within citations, and bibliographic entries within the bibliography.
The cs:sort element must contain one or more cs:key child elements. The sort key, set as an attribute on cs:key, must be a variable (see Appendix IV - Variables) or macro name. For each cs:key element, the sort direction can be set to either “ascending” (default) or “descending” with the sort attribute.
\CiteProc\Style
Class StyleElement
StyleElement is an abstract class which must be extended by Citation and Bibliography class. The constructor of StyleElement class parses the cs:layout element (necessary for cs:citation and cs:bibliography) and the optional cs:sort element.
\CiteProc\Style
Trait AffixesTrait \CiteProc\Styles
Trait ConsecutivePunctuationCharacterTrait \CiteProc\Styles
Class CssRule \CiteProc\Styles\Css
Class CssRules \CiteProc\Styles\Css
Class CssStyle \CiteProc\Styles
Trait DelimiterTrait \CiteProc\Styles
Trait DisplayTrait \CiteProc\Styles
Trait FormattingTrait \CiteProc\Styles
Trait QuotesTrait
The quotes attribute may set on cs:text. When set to “true” (“false” is default), the rendered text is wrapped in quotes (the quotation marks used are terms). The localized punctuation-in-quote option controls whether an adjoining comma or period appears outside (default) or inside the closing quotation mark.
\CiteProc\Styles
Trait RangeDelimiterTrait \CiteProc\Styles
Trait TextCase
\CiteProc\Styles
Class StyleSheet
Helper class for loading CSL styles and CSL locales
\CiteProc
Class Date
Just a helper class for date issues
\CiteProc\Util
Class Factory \CiteProc\Util
Class NameHelper \CiteProc\Util
Class Number \CiteProc\Util
Class PageHelper \CiteProc\Util
Class StringHelper \CiteProc\Util
Class Variables \CiteProc\Util
Class BugfixTest \CiteProc
ArrayList is a useful wrapper class for an array, similar to Java's ArrayList \Collection
Wrapper Interface for \ArrayAccess, \IteratorAggregate, \Countable, ToArrayInterface \Collection
Class Collections \Collection
Comparable Interface for elements as part of an ArrayList.
This interface imposes a total ordering on the objects of each class that implements it. This ordering is referred to as the class's natural ordering, and the class's compareTo method is referred to as its natural comparison method.
\Collection
Abstract class Comparator. If extending this class the compare function must be implemented. compare() is a comparison function, which imposes a total ordering on some collection of objects. Comparators can be passed to a sort method to allow precise control over the sort order.
\Collection
ToArrayInterface
\Collection
1.8.17