WIKINDX API trunk

TINYMCE
in package

TINYMCE

Interface for tinymce elements in various pages.

Tags
see
https://www.tiny.cloud/docs/advanced/available-toolbar-buttons/

Table of Contents

Properties

$pathLoaded  : mixed
boolean

Methods

loadBasicTextinput()  : string
Return the HTML/JS code of a basic textarea with a TinyMCE toolbar
loadMetadataTextarea()  : string
Return the HTML/JS code of an medium sized textarea with a TinyMCE toolbar and WIKINDX plugins for citations
loadMinimalTextarea()  : string
Return the HTML/JS code of an medium sized textarea with a TinyMCE toolbar
loadWordProcessor()  : string
Return the HTML/JS code of a textarea for the Word Processor
getContentCssUrl()  : string
Get the url of the custom WIKINDX CSS content for TinyMCE 5
getDialogUrl()  : string
Get the dialog title of a custom external plugin for TinyMCE 5
getIncludeTinyMceLib()  : string
Include tinymce compressor
getLocale()  : string
Determines from the user's preferred locale the closest locale available in TinyMCE
getPluginUrl()  : string
Get the url of a custom external plugin for TinyMCE 5
getSkinUrl()  : string
Get the url of the custom WIKINDX skin for TinyMCE 5

Properties

$pathLoaded

boolean

protected mixed $pathLoaded = \FALSE

Methods

loadBasicTextinput()

Return the HTML/JS code of a basic textarea with a TinyMCE toolbar

public loadBasicTextinput(string $Name, mixed $Value[, string $width = "400" ][, string $height = "120" ]) : string

For short HTML fields like a single line title.

Parameters
$Name : string

id/name of the HTML textarea

$Value : mixed

Content of the HTML textarea

$width : string = "400"

Width of the HTML textarea in pixel without unit (Default is 400 px and the minimum Width is 400 px)

$height : string = "120"

Height of the HTML textarea in pixel without unit (Default is 120 px and the minimum height is 120 px)

Return values
string

loadMetadataTextarea()

Return the HTML/JS code of an medium sized textarea with a TinyMCE toolbar and WIKINDX plugins for citations

public loadMetadataTextarea(string $Name, mixed $Value[, string $width = "790" ][, string $height = "290" ]) : string

For long HTML fields like notes, musings ...

Parameters
$Name : string

id/name of the HTML textarea

$Value : mixed

Content of the HTML textarea

$width : string = "790"

Width of the HTML textarea in pixel without unit (Default is 790 px and the minimum Width is 790 px)

$height : string = "290"

Height of the HTML textarea in pixel without unit (Default is 190 px and the minimum height is 190 px)

Return values
string

loadMinimalTextarea()

Return the HTML/JS code of an medium sized textarea with a TinyMCE toolbar

public loadMinimalTextarea(string $Name, mixed $Value[, string $width = "790" ][, string $height = "360" ]) : string

For long HTML fields like a description.

Parameters
$Name : string

id/name of the HTML textarea

$Value : mixed

Content of the HTML textarea

$width : string = "790"

Width of the HTML textarea in pixel without unit (Default is 790 px and the minimum Width is 790 px)

$height : string = "360"

Height of the HTML textarea in pixel without unit (Default is 360 px and the minimum height is 360 px)

Return values
string

loadWordProcessor()

Return the HTML/JS code of a textarea for the Word Processor

public loadWordProcessor(string $Name, mixed $Value) : string

Full featured TinyMCE text editor with custom WIKINDX plugins.

The minimum width is 790 px and the minimum height is 550 px

Parameters
$Name : string

id/name of the HTML textarea

$Value : mixed

Content of the HTML textarea

Return values
string

getDialogUrl()

Get the dialog title of a custom external plugin for TinyMCE 5

protected getDialogUrl(string $plugin_id[, string $BT = '' ]) : string

Custom available plugins are:

  • wkxcharmap: Choice Special Characters
  • wkxcite: Select and insert a citation
  • wkxfootnote: Insert a footnote
  • wkximage: Upload, select, upload, insert an image
  • wkxpaste: Toggle the paste mode (text/HTML)
  • wkxsectionbreak: Insert a Section Break Point
  • wkxstats: Some statistics about the editor's content
  • wkxwpexport: Export a paper of the Word Processor

See the TinyMCE documentation about external plugins for configuration:

Parameters
$plugin_id : string

Id of a custom external plugin

$BT : string = ''

Default ''

Tags
see
https://www.tiny.cloud/docs/configure/integration-and-setup/#external_plugins
Return values
string

getIncludeTinyMceLib()

Include tinymce compressor

protected getIncludeTinyMceLib([string $BT = '' ]) : string
Parameters
$BT : string = ''

Default ''

Return values
string

getLocale()

Determines from the user's preferred locale the closest locale available in TinyMCE

protected getLocale() : string

TinyMCE translations are available online at:

Tags
see
https://www.tiny.cloud/get-tiny/language-packages/
Return values
string —

Code of a locale (format: ll[_CC])

getPluginUrl()

Get the url of a custom external plugin for TinyMCE 5

protected getPluginUrl(string $plugin_id[, string $BT = '' ]) : string

Custom available plugins are:

  • wkxcharmap: Choice Special Characters
  • wkxcite: Select and insert a citation
  • wkxfootnote: Insert a footnote
  • wkximage: Upload, select, upload, insert an image
  • wkxpaste: Toggle the paste mode (text/HTML)
  • wkxsectionbreak: Insert a Section Break Point
  • wkxstats: Some statistics about the editor's content
  • wkxwpexport: Export a paper of the Word Processor

See the TinyMCE documentation about external plugins for configuration:

Parameters
$plugin_id : string

Id of a custom external plugin

$BT : string = ''

Default ''

Tags
see
https://www.tiny.cloud/docs/configure/integration-and-setup/#external_plugins
Return values
string —

An absolute url


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results