Description of class CITEFORMAT.
Format citations.
package | wikindx4\core\bibcitation |
---|---|
author | Mark Grimshaw |
param | 'html', plain', 'rtf'. Default is 'html' |
__construct(string $output)
string
Default is 'html'
checkInitials(array $creator, int $initialsStyle, boolean $firstNameInitial) : string
see | \formatNames() |
---|---|
author | Mark Grimshaw |
version | 1 |
array
Associative array of creator name e.g.
array(['surname'] => 'Grimshaw', ['firstname'] => Mark, ['initials'] => 'M N G', ['prefix'] => ))
Initials must be space-delimited.
int
boolean
string
Formatted string of initials.checkTemplateFields(array $template)
If not, return FALSE to indicate that we use original $this->template
author | Mark Grimshaw |
---|---|
version | 1 |
array
citationToArrayEndnoteStyle()
author | Mark Grimshaw |
---|---|
version | 1 |
citationToArrayInTextStyle()
author | Mark Grimshaw |
---|---|
version | 1 |
collateIntextBibliography() : string
createStyleSheet() : string
string
endnoteProcess() : string
endnoteRemovePunc(string $entry) : string
endnoteStyle() : \Complete
findAlternates(array $typeArray)
formatCitationId(string $pre, string $post) : string
author | Mark Grimshaw |
---|
string
pre-characters
string
post-characters
string
formatNames(array $creators, int $citationId)
author | Mark Grimshaw |
---|---|
version | 1 |
array
Multi-associative array of creator names e.g. this array might be of the primary authors:
array([0] => array(['surname'] => 'Grimshaw', ['firstname'] => Mark, ['initials'] => 'N', ['prefix'] => ), [1] => array(['surname'] => 'Witt', ['firstname'] => Jan, ['initials'] => , ['prefix'] => 'de'))
int
formatPages(string $start, string $end) : string
$this->style['pageFormat']: 0 == 132-9 1 == 132-39 2 == 132-139
author | Mark Grimshaw |
---|---|
version | 1 |
string
Page start.
string
Page end.
string
of pages.formatPrePostText(string $preText, string $postText)
[cite]23:34-35|see ` for example[/cite] (as used by WIKINDX)
author | Mark Grimshaw |
---|---|
version | 1 |
string
string
formatShortTitle(string $pString, string $delimitLeft, string $delimitRight) : string
Anything enclosed in $delimitLeft...$delimitRight is to be left unchanged
author | Mark Grimshaw |
---|---|
version | 1 |
string
Raw title string.
string
Default FALSE
string
Default FALSE
string
Formatted title string.formatTitle(string $pString, string $delimitLeft, string $delimitRight) : string
Anything enclosed in $delimitLeft...$delimitRight is to be left unchanged
author | Mark Grimshaw |
---|---|
version | 1 |
string
Raw title string.
string
Default FALSE
string
Default FALSE
string
Formatted title string.formatYear(string $year) : string
$this->style['yearFormat']: 0 == 1998 1 == '98 2 == 98
author | Mark Grimshaw |
---|---|
version | 1 |
string
string
of year.hyperLink(string $citation) : string
author | Mark Grimshaw |
---|
string
string
ready for printing to the output medium.inTextStyle() : \Complete
initialise()
map(array $template) : string
author | Mark Grimshaw |
---|---|
version | 1 |
array
string
ready for printing to the output medium.multiple(array $multiples) : string
parseIndependent($array)
Author | Mark Grimshaw |
---|
printEndnoteBibliography(string $pString) : string
process() : \Complete
processEndnoteBibliography(array $rows, array $ids)
Must be processed in the same order as $ids. Where the id nos. are the same for each resource (endnote-style citations), store the bibliographic id order with an incrementing citation id no.
author | Mark Grimshaw |
---|---|
version | 1 |
array
multiple array of raw bibliographic data to be processed by $this->bibStyle
array
resource ids giving order of processing bibliography
processIntextBibliography(array $row)
author | Mark Grimshaw |
---|---|
version | 1 |
array
array of raw bibliographic data for one resource to be processed by $this->bibStyle
rtfPageNumbers(object $session) : string
object
string
sameSentence(string $text)
subsequentSentenceCheck()
getStyle()
author | Mark Grimshaw |
---|---|
version | 1 |
$dir
$hyperlinkBase
$items
$output
$rtfBibExport
$suwpExport
$wikindx
$bibStyle
$citationIds
$citationInSameSentence
$consecutiveCreatorSep
$creatorIds
$creatorSurnames
$creators
$endnoteCitations
$endnoteSameIds
$endnoteSameIdsArray
$endnoteString
$endnoteStringArray
$endnotes
$export
$html
$inTextDoneIds
$intextBibliography
$matchNameSplit
$matchNameSplitEtAl
$multipleCitations
$nameInSameSentence
$newParagraph
$newSection
$opCit
$pageSplitDone
$parseXml
$previousNameInSameSentenceId
$rtfDoneIds
$storeOriginalTemplate
$styleMap
$styleSheet
$template
$utf8