WIKINDX API trunk

CITE

Table of Contents

Functions

exportSettings()  : mixed

Setters and getters for various export preferences (e.g. from word processor)

doCitations()  : array<string|int, mixed>

Compile and add the citations to the text

mapTemplate()  : array<string|int, mixed>

Map a template to the raw values and produce a basic citation for inserting into the text

checkResourceTypeTemplate()  : array<string|int, mixed>

Some resource types have specific templates for in-text citations

forceAmbiguousTemplate()  : array<string|int, mixed>

Force the use of ambiguous templates overriding other templates other than subsequentCreatorTemplate

checkSubsequentCreatorTemplate()  : array<string|int, mixed>

Confirm (or not) that a subsequentCreatorTemplate designation is correct.

citationPosition()  : array<string|int, mixed>

Find required position of citation in sentence. Not all requests are possible so drop through three levels . . . Be careful! 0 => "Unchanged" 1 => "After previous creator name(s)" 2 => "After previous quotation" 3 => "Before end of sentence" 4 => "After end of sentence" 5 => "Before next soft punctuation" 6 => "After next soft punctuation"

checkConsecutiveCitations()  : array<string|int, mixed>

For multiple citations that are repositioned after soft or hard punctuation, mark them as consecutive citations.

checkFollowCreatorTemplate()  : array<string|int, mixed>

Confirm (or not) that a followCreatorTemplate designation is correct (in-text citations).

checkConsecutiveCreatorTemplate()  : array<string|int, mixed>

Confirm (or not) that a consecutiveCreatorTemplate designation is correct (in-text citations).

formatCitation()  : array<string|int, mixed>

Format the citation

hyperlinkCitation()  : mixed

Hyperlink the citation text

citationWrapping()  : array<string|int, mixed>

Format citation with wrapping characters taking account of consecutive citation runs and their delimiting characters

trueFootnoteWrapping()  : string

Wrapping of true footnotes in the text — only used for endInc, endSameId, and endSameIdOrdered

formatSentence()  : string

Format the sentence with each citation obeying required positions.

positionCitationInSentence()  : array<string|int, mixed>

Position citations in the sentence.

doPageSplit()  : bool

Check if a citation page should indeed be split and deal with dependencies.

mapTemplateTidyYears()  : array<string|int, mixed>

Do some pre-processing of various year fields in the template

formatPages()  : mixed

Format pages.

formatCreators()  : mixed

Format creator name lists (authors, editors, etc.)

replacementYears()  : array<string|int, mixed>

Add replacement years fields to templates

copyYearAlternates()  : mixed

Copy any alternates relating to pre and post fields from the 'year' field to 'year1' and 'year2' fields

parseIndependent()  : mixed

Parse independent strings of new templates

compileTemplates()  : array<string|int, mixed>

Compile in-text and endote-style citation templates

addAmbiguity()  : string

Add any ambiguity letter to year field. Only for in-text citations

formatYear()  : mixed

Format years for citations

secondYearField()  : array<string|int, mixed>

Conditionally add second year field for formatting citations (e.g. revision year, reprint year etc.)—depends on resource type

splitIntoSentences()  : arrray

Split text into sentences.

parseSentences()  : array<string|int, mixed>

Parse the sentences array for citations and make some initial decisions

findSubsequentTemplates()  : string

Decide if the template for this citation should be the subsequentCreatorTemplate or similar for endnote styles.

findFollowCreatorTemplate()  : array<string|int, mixed>

Find cases for followCreatorTemplate and mark position after creator's name.

getCPattern()  : array<string|int, mixed>

Create the preg pattern for finding a citation's creator names in the same sentence.

tidySentences()  : array<string|int, mixed>

end-of-sentence characters have been captured in $split's array elements. These must be appended to the previous part sentence.

quotationCitationIndex()  : array<string|int, mixed>

Add the citation index to relevant quotations.

tidySentencesEndQuote()  : array<string|int, mixed>

Ensure hard punctuation just before a quotation end marker is treated as marking the end of a complete sentence.

findSpecialQuotes()  : string

Find special quotes such as dialogue and nested quotes—mark them and protect contents of nested quotes

findDialogueQuotes()  : string

Find dialogue quotes and mark them.

findNestedQuotes()  : string

Find and mark nested quotations.

findQuotes()  : string

Mark quotations and protect their content (in case the content has hard punctuation).

blockQuote1()  : mixed

Mark blockquotes.

blockQuote2()  : mixed

Format blockquotes and ensure tailend bits are part of it.

blockQuoteSort()  : string

Sort the blockQuote array by length so that the preg_replace works as expected

findEllipses()  : string

Mark ellipses and protect their content (in case the content has hard punctuation).

findTitle()  : array<string|int, mixed>

Find and note existence of title and short title in sentences

tidyInputText()  : string

Preliminary tidying of input text.

reconstituteBlockquote()  : string

Reconsitute blockquote

reconstituteQuote()  : string

Reconsitute quotation

reconstituteQuoteCallback()  : string

Reconsitute quotation callback

reconstituteText()  : string

Return sentence temporary markup to original

debugPrint()  : mixed

Print an array prettily for debugging purposes