WIKINDX API trunk

EXPORTFILTER

Table of Contents

Functions

format()  : string
Format for HTML or RTF/plain?
notes()  : mixed
Set and get footnote and endnote texts.
bbcode()  : string
Deal with BBCODE
endnoteId()  : string
Format the endnote ID in the endnotes
trueFootnoteId()  : string
Format the true footnote ID in the footnotes section
newline()  : string
Return a newline character.

Functions

format()

Format for HTML or RTF/plain?

format(string $data, string $outputFormat[, int|false $citeId = FALSE ][, int|false $bibId = FALSE ]) : string
Parameters
$data : string

Input string

$outputFormat : string

One of 'wikindx', 'html', 'cite', 'wp', 'plain', 'rtf'

$citeId : int|false = FALSE

Default FALSE (Only present and used if formatting a citation for 'wikindx' or 'html' output)

$bibId : int|false = FALSE

Default FALSE (Only present and used if formatting a bibliography reference for 'wikindx' or 'html' output)

Return values
string

notes()

Set and get footnote and endnote texts.

notes(string $method[, array<string|int, mixed> $flags = [] ][, string $text = '' ][, array<string|int, mixed> $citationStyle = [] ]) : mixed

e.g., for DOCX, we do not use the footnote texts in spans enclosed in divs but store them here.

Parameters
$method : string
$flags : array<string|int, mixed> = []

default is []

$text : string = ''

Default is ''

$citationStyle : array<string|int, mixed> = []

Default is []

bbcode()

Deal with BBCODE

bbcode(string $data, string $outputFormat) : string
Parameters
$data : string
$outputFormat : string
Return values
string

endnoteId()

Format the endnote ID in the endnotes

endnoteId(array<string|int, mixed> $citationStyle, int $id, string $outputFormat) : string
Parameters
$citationStyle : array<string|int, mixed>
$id : int
$outputFormat : string
Return values
string

trueFootnoteId()

Format the true footnote ID in the footnotes section

trueFootnoteId(array<string|int, mixed> $citationStyle, int $id, string $outputFormat) : string
Parameters
$citationStyle : array<string|int, mixed>
$id : int
$outputFormat : string
Return values
string

newline()

Return a newline character.

newline(string $outputFormat) : string

Also, bibliographic/footnote templates may have the special string 'NEWLINE'

Parameters
$outputFormat : string
Return values
string 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results