abegoExtensions

abegoExtensions News

Tue, 16 Feb 2010 16:39:02 GMT

2010-02-16

YourSearchPlugin v2.1.5 released
- Fixed problems with CSS and search textfield. Thanks to Guido Glatzel for reporting.

2009-12-29

Added the ForEachTiddlerPlugin example 'List all tasks completed on a journal tiddler's day, as a "Daily Status Report"'. Based on an idea by cmari and Alan Cohen. Thanks.

2009-10-09

Revised the NewTiddlerWithFormMacro documentation

2009-09-04

YourSearchPlugin v2.1.4 released
- Fixed "this command is not supported" error under IE 8. Thanks to rouilj for reporting. (For details see: http://groups.google.com/group/TiddlyWiki/browse_thread/thread/cffee3254381e478)

2008-05-04

Improved TiddlyWiki style for better appearance in Safari

2008-04-16

YourSearchPlugin v2.1.3 released
- Fixed problem with Firefox3. Thanks to Andreas Hoefler for reporting.

2008-03-17

YourSearchPlugin v2.1.2 released
- Bugfix: on IE (6.0) the first letter is dropped from the search string. Thanks to Kashgarinn and Nick Padfield for reporting.

^{For older news see the revision history of the various plugins.}

MainMenu

Tue, 16 Feb 2010 16:33:00 GMT

About
TiddlyWiki
abego Software
News

Plugins
Installing Plugins

Download
Archive
Donations

^{© 2005-2010
abego Software}

PageTemplate

Tue, 16 Feb 2010 16:31:00 GMT

<div class='header' macro='gradient vert #ff8000 #ffb200'>
<div class='headerForeground'>
<span class='siteTitle'><b>abego</b>Extensions
</span>
<table width="99%"><tr><td>

<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'></span></td><td align="right"><span macro='search "" buttonAtRight:1'></span></td></tr></table>
</div>
</div>
<div id='mainMenu' refresh='content' tiddler='MainMenu'></div>
<div id='sidebar'>
<div id='sidebarOptions' refresh='content' tiddler='SideBarOptions'></div>
<div id='sidebarTabs' refresh='content' force='true' tiddler='SideBarTabs'></div>
</div>
<div id='displayArea'>
<div id='messageArea'></div>
<div id='tiddlerDisplay'></div>
</div>

StyleSheet

Tue, 16 Feb 2010 16:29:00 GMT

Colors Used

#ffb200 - Primary Color
#ffcc66 - Primary Color Light
#ff8000- Primary Color Bright
#b75b00 - Primary Color Dark
#666666 - Text Color Light
#703 - Title Color

.header {
	background: #ffb200;
}
.headerForeground {
	color: #000;
}
.headerForeground a {
	color: #000;
}

a {
	color: #666666;
}

a:hover{
	color: #666666;
}

#sidebarOptions input {
	border: 1px solid #ff8000;
}

#sidebarOptions .sliderPanel {
	background: #ffcc66;
}

#sidebarOptions .sliderPanel a {
	color: #b75b00;
}

#sidebarOptions .sliderPanel a:hover {
	color: #ff8000;
}

#sidebarOptions .sliderPanel a:active {
	color: #ff8000;
	background: #fff;
}
h1,h2,h3,h4,h5 {
	margin-top: 1em;
	color: #703;
	background: #ffcc66;
}

Other Styling

.headerForeground {
	position:relative; 
	padding:0.3em 0em 1em 1em; 
	left:-1px; top:-1px;
}

.headerForeground table {
	width: 100%;
}

a {
	font-family: Arial, Helvetica, sans-serif;
	text-decoration: none;
}

a:hover{
	text-decoration: underline;
	background: none;
}

.button:hover {
	text-decoration: none;
}

.abegoLink .externalLink {
	font-weight: bold;
	text-decoration: none;
}

.abegoLink .externalLink:hover {
	font-weight: bold;
	text-decoration: underline;
}

#mainMenu .tiddlyLinkExisting, 
#mainMenu .tiddlyLinkNonExisting{
	font-weight: bold;
	font-style: normal;
}

#sidebarOptions .sliderPanel a {
	color: #b75b00;
}

#sidebarOptions .sliderPanel a:hover {
	background:none;
}
.optionsBlock {
	padding: 0.5em;
	margin-left: 0.5em;
	overflow: auto;
	border: 1px solid #b75b00;
}
.txtOptionInput {width:30em;}

YourSearchPlugin

Tue, 16 Feb 2010 16:23:00 GMT

Name:	YourSearchPlugin
Version:	2.1.5 (2010-02-16)
Source:	http://tiddlywiki.abego-software.de/#YourSearchPlugin
Author:	UdoBorkowski (ub [at] abego-software [dot] de)
Licence:	BSD open source license (abego Software)
Copyright:	© 2005-2010 abego Software
CoreVersion:	2.1.0
Community:	del.icio.us
Browser:	Firefox 1.0.4+; Firefox 1.5; InternetExplorer 6.0

About YourSearch

YourSearch gives you a bunch of new features to simplify and speed up your daily searches in TiddlyWiki. It seamlessly integrates into the standard TiddlyWiki search: just start typing into the 'search' field and explore!

For more information see Help.

Compatibility

This plugin requires TiddlyWiki 2.1.
Check the archive for YourSearchPlugins supporting older versions of TiddlyWiki.

Source Code

This plugin's source code is compressed (and hidden). Use this link to get the readable source code.

29 December 2009

Tue, 29 Dec 2009 14:36:00 GMT

Daily Status Report

<<forEachTiddler ...>>: TypeError: context.viewerTiddler is null

DailyStatusReport

Tue, 29 Dec 2009 14:36:00 GMT

Daily Status Report

<<forEachTiddler ...>>: TypeError: context.viewerTiddler is null

List all tasks completed on a journal tiddler's day, as a "Daily Status Report"

Tue, 29 Dec 2009 14:36:00 GMT

Assume in a "journal" tiddler you want to see all tasks you completed that day. For every task you have tiddler with its details. When it is completed you add the date to the title (make sure to spell the date exactly as in the journal tiddler title).

Then you can add the following forEachTiddler macro to the journal tiddler to list all these tasks:

<<forEachTiddler 
 where 
 'tiddler.title.contains(context.viewerTiddler.title) && tiddler.title != context.viewerTiddler.title' 
 sortBy 
 'tiddler.title' 
write '"!![["+tiddler.title+"]]\n"+tiddler.tags+"\n"+tiddler.text+"\n"'
>>

Instead of copying this long statement to each journal tiddler you better create a helper tiddler with just the forEachTiddler macro call. Later you can "include" the helper tiddler in each journal tiddler.

E.g. have a look at the tiddler DailyStatusReport. You can now add a line like:

<<tiddler DailyStatusReport>>

into the journal tiddlers (e.g. as in journal tiddler "29 December 2009") to get the daily status report for that day.

(Based on code suggested by cmari and Alan Cohen. Thanks)

Added sample tiddlers for "Daily Status Report" example (29 December 2009)

Tue, 29 Dec 2009 14:35:00 GMT

[ ... Here goes the detailed documentation for the tiddler ... ]

Published new abegoExtensions revision (29 December 2009)

Tue, 29 Dec 2009 14:35:00 GMT

[ ... Here goes the detailed documentation for the tiddler ... ]

Added "Daily Status Report" example (29 December 2009)

Tue, 29 Dec 2009 14:34:00 GMT

[ ... Here goes the detailed documentation for the tiddler ... ]

NewTiddlerWithFormMacro

Fri, 09 Oct 2009 15:03:00 GMT

The newTiddlerWithForm Macro

To create tiddlers that are referencing FormTemplates you may use the <<newTiddlerWithForm...>> macro.

The <<newTiddlerWithForm...>> macro displays a button. When pressed the button creates the requested tiddler and displays it.

If no title is given in the macro (or a tiddler with the given name already exists) the user can enter the tiddlers name in a dialog.

Syntax:

`<<`newTiddlerWithForm formTemplateName buttonLabel [titleExpression [askUser]] `>>`
formTemplateName	The name of the tiddler that defines the form the new tiddler should use.
buttonLabel	The label of the button
titleExpression	A (quoted) JavaScript String expression that defines the title (/name) of the new tiddler.
askUser	Typically the user is not asked for the title when a title is specified (and not yet used). When askUser is given the user will be asked in any case. This may be used when the calculated title is just a suggestion that must be confirmed by the user
_{Syntax formatting: Keywords in bold, optional parts in [...]. 'or' means that exactly one of the two alternatives must exist.}

Examples

Ask the user for a bug report name and create a bugreport.

<<newTiddlerWithForm BugReportTemplate "New Bugreport">>

New Bugreport

Create a blog entry tiddler. Let the user confirm the automatically generated title (that contains the current date) or change it.

<<newTiddlerWithForm 
 BlogTemplate 
 "New Blog" 
 '"Blog: "+(new Date()).formatString("YYYY-MM-DD")' askUser
>>

New Blog

Using the build-in newTiddler macro

Instead of the <<newTiddlerWithForm>> macro you may also use the build-in <<newTiddler>> macro to create tiddlers referencing FormTemplates. E.g. you may use the <<newTiddler>> macro to create a tiddler with tags .

In the "text" you need to call the formTiddler macro and in the tagparameters you specify your tags. E.g.:

<<newTiddler
        label:"Button Label"
        text:{{"<<formTiddler [[MyTemplateTiddler]]>"+">"}}
        tag:"MyTag1"
        tag:"Three Word Tag" 
>>

For details on newTiddler see http://tiddlywiki.org/wiki/NewTiddler_%28macro%29

AdvancedOptions

Thu, 16 Jul 2009 08:30:00 GMT

Tweak advanced options

These options are saved in cookies in your browser

Option	Description	Name
	Enable animations	chkAnimate
	Automatically save changes	chkAutoSave
	Name of folder to use for backups	txtBackupFolder
	Case-sensitive searching	chkCaseSensitiveSearch
	Require confirmation before deleting tiddlers	chkConfirmDelete
	Default character set for saving changes (Firefox/Mozilla only)	txtFileSystemCharSet
	Don't update modifier username and date when editing tiddlers	chkForceMinorUpdate
	Generate an RSS feed when saving changes	chkGenerateAnRssFeed
	Hide editing features when viewed over HTTP	chkHttpReadOnly
	Use the tab key to insert tab characters instead of moving between fields	chkInsertTabs
	Maximum number of rows in edit boxes	txtMaxEditRows
	Open external links in a new window	chkOpenInNewWindow
	Enable regular expressions for searches	chkRegExpSearch
	Keep backup file when saving changes	chkSaveBackups
	Generate an empty template when saving changes	chkSaveEmptyTemplate
	Clicking on links to open tiddlers causes them to close	chkToggleLinks
	Username for signing your edits	txtUserName

Show unknown options

Include TiddlyWikis (IncludeList | IncludeState | help)
^{(Reload this TiddlyWiki to make changes become effective)}
Private Settings: Use private settings. Make setting private when changed. Show Settings.
^{(Private settings are stored in this TiddlyWiki, shared settings are stored as cookies. For more information see the Settings documentation.)}
Use 'Your Search' (more options) (help)
Sort 'Your Search' result by Date

Sort YourSearch Result (e.g. by date)

Thu, 16 Jul 2009 08:29:00 GMT

The items in the YourSearch result list are displayed in a "ranked" order, i.e. the best matches are listed first.

If you want any other ordering (e.g. sort by date) you need to make the function abego.YourSearch.getRankFunction() return a different rank function function(tiddler, lastQuery). The number returned by the rankFunction defines the position of the given tiddler in the result. Higher numbers are displayed first. Tiddlers with same rank numbers are sorted by their titles (case sensitive).

Example: Sort by title

As tiddlers with the same rank number are sorted by their title you may use the following simple script to get the YourSearch result alphabetically sorted:

<script>
var myZeroRankFunction = function(tiddler, lastQuery) {
    return 0;
};

abego.YourSearch.getRankFunction = function() {
    return myZeroRankFunction;
}
</script>

Example: Sort by date

For a "sort by last modified date" ordering you may use this script:

<script>
var myDateRankFunction = function(tiddler, lastQuery) {
    return tiddler.modified.getTime();
};

abego.YourSearch.getRankFunction = function() {
    return myDateRankFunction;
}
</script>

Use the Standard Ordering

To switch back to the standard ordering you may use this code use:

<script>
abego.YourSearch.getRankFunction = abego.YourSearch.getStandardRankFunction;
</script>

(Note: there are no () behind the abego.YourSearch.getStandardRankFunction)

Switch between "Standard" and "By Date" Ordering

With just some few lines more you can use a checkbox to switch between "standard" and "by date" sorting.

To define the checkbox add a line like the following in a tiddler (e.g. in AdvancedOptions):

<<option chkYourSearchSortByDate>> Sort 'Your Search' result by Date

Sort 'Your Search' result by Date
(Clicking the checkbox will affect the next query you type).

And here the script that adjusts the ranking/sorting:

<script>
var myDateRankFunction = function(tiddler, lastQuery) {
    return tiddler.modified.getTime();
};

abego.YourSearch.getRankFunction = function() {
return config.options.chkYourSearchSortByDate 
        ? myDateRankFunction
         : abego.YourSearch.getStandardRankFunction();
}
</script>

List all hidden tiddlers of included TiddlyWikis

Wed, 15 Jul 2009 07:46:00 GMT

If a tiddler name is used in more than one TiddlyWiki (e.g. in the main TiddlyWiki and some included TiddlyWiki) only one of these tiddlers is visible, the others are hidden. For details see How Tiddlers are found.

The following script reports all "hidden" tiddlers, also reporting the TiddlyWiki containing them.

<script>
// List all hidden tiddlers of included TiddlyWikis
// see http://tiddlywiki.abego-software.de/#[[How%20Tiddlers%20are%20found]]

// By default hidden tiddlers with names of shadow tiddlers in the main TiddlyWiki
// are not reported. Set the following variable to false if these should also be reported.
var ignoreShadowTiddlers = true;


// returns the url (if defined) or the text "main ~TiddlyWiki" 
var twLabel = function(url) {
    return url ? url : "main ~TiddlyWiki";
}

var hiddenTiddlers = [];
var incls = abego.TiddlyWikiIncluder.getIncludes();
var n = incls.length;
for (var i = 0; i < n; i++) {
    var url = incls[i]
    var twStore = abego.TiddlyWikiIncluder.getStore(url);
    if (twStore == null) {
        displayMessage("not found "+url);
        continue;
    }

    twStore.forEachTiddler(function(title,tiddler) {
        var foundTiddler = store.getTiddler(tiddler.title);
        if (foundTiddler == null) {
            // no tiddler with this title found (using getTiddler), 
            // so this must be a shadow tiddler in the main TiddlyWiki.
            if (!ignoreShadowTiddlers) {
                hiddenTiddlers.push("[["+title+"]] in "+url+" (using shadow tiddler from "+twLabel(null)+")");
            }
        } else if (tiddler != foundTiddler) {
            if (!ignoreShadowTiddlers || config.shadowTiddlers[[title]] == undefined) {
                hiddenTiddlers.push("[["+title+"]] in "+url+" (using tiddler from "+twLabel(foundTiddler.includeURL)+")");
            }
        }
    });
}

return hiddenTiddlers.length 
        ? "!Hidden Tiddlers\n# "+hiddenTiddlers.join("\n# ")+"]]\n" 
        : "No tiddlers are hidden.";
</script>

No tiddlers are hidden.

How Tiddlers are found

Wed, 15 Jul 2009 07:42:00 GMT

When you specify a link to a tiddler a tiddler with that title is searched at the following locations:

In the "normal" tiddlers of the main TiddlyWiki
In the "shadow" tiddlers of the main TiddlyWiki
In the "normal" tiddlers of all included TiddlyWikis, in the order of the include macros.
(You may use The "includeState" Macro to check the order)

The first tiddler found this way is used.

Note: If two tiddlers in two TiddlyWikis have the same name, the one from the first TiddlyWiki is used, i.e. the other is "hidden". The script "List all hidden tiddlers of included TiddlyWikis" can be used to detect hidden tiddlers.

Programming with the IncludePlugin

Wed, 15 Jul 2009 07:41:00 GMT

Every TiddlyWiki included using the IncludePlugin is loaded into memory and can be accessed through a "TiddlyWiki" object. This is a "TiddlyWiki" object just as the object stored in the global "store" object, used to access the TiddlyWiki you are running.

To get the TiddlyWiki ("store") object of an included TiddlyWiki you may use:

	var includedStore = abego.TiddlyWikiIncluder.getStore(tiddyWikiURL)

With the returned TiddlyWiki object you can do the same things you would do with the "store" object. E.g. you may iterate through the Tiddlers of the store etc.

Example: List tiddlers from included TiddlyWiki changed after a given date

Assume you have included "http://www.tiddlywiki.com/index.html" and want to list the tiddlers of that TiddlyWiki that have changed after July 1st, 2007.

You may then use this script:

<script>
var twStore = abego.TiddlyWikiIncluder.getStore("http://www.tiddlywiki.com/index.html");
var list = [];
twStore.forEachTiddler(function(title,tiddler) {
    if (tiddler.modified > new Date("July 1, 2007"))
        list.push(title);
});
return "* [["+list.join("]]\n* [[")+"]]\n";
</script>

(To use the <script> tag you must install the InlineJavascriptPlugin (http:www.TiddlyTools.com/#InlineJavascriptPlugin))

(See also List Tiddlers of an included TiddlyWiki (using the ForEachTiddlerMacro))

Example: List all hidden Tiddlers of included TiddlyWikis

For a more extended example see: List all hidden tiddlers of included TiddlyWikis

FormTiddler Introduction

Mon, 29 Dec 2008 10:58:00 GMT

The FormTiddlerPlugin allows you to enter your data in a form and store the form's data in your tiddlers.

(For more information on tiddler data see the DataTiddlerPlugin.)

Define FormTemplate

When you want to enter data in a form you first have to define a FormTemplate tiddler. A FormTemplate tiddler is a tiddler that contains named HTML INPUT elements (such as textfields, password fields, lists etc.) that define the stuff that should be edited in the form. E.g. you may have a FormTemplate that looks like this:

Name:

Password:

The correspond HTML text looks like this

<html>
 <b>Name:</b><br/>
 <input name=userName type=text /><br/>
 <b>Password:</b><br/>
 <input name=pwd type=password /><br/>
</html>

The name of the INPUT element is also the name of the data field it is editing. E.g. a text field defined like this:

<input name=userName type=text />

will edit the data field "userName" of the tiddler.

You are free to layout the INPUT elements as you like, but don't add a "form" element around them and don't define 'onchange' handlers, since this will be done automatically by the <<formTiddler ...>> macro.

Use FormTemplates (through the <<formTiddler ...>> macro)

In a second step you add the <<formTiddler ...>> macro to tiddlers that should be edited. In the macro you are referencing the FormTemplate that should be used to edit the tiddler's data. You may refer to the same FormTemplate tiddler in as many tiddlers as you like. Every such tiddler displays the same INPUT elements as the FormTemplate, but with the "data" of each individual tiddler.

In addition you may have more than one <<formTiddler...>> macro call in one tiddler. Just make sure that the names of the elements in the referenced FormTemplate tiddlers do not collide. This feature may be useful if you want to construct a larger input form from a set of smaller FormTemplates.

You can easily create tiddlers with an embedded <<formTiddler...>> macro call using the <<newTiddlerWithForm...>> macro. The macro shows a button similar to the "new tiddler" button and creates the requested tiddler, ready to enter data. For details see NewTiddlerWithFormMacro.

"Structured" and "Free" Data

Typically you will edit a tiddler that uses the <<formTiddler...>> macro through the form. But you are free to also edit the tiddler "as usual", through the build-in edit feature. I.e. you may mix "structured data" (as entered through the form) with "free data". I.e. on a "Contact" tiddler you may add an image to the tiddler, or add extra links to related persons. Or you add more tags. Just make sure that you don't modify the <data>...</data> section of the tiddler, since this contains the data maintained by the form.

Also notice that since the data entered in the forms is stored in the tiddler's text (in the <data>...</data> section) using the "search" feature will also find the texts you entered in the forms (even though it will not hilite the texts in the fields).

Applications

Using the FormTiddlerPlugin it is easy to manage things like:

Contacts
Bugreports
ToDo Lists
and many more.

Since a FormTemplate is typically used for many tiddlers of the same kind you may also consider using the ForEachTiddlerMacro to collect data across multiple tiddlers (e.g. to get a list of all contacts, a summary page for the bug reports etc.)

(See also FormTiddler Examples)

HTML Elements

For those not that familiar with the HTML INPUT elements here a short overview with HTML snippets.

Type	HTML Example	Comment
button	`<input name=btn type=button value="Just a button" />`	no data
checkbox	`<input name=isVIP type=checkbox />is VIP`
file	`<input name=attachment type=file />`	The "file" input element typically does not restore the path of the previously selected file. Nevertheless the path of the file is stored in the tiddler.
hidden	`<input name=hiddenValue type=hidden value="This is a hidden value" />`
password	`<input name=pwd type=password />`	The data entered in a "password" field is stored as clear text in the tiddler.
radio	`<input name=level type=radio value="Beginner" />Beginner<input name=level type=radio value="Expert" />Expert<input name=level type=radio value="Guru" />Guru`
reset	`<input name=btnReset type=reset />`	no data
select-one	`<select name=browser ><option>Firefox<option>Internet Explorer<option>Opera<option>Other</select >`
select-multiple	`<select name=music MULTIPLE ><option> R&B <option> Jazz <option> Blues <option> New Age</select >`
submit	`<input name=btnSubmit type=submit />`	no data
text	`<input name=userName type=text/>`
textarea	`<TEXTAREA name=notes rows=4 cols=80 ></TEXTAREA>`

For details consult the Web or a textbook on HTML editing.

AutoRefreshPlugin

Thu, 05 Jun 2008 11:57:00 GMT

Name:	AutoRefreshPlugin
Version:	1.0.1 (2007-01-20)
Type:	plugin
Source:	http://tiddlywiki.abego-software.de/#AutoRefreshPlugin
Author:	Udo Borkowski (ub [at] abego-software [dot] de)
Documentation:	AutoRefreshPlugin Documentation
Licence:	BSD open source license (abego Software)
CoreVersion:	2.1.3
Browser:	Firefox 1.5.0.9 or better; Internet Explorer 6.0

A tiddler containing the <<autoRefresh...>> macro is automatically refreshed (re-painted) whenever a tiddler changes.

Syntax

<<autoRefresh [observeTiddler: tiddler ...]>>

observeTiddler (optional) when specified the refresh will only happen when one of the tiddlers specified is changed.

Source Code

if (!window.abego) window.abego = {};

// autoRefresh Macro =============================================================
//
(function() {


var REFRESHER_NAME = "abego_onEveryChange";

var tiddlersToRefresh = {}; // A set holding the names of tiddlers to be refreshed

var onEveryChangeRefresher = function(e,changeList) {
	
	var tiddlerElem = story.findContainingTiddler(e);
	if (!tiddlerElem) return false;

	var title = tiddlerElem.getAttribute("tiddler");
	if (!title) return false;

	// if "observeTiddler" are specified we only refresh if one of the given 
	// tiddlers has changed.
	var observedTiddlers = e.getAttribute("observedTiddlers");
	if (observedTiddlers) {
		var a = observedTiddlers.readBracketedList();
		if (!changeList || !a.containsAny(changeList))
			return;
	}

	// Refresh the tiddler asynchronously. 
	// This way we can avoid repeated refreshes (e.g. when a tiddler is renamed)
	tiddlersToRefresh[title] = true;
	setTimeout(function() {
		// Refresh all tiddlers in tiddlersToRefresh
		for(var title in tiddlersToRefresh)
			story.refreshTiddler(title,null,true);

		// We have refreshed all pending tiddlers. Clear the set.
		tiddlersToRefresh = {};
	}, 0);

	return true;
}

config.refreshers[REFRESHER_NAME] = onEveryChangeRefresher;


config.macros.autoRefresh = {};

config.macros.autoRefresh.handler = function(place,macroName,params,wikifier,paramString,tiddler) {
    params = paramString.parseParams("observeTiddler",null,true,false,true); // allowEval, cascadeDefaults, names allowed

	var e = createTiddlyElement(place,"span");
	e.setAttribute("refresh",REFRESHER_NAME);
	var observedTiddlers = params[0]["observeTiddler"];
	if (observedTiddlers && observedTiddlers.length) {
		var s = "[["+observedTiddlers.join("]] [[")+"]]";
		e.setAttribute("observedTiddlers",s);
	}
};


})();

DefaultTiddlers

Thu, 21 Feb 2008 11:40:00 GMT

About