Documentation

Methods

AddLink( linkName, urlPrefix [, urlSuffix ] )

Description

This function has three parameters, a link name, prefix (main URL) and an optional suffix parameter. The current grammar point will be placed between the prefix and suffix of the link.

Parameters

Name	Type	Attributes	Description
`linkName`	string		Link Name
`urlPrefix`	string		URL Prefix
`urlSuffix`	string	<optional>	Can be used for adding additional search queries

Examples

//Search Jisho.org
AddLink("Jisho", "https://jisho.org/search/");

//Search Wikitionary.org, add #Japanese anchor link
AddLink("Wikitionary", "https://en.wiktionary.org/wiki/","#Japanese");

Details

AddDivider( [ padding [, dividerSymbol ] ] )

Description

Adds a vertical divider between links with set spacing.

Parameters

Name	Type	Attributes	Default	Description
`padding`	int	<optional>	10	Measured in pixels (px).
`dividerSymbol`	string	<optional>	\|

Examples

//Standard 10px divider
AddDivider();

//30px divider with the character "-".
AddDivider(30, "-");

Details

ClearToolbox()

Description

Clears all default links and dividers from the toolbox.

Details

AddPDFLink( pdfTitle, pdfURL [, pdfParameters ] )

Description

This function has three parameters, a PDF title, local PDF URL and a parameter for optional PDF parameters.

Warning
This feature is experimental, modern browsers will block links to local URLs for security purposes. An browser extension, such as this extension for Google Chrome can enable this feature.

Parameters

Name	Type	Attributes	Description
`pdfTitle`	string		The name of the linK, this must match exactly with the names used on Bunpro (excludes non alphanumeric characters).
`pdfURL`	string		The local URL of your PDF file. Must be preceeded with 'file://'
`pdfParameters`	string	<optional>	May be used for adding additional PDF parameters

Examples

//Adds a link to the PDF that matches 'Genki II 2nd Edition'.
AddPDFLink("Genki II 2nd Edition","file:///C:/Users/YOUR_USER/Documents//GenkiElementaryII.pdf");

//Adds a link to the PDF that matches 'DAJB'.
AddPDFLink("DAJG","file:///C:/Users/YOUR_USER/Documents/DAJG.pdf");

//Adds a link to the PDF that matches 'AIAIJ', includes optional query to set zoom level.
AddPDFLink("AIAIJ","file:///C:/Users/YOUR_USER/Documents/AIAIJ.pdf", "zoom=120");