TipMaster - markItUp! Setting

Improves the TipMaster’s forums, Tek-Tips and Eng-Tips, by improving the markItUp! editor’s settings used in the post forms.

The markItUp! universal markup jQuery editor is very customizable. It keeps all its setting in the global mySettings JavaScript variable, so is enough to change that one.

Included modifications :

• Underline button’s associated key U removed.
• Strikethrough button’s associated key S removed.
• Superscript button associated with key S.
• Color drop-down list extended to the 16 HTML colors.
• Color drop-down buttons changed to insert [red] style tags instead of [color red].
• Highlight button added to insert [highlight] tags. ( Added to the site. )
• Highlight drop-down buttons added for the 6 pale colors I used to use. ( Added to the site. )
• Alignment drop-down added and Left, Center and Right buttons moved into the drop-down.
• Float drop-down added with Left and Right buttons to insert [floatl] and [floatr] tags respectively.
• Box drop-down added with Inline and Block buttons to insert [box] and [bbox] tags respectively.
• Picture button changed to use the selection as default URL.
• Picture button’s associated key P removed.
• YouTube button added to insert [youtube] tags.
• Link button’s associated key L removed.
• Drop-down list added to Emoticon button to insert the smileys I used most frequently.
• Monospaced button added to insert [tt] tags.
• Monospaced button associated with key M.
• Preformatted button added to insert [pre] tags.
• Small button added to insert [small] tags.
• Attention button added to insert [!] tags.
• Bulleted list button modified to enclose the entire selection with [ul] tags and each selected line in separate [li] tags. ( Fixed in markItUp! 1.1.x. )
• Bulleted list button associated with key U.
• Numeric list button modified to enclose the entire selection with [ol] tags and each selected line in separate [li] tags. ( Fixed in markItUp! 1.1.x. )
• Quote button modified to enclose the entire selection not each line separately. ( Fixed in markItUp! 1.1.x. )
• Code button modified to enclose the entire selection not each line separately. ( Fixed in markItUp! 1.1.x. )
• Spoiler button added to insert [spoiler] tags. ( Added to the site. )
• Ignore button added to insert [ignore] tag. ( Added to the site. )
• Composite button Key added to insert key-looking [box] tags sequence.
• Composite button Fake TGML added with Off Topic and Flame buttons to insert TGML-looking [fake]..[/fake] text.
• Composite button Documentation added with Perl, PHP, Tcl and Tk buttons to insert links to documentations of a give term.
• Composite button TipMaster Search added with Google Search, Yahoo! Search and Lycos Search buttons to insert link to search results for a given term.
• Composite button Canned Response to store and retrieve custom text snippets.
• Drop-down list added to Unicode button to insert the characters I think are used most frequently.

Screenshot

sample rendering without TipMaster - markItUp! Setting

sample rendering with TipMaster - markItUp! Setting 0.7 (!)

Usage

See markItUp!’s own documentation.

Key

Transforms a space separated list of key names into a key combination markup.

Example :
Alt Ctrl Del ➜ Alt-Ctrl-Del

If there is selected text, uses it as input, otherwise prompt()s the user for key list.

Fake TGML

Encloses a piece of text between a TGML-looking pair of text.

The toolbar button itself does nothing, the drop-down list’s buttons insert the text their names say. This is kind of joke, use it sparsely.

Warning !
Off topic and flame messages are not welcome on TipMaster forums. Using these fake TGML tags or not, you post will still be subject of edition or deletion.

Example :
text ➜ [off-topic]text[/off-topic]

If there is selected text, encloses it, otherwise uses the fake tag name as placeholder.

Documentation

Generates a link to the documentation of a given term.

Example :
print() ➜ print()

If there is selected text, uses it as input, otherwise prompt()s the user for documentation term.

TipMaster Search

Generates a link to a web search for a given term.

The toolbar button itself generates link to the current TipMaster site’s own search engine, the drop-down list’s buttons does similar work but for the web search engines I use most frequently.

Example :
term ➜ search Tek-Tips for “term”

If there is selected text, uses it as input, otherwise prompt()s the user for search term.

Canned Response

Manages a collection of predefined text snippets.

The toolbar button itself saves the current post content as canned response. The response’s title is requested from the user through a prompt(). If a response with the given title exists, its content is replaced with the new one, otherwise a new response is created.

The drop down buttons enumerate the available response titles. Clicking on any of them inserts the clicked one’s content into the post. Ctrl-clicking on any of them removes the clicked one after the user’s confirm(). Shift-clicking on any of them saves over the clicked response, after user’s confirm().

Responses may contain {{text}} placeholders, which will be replaced with the current selection, if exists, otherwise with nothing.

The responses are stored using the Greasemonkey script’s API, but that is not accessible after the script execution terminated. So adding, modifying and removing responses can not be performed directly. The changes first are stored in the sessionStorage and get finalized on the next page load. So after a response manipulation is requested, the user is alert()ed to reload the page. The drop-down list’s content reflects the finalized manipulations.

Warning : There is a problem with marItUp!’s key detection, sometimes ( mostly on the first action after page load ) the Ctrl and Shift key’s states are detected erroneously. Watch the confirmation dialogs carefully to avoid data loss. If you accidentally prepare a modification operation you can still cancel it by removing the corresponding sessionStorage entry before reloading the page.

Configuration

See markItUp!’s own documentation.

Documentation

If you add more entries to the Documentation button’s drop-down list you have to also add an entry to the documentation object’s url property. The key must be identical with button name. The value will be the URL to link to, it should contain a {{text}} placeholder, which will be replaced with the term to document.

This is expected to change radically in the future, though not guaranteed to be in the near future…

TipMaster Search

If you add more entries to the TipMaster Search button’s drop-down list you have to also add an entry to the websearch object’s url property. The key must be identical with button name, eventually without the “Search” word spaces surrounding it. The value will be the URL to link to, it should contain a {{text}} placeholder, which will be replaced with the term to search.

Versions

• 0.0 - May 2012
  • Initial release.
• 0.1 - May 2012
  • Ignore button added to insert [ignore] tag.
  • Key U moved from Underline button to Bulleted list button.
  • Picture button now uses selection as default URL instead of overwriting it.
• 0.2 - June 2012
  • Ignore button’s icon redesigned.
  • New composite buttons Key, Off Topic and Web Search.
  • Key Shift-Enter assigned to Preview action.
  • Key S assigned to the Superscript button.
  • Bullet List, Numbered List, Code, Quote and Spoiler buttons updated according to markItUp! 1.1.x.
• 0.3 - September 2012
  • Spoiler button’s icon is now the “official” gift box icon.
  • Emoticon button now has a drop-down list with the icons I used most frequently.
• 0.4 - October 2012
  • Preformatted button for the new [pre] tag.
• 0.5 - October 2012
  • Ignore button’s icon is now the “official” red bracket icon.
  • Left, Center and Right button’s icons now correctly represent the alignment type.
  • Preformatted button’s icon redesigned.
  • Off Topic button renamed to Fake TGML, functionality removed.
  • Fake TGML button now has a drop-down list with Off Topic and Flame buttons to insert the given fake markup.
  • Web Search button renamed to TipMaster Search, links to current TipMaster site’s own search engine.
  • TipMaster Search button now has a drop-down list Google Search, Yahoo! Search and Lycos Search buttons to various web searches.
  • New composite button Documentation with drop-down buttons Perl, PHP, Tcl and Tk.
  • New composite button Canned Response.
• 0.6 - October 2012
  • Monospace button moved near the text attribute buttons.
  • Highlight button’s icon is now the “official” marker icon.
  • New List button with drop-down containig Bulleted list, Numeric list and List item buttons.
  • Ignore button moved near the Clean button.
  • Key button changed to insert [kbd] tag instead of composite tag set.
  • Key button moved near the text buttons.
  • @grant metadata imperative according to Greasemonkey 1.0 API.
• 0.7 - March 2013
  • Emoticon, Help and Submit Post buttons now call the same functions as the “official” ones.
  • Minor adjustment on the forbidden activities list to not wrap.
• 0.8 - April 2013
  • New button Unicode, with the same functionality as the “official” one.
  • Unicode button now has a drop-down list with the characters I think are used most frequently.

Plans

• Add more documentation links.

Download

You can find the related files on GitHub in my Greasemonkey-script repository’s tipmaster-markitup-setting directory :

• TipMaster_-_markItUp_Setting.user.js - script