Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.

TiddlyWiki Community Wiki

[edit] Startup

[edit] Event handler

[edit] Classes

• TiddlyWiki: store tiddlers and has functions for loading and saving tiddlers. It is instantiated in main() as the 'store' object.
• Dev:Tiddler: used to store information about an individual tiddler.
• Dev:Story: manages an HTML div containing a sequence of tiddlers. It is instantiated as 'story'.
• Dev:Wikifier: is used to display the contents of a tiddler.
• Dev:Formatter: is used (by a wikifier) to convert wikitext into HTML.
• Dev:Animator: manages different types of animations.
• Dev:Cascade: a specific type of animation used when opening a tiddler.
• Dev:Scroller: a specific type of animation that scrolls the browser window so that a DOM element is in view.
• Dev:Slider: a specific type of animation that "slides" open a DOM element. This is used, for example, when you click the options link on the right sidebar.
• Dev:String Methods: a number of utility methods are provided for the String class
• Dev:Array Methods: a number of utility methods are provided for the Array class
• Dev:Date Methods: a number of utility methods are provided for the Date class

[edit] Global Objects

• Dev:config: contains user preferences, macros, and shadow tiddlers.
• Dev:version: contains information about the currently running version of TiddlyWiki and plugins.

[edit] Functions

• Dev:Overriding core functions

• addClass: add a CSS class to a DOM element
• addEvent: add an event listener to a DOM element
• blurElement: remove focus from a DOM element
• clearMessage: clear the TiddlyWiki's message area
• convertUTF8toUnicode and convertUnicodeToUTF8: convert between UTF-8 and Unicode text encodings
• createExternalLink: create an external link
• createTagButton: create a button that pops open a list of tiddlers with a certain tag
• createTiddlyButton: create a button on the page
• createTiddlyElement: create a DOM element
• createTiddlyLink: create a link to another tiddler
• createTiddlyText: stuff text into a DOM element
• displayMessage: display a message in the TiddlyWiki's message area
• ensureVisible: find the vertical scroll position required to show a DOM element
• findPosX: find the horizontal position of a DOM element
• findPosY: find the vertical position of a DOM element
• findScrollX: find the horizontal page scroll position
• findScrollY: find the vertical page scroll position
• findWindowHeight: return the height of the browser window
• findWindowWidth: return the width of the browser window
• generateRSS: render recent changes to the TiddlyWiki as an RSS feed
• getNodeText: get text inside a DOM element
• getPlainText: get a plain text version of a DOM element
• hasClass: check whether a DOM element has a particular CSS class
• refreshTiddlyLink: re-render a link to a tiddler
• removeChildren: remove all child nodes from a DOM element
• removeClass: remove a CSS class from a DOM element
• removeEvent: remove an event listener from a DOM element
• resolveTarget: determine the target of a DOM event
• saveOptionCookie: save user options to a cookie
• saveChanges: save the TiddlyWiki to disk
• setStylesheet: add a stylesheet to the page
• wikify: render source code into a DOM element
• wikifyStatic: render source code offscreen
• wikifyPlain: render plain text

[edit] Variables