Ayllu

UploadLog

Tue, 11 Aug 2009 21:57:54 GMT

date	user	location	storeUrl	uploadDir	toFilename	backupdir	origin
13/02/2009 23:17:10	AlfonsoReyes	reyesaguayo.osp.index.html	store.php	.	index.html	backup	ok
13/02/2009 23:39:26	AlfonsoReyes	reyesaguayo.osp.index.html	store.php	.	index.html	backup	ok
21/03/2009 21:13:30	YourName	reyesaguayo.osp.index.html	store.php	.	index.html	backup
21/03/2009 21:14:06	YourName	reyesaguayo.osp.index.html	store.php	.	index.html	backup
21/03/2009 21:14:50	AlfonsoReyes	reyesaguayo.osp.index.html	store.php	.	index.html	backup	ok
27/03/2009 09:53:35	AlfonsoReyes	reyesaguayo.osp.index.html	store.php	.	index.html	backup	ok
27/03/2009 10:05:43	AlfonsoReyes	reyesaguayo.osp.index.html	store.php	.	index.html	backup	ok
11/08/2009 16:52:44	YourName	ayllu.html	store.php	.	index.html	backup
11/08/2009 16:53:37	AlfonsoReyes	ayllu.html	store.php	.	index.html	backup	ok
11/08/2009 16:57:54	AlfonsoReyes	ayllu.html	store.php	.	index.html	backup

centralApp

Tue, 11 Aug 2009 21:57:00 GMT

centralApp

This is an application that uses Ordinary Differential Equations to find a solution to a body under a central force.

Launch centralApp
centralApp.jpg

Features

Initializes and uses the class at main to resize and locate panel:
Uses a subclass to resolve the ODE
Uses RK4 (Runge Kutta) method for the ODE
The subclass uses values from the master class

Java vs. Jython learnings

Pay attention to the import sintax

view plain copy to clipboard print ?
from org.opensourcephysics.display.axes import PolarType1
from org.opensourcephysics.display.axes import PolarType1
in Java was:
view plain copy to clipboard print ?
import org.opensourcephysics.display.axes.PolarType1;
import org.opensourcephysics.display.axes.PolarType1;

While in Java is not necessary, the Math import has to be explicitly declared in Jython

view plain copy to clipboard print ?
from java.lang import Math # for math functions
from java.lang import Math  # for math functions

For arrays in Jython is better to use the Java arrays

view plain copy to clipboard print ?
import java.lang.reflect.Array # for Java arrays
import java.lang.reflect.Array # for Java arrays
it is easier to use than Jarray

Use of subclasses

We defined a class for ODE work. It is important to have the master class as a passing parameter if we want later to manipulate its fields.
view plain copy to clipboard print ?
class central_der(ODE):
    def __init__(self, central):
        ''''' this will allow us to manipulate parent class fields and methods '''
        self.central = central
        return

    def getState(self):
        return self.central.state;

    def getRate(self, state, rate):         # getRate(double[] state, double[] rate)
        # this is better than writing a bunch of self.central in the equations
        a=self.central.a; m=self.central.m; L=self.central.L; p=self.central.p
        rate[0]=state[1];
        print rate[0], self.central.a, self.central.m, self.central.L
        rate[1]=-(a/m)*Math.pow(state[0],p)+L*L/m/m/Math.pow(state[0],3)
        rate[2]=L/m/state[0]/state[0]
        rate[3]=1; # dt/dt=1
    class central_der(ODE):
        def __init__(self, central):
            ''' this will allow us to manipulate parent class fields and methods '''
            self.central = central
            return        

        def getState(self):
            return self.central.state;

        def getRate(self, state, rate):         # getRate(double[] state, double[] rate)
            # this is better than writing a bunch of self.central in the equations 
            a=self.central.a; m=self.central.m; L=self.central.L; p=self.central.p
            rate[0]=state[1];
            print rate[0], self.central.a, self.central.m, self.central.L
            rate[1]=-(a/m)*Math.pow(state[0],p)+L*L/m/m/Math.pow(state[0],3)
            rate[2]=L/m/state[0]/state[0]
            rate[3]=1; # dt/dt=1        

Initializing the CalculationControl class in the main method

view plain copy to clipboard print ?
if __name__ == '__main__':
    model = centralApp()
    myControl = CalculationControl
    myControl = CalculationControl(model)
    print dir(myControl)
    myControl.setLocation(520, 5)
    myControl.setSize(275,505)
    myControl.setDividerLocation(250)
    model.setControl(myControl)
if __name__ == '__main__':
    model = centralApp()
    myControl = CalculationControl
    myControl = CalculationControl(model)
    print dir(myControl)
    myControl.setLocation(520, 5)
    myControl.setSize(275,505)
    myControl.setDividerLocation(250)
    model.setControl(myControl) 

Location

This application is located in the Hasbun Mechanics collection.

Remote Ayllu

Tue, 11 Aug 2009 21:56:00 GMT

http://reyesaguayo.com/osp/index.html

MatrixRotationApp.Summary

Tue, 11 Aug 2009 21:49:00 GMT

MatrixRotationApp

Launch MatrixRotationApp JWS application

This is 3D application showing the rotation of an ellipsoid in real time. The ellipsoid is created and animated using threading.

Java Code

MatrixRotationApp.java

Jython Code

MatrixRotationApp.py

SurfaceArrayApp.Summary

Tue, 11 Aug 2009 21:48:00 GMT

SurfaceArrayApp

Launch SurfaceArrayApp JWS application

Description

Creates a surface plot from an array.

Java Code

SurfaceArrayApp.java

Jython Code

SurfaceArrayApp.py

List of Applications in Jython

Tue, 11 Aug 2009 21:47:00 GMT

ReactionApp

Launch ReactionApp JWS application

Description

This application solves an autocatalytic oscillating chemical reaction (Brusselator model) using a fouth-order Runge-Kutta algorithm.

Java Code

Reaction.java ReactionApp.java

Jython Code

Reaction.py ReactionApp.py

centralApp

Launch centralApp JWS application

This is an application that uses Ordinary Differential Equations to find a solution to a body under a central force.

Java Code

centralApp.java

Jython Code

centralApp.py

ProjectileApp

Launch ProjectileApp JWS application

Description

This is the classic projectile application showing a 2D animated trajectory. Angle and velocity can be changed from the parameters window.

Java Code

Projectile.java ProjectileApp.java

Jython Code

Projectile.py ProjectileApp.py

MatrixRotationApp

Launch MatrixRotationApp JWS application

This is 3D application showing the rotation of an ellipsoid in real time. The ellipsoid is created and animated using threading.

Java Code

MatrixRotationApp.java

Jython Code

MatrixRotationApp.py

SurfaceArrayApp

Launch SurfaceArrayApp JWS application

Description

Creates a surface plot from an array.

Java Code

SurfaceArrayApp.java

Jython Code

SurfaceArrayApp.py

ReactionApp.Summary

Tue, 11 Aug 2009 21:47:00 GMT

ReactionApp

Launch ReactionApp JWS application

Description

This application solves an autocatalytic oscillating chemical reaction (Brusselator model) using a fouth-order Runge-Kutta algorithm.

Java Code

Reaction.java ReactionApp.java

Jython Code

Reaction.py ReactionApp.py

DefaultTiddlers

Tue, 11 Aug 2009 21:43:00 GMT

List of Applications in Jython

SurfaceArrayApp

Tue, 11 Aug 2009 21:42:00 GMT

SurfaceArrayApp

Creates a surface plot from an array.
Launch SurfaceArrayApp

Features
3D view
Can obtain diferent 3D views and rotate if you press and drag the mouse cursor
Multidimensional arrays
Java vs. Jython Learnings
Use of arraydata to create a multidimensional array.
<

In Java:

view plain copy to clipboard print ?

ArrayData arraydata = new ArrayData(32, 32, 1);

ArrayData arraydata = new ArrayData(32, 32, 1);

In Jython:

view plain copy to clipboard print ?

arraydata = ArrayData(32, 32, 1)

arraydata = ArrayData(32, 32, 1)

Explicit declaration in Jython of JFrame while in Java is not necessary

view plain copy to clipboard print ?

import javax.swing.JFrame;

import javax.swing.JFrame;

ReactionApp

Tue, 11 Aug 2009 21:37:00 GMT

ReactionApp

This application solves an autocatalytic oscillating chemical reaction (Brusselator model) using a fouth-order Runge-Kutta algorithm.

Launch ReactionApp

centralApp.Summary

Tue, 11 Aug 2009 21:33:00 GMT

centralApp

Launch centralApp JWS application

This is an application that uses Ordinary Differential Equations to find a solution to a body under a central force.

Java Code

centralApp.java

Jython Code

centralApp.py

ProjectileApp.Summary

Tue, 11 Aug 2009 21:29:00 GMT

ProjectileApp

Launch ProjectileApp JWS application

Description

This is the classic projectile application showing a 2D animated trajectory. Angle and velocity can be changed from the parameters window.

Java Code

Projectile.java ProjectileApp.java

Jython Code

Projectile.py ProjectileApp.py

ProjectileApp

Tue, 11 Aug 2009 21:28:00 GMT

ProjectileApp

This is the classic projectile application showing a 2D animated trajectory. Angle and velocity can be changed from the parameters window.

Launch ProjectileApp

Features

Can change projectile launch from control box
Animated trajectory
Plot for horizontal position versus height
Plot for x,y position vs. time

MatrixRotationApp

Tue, 11 Aug 2009 21:24:00 GMT

MatrixRotationApp

This is 3D application showing the rotation of an ellipsoid in real time. The ellipsoid is created and animated using threading.

Launch MatrixRotationApp

Features

Rotates in real time
Can obtain diferent 3D views and rotate if you press and drag the mouse cursor

Java vs. Jython learnings

Have to declare explicitly some modules in Jython

view plain copy to clipboard print ?
#These four modules not explicitly declared in Java
import javax.swing.JFrame
from java.lang import Exception
from java.lang import Thread
from java.lang import Math
#These four modules not explicitly declared in Java
import javax.swing.JFrame
from java.lang import Exception
from java.lang import Thread
from java.lang import Math

Try and except differ a little bit from Java cousin

view plain copy to clipboard print ?
while(True):    # animate until the program exits
    try:
        Thread.sleep(100)
    except InterruptedException, e:
        print "this exception", e
    theta += Math.PI/40
    while(True):    # animate until the program exits
        try:
            Thread.sleep(100)
        except InterruptedException, e:
            print "this exception", e         
        theta += Math.PI/40
while in Java is:
view plain copy to clipboard print ?
while(true) { // animate until the program exits
  try {
    Thread.sleep(100);
  } catch(InterruptedException ex) {}
  theta += Math.PI/40;
    while(true) { // animate until the program exits
      try {
        Thread.sleep(100);
      } catch(InterruptedException ex) {}
      theta += Math.PI/40;

ReactionApp - OSP Images in tables - 2 columns - Using Parted

Tue, 11 Aug 2009 20:18:00 GMT

ReactionApp

Launch ReactionApp JWS application

Description

TiddlyWiki, being a single file, is best utilized by storing images elsewhere. Here is an image and the code to present it. In this case it also includes a tooltip and link to a larger version of the image.

Java Code

Reaction.java ReactionApp.java

Jython Code

Reaction.py ReactionApp.py

Reaction.java

Tue, 11 Aug 2009 19:48:00 GMT

package org.opensourcephysics.davidson.ode.basic_examples;
import org.opensourcephysics.numerics.ODE;

/**
 * Reaction models an autocatalytic oscillating chemical reaction (Brusselator model)
 * by implementing the ODE interface.
 * @author Wolfgang Christian
 * @version 1.0
 */
public class Reaction implements ODE {
  double[] state = new double[3]; // X, Y, t
  double k1=1.0, k2=2.5, k3=1.0, k4=1.0; // reaction rates
  double A=1, B=1;       // reactant concenterations

  /**
   * Constructs an autocatalytic oscillating chemical reaction using the given initial conditions.
   * @param initialConditions double[]
   */
  Reaction(double[] initialConditions){
     state=(double[])initialConditions.clone();
  }

  /**
   * Gets the model's state variables.
   * @return double[]
   */
  public double[] getState() { return state; }

  /**
   * Computes the rate using the given state.
   * @param state double[] the state that will be used to compute the rate
   * @param rate double[]  the computed rate
   */
  public void getRate(double[] state, double[] rate ){
    double xxy=state[0]*state[0]*state[1];
    rate[0] = k1*A-k2*B*state[0]+k3*xxy-k4*state[0];  // X rate
    rate[1] = k2*B*state[0]-k3*xxy ; // Y rate
    rate[2] = 1; // time derivative
  }
}

ReactionApp.java

Tue, 11 Aug 2009 19:48:00 GMT

view plain copy to clipboard print ?

package org.opensourcephysics.davidson.ode.basic_examples;
import org.opensourcephysics.controls.*;
import org.opensourcephysics.numerics.*;
import org.opensourcephysics.frames.*;
/**
* ReactionApp solves an autocatalytic oscillating chemical reaction (Brusselator model) using
* a fouth-order Runge-Kutta algorithm.
* @author Wolfgang Christian
* @version 1.0
*/
public class ReactionApp extends AbstractSimulation {
Reaction reaction;
ODESolver solver;
PlotFrame phasePlot= new PlotFrame("X","Y","Product Phase Space");
PlotFrame timePlot= new PlotFrame("t","X and Y","Reaction Products");
/**
* Initializes the simulation by reading parameters from the control.
*/
public void initialize(){
double x = control.getDouble("X");
double y = control.getDouble("Y");
reaction = new Reaction(new double[]{x, y, 0}); // create reaction model
solver = new RK4(reaction); // create solver for this model
}
/**
* Steps (advances) the reaction and plots the results.
* The solver increments the time using its internal stepsize.
*/
protected void doStep() {
solver.step();
timePlot.append(0,reaction.state[2],reaction.state[0]);
timePlot.append(1,reaction.state[2],reaction.state[1]);
phasePlot.append(0,reaction.state[0],reaction.state[1]);
}
/**
* Resets the reaction into a predefined state.
*/
public void reset() {
timePlot.setConnected(true); // connect data points with straight line segments
phasePlot.setConnected(true); // connect data points with straight line segments
control.setValue("X","1");
control.setValue("Y",5);
control.setValue("dt",0.1);
enableStepsPerDisplay(true);
initialize();
}
/**
* Starts the ReactionApp program.
* @param args String[]
*/
public static void main(String[] args) { SimulationControl.createApp(new ReactionApp(), args); }
}

package org.opensourcephysics.davidson.ode.basic_examples;

import org.opensourcephysics.controls.*;
import org.opensourcephysics.numerics.*;
import org.opensourcephysics.frames.*;

/**
 * ReactionApp solves an autocatalytic oscillating chemical reaction (Brusselator model) using
 * a fouth-order Runge-Kutta algorithm.
 * @author Wolfgang Christian
 * @version 1.0
 */
public class ReactionApp extends AbstractSimulation {
   Reaction reaction;
   ODESolver solver;
   PlotFrame phasePlot= new PlotFrame("X","Y","Product Phase Space");
   PlotFrame timePlot= new PlotFrame("t","X and Y","Reaction Products");

   /**
    * Initializes the simulation by reading parameters from the control.
    */
   public void initialize(){
      double x = control.getDouble("X");
      double y = control.getDouble("Y");
      reaction = new Reaction(new double[]{x, y, 0}); // create reaction model
      solver = new RK4(reaction);                     // create solver for this model
   }

   /**
    * Steps (advances) the reaction and plots the results.
    * The solver increments the time using its internal stepsize.
    */
   protected void doStep() {
      solver.step();
      timePlot.append(0,reaction.state[2],reaction.state[0]);
      timePlot.append(1,reaction.state[2],reaction.state[1]);
      phasePlot.append(0,reaction.state[0],reaction.state[1]);
   }

   /**
    * Resets the reaction into a predefined state.
    */
   public void reset() {
      timePlot.setConnected(true);  // connect data points with straight line segments
      phasePlot.setConnected(true); // connect data points with straight line segments
      control.setValue("X","1");
      control.setValue("Y",5);
      control.setValue("dt",0.1);
      enableStepsPerDisplay(true);
      initialize();
   }

   /**
    * Starts the ReactionApp program.
    * @param args String[]
    */
   public static void main(String[] args) { SimulationControl.createApp(new ReactionApp(), args); }
}

ReactionApp - OSP Images in tables - 2 columns

Tue, 11 Aug 2009 19:45:00 GMT

ReactionApp

Launch ReactionApp
TiddlyWiki, being a single file, is best utilized by storing images elsewhere. Here is an image and the code to present it. In this case it also includes a tooltip and link to a larger version of the image.

StyleSheet

Tue, 11 Aug 2009 19:42:00 GMT

.stretch img {
width:100%;
}

.borderlessL, .borderlessL table, .borderlessL td, .borderlessL tr, .borderlessL th, .borderlessL tbody { border:0 !important; margin:0 !important; padding:2px !important; td.vertical-align:top !important;margin-left: 0 !important; margin-right: auto !important;}
.borderless, .borderless table, .borderless td, .borderless tr, .borderless th, .borderless tbody { border:0 !important; margin:0 !important; padding:2px !important; td.vertical-align:top !important;margin-left: auto !important; margin-right: auto !important;}
.rolodex table {
border: 0px solid;
}
.rolodex tr, .rolodex td {
border: 0px solid;
}

.consoleClass{
color: #fff; background: #000;
font-family: 'Consolas' monospace;
}

.borderlessL, .borderlessL table, .borderlessL td, .borderlessL tr, .borderlessL th, .borderlessL tbody { border:0 !important; margin:0 !important; padding:0 !important; td.vertical-align:top !important;margin-left: 0 !important; margin-right: auto !important; padding:7px !important;}

.imgfloatleft{float:left;} .imgfloatright{float:right;padding:5px} .imgfloatcenter{float:center;}

.viewer img { padding:0em 1em 0em 0em; }

StyleSheetSyntaxHighlighter
MptwStyleSheet

PartTiddlerPlugin

Tue, 11 Aug 2009 19:29:00 GMT

Name:	PartTiddlerPlugin
Version:	1.0.9 (2007-07-14)
Source:	http://tiddlywiki.abego-software.de/#PartTiddlerPlugin
Author:	UdoBorkowski (ub [at] abego-software [dot] de)
Licence:	BSD open source license
CoreVersion:	2.1.3
Browser:	Firefox 1.0.4+; InternetExplorer 6.0

Table of Content

Description

With the <part aPartName> ... </part> feature you can structure your tiddler text into separate (named) parts.
Each part can be referenced as a "normal" tiddler, using the "tiddlerName/partName" syntax (e.g. "About/Features"). E.g. you may create links to the parts (e.g. [[Quotes/BAX95]] or [[Hobbies|AboutMe/Hobbies]]), use it in <<tiddler...>> or <<tabs...>> macros etc.

Syntax:

<part partName [hidden] > any tiddler content </part>
partName	The name of the part. You may reference a part tiddler with the combined tiddler name "nameOfContainerTidder/partName. Error in macro <<br>>If you use a partName containing spaces you need to quote it (e.g. `"Major Overview"` or `[[Shortcut List]]`).
hidden	When defined the content of the part is not displayed in the container tiddler. But when the part is explicitly referenced (e.g. in a `<<tiddler...>>` macro or in a link) the part's content is displayed.
any tiddler content	The content of the part. A part can have any content that a "normal" tiddler may have, e.g. you may use all the formattings and macros defined.
_{Syntax formatting: Keywords in bold, optional parts in [...]. 'or' means that exactly one of the two alternatives must exist.}

_[Top]

Applications

Refering to Paragraphs of a Longer Tiddler

Assume you have written a long description in a tiddler and now you want to refer to the content of a certain paragraph in that tiddler (e.g. some definition.) Just wrap the text with a part block, give it a nice name, create a "pretty link" (like [[Discussion Groups|Introduction/DiscussionGroups]]) and you are done.

Notice this complements the approach to first writing a lot of small tiddlers and combine these tiddlers to one larger tiddler in a second step (e.g. using the <<tiddler...>> macro). Using the part feature you can first write a "classic" (longer) text that can be read "from top to bottom" and later "reuse" parts of this text for some more "non-linear" reading.

_[Top]

Citation Index

Create a tiddler "Citations" that contains your "citations".
Wrap every citation with a part and a proper name.

Example

<part BAX98>Baxter, Ira D. et al: //Clone Detection Using Abstract Syntax Trees.// 
in //Proc. ICSM//, 1998.</part>

<part BEL02>Bellon, Stefan: //Vergleich von Techniken zur Erkennung duplizierten Quellcodes.// 
Thesis, Uni Stuttgart, 2002.</part>

<part DUC99>Ducasse, Stéfane et al: //A Language Independent Approach for Detecting Duplicated Code.// 
in //Proc. ICSM//, 1999.</part>

You may now "cite" them just by using a pretty link like [[Citations/BAX98]] or even more pretty, like this [[BAX98|Citations/BAX98]].

_[Top]

Creating "multi-line" Table Cells

You may have noticed that it is hard to create table cells with "multi-line" content. E.g. if you want to create a bullet list inside a table cell you cannot just write the bullet list

* Item 1
* Item 2
* Item 3

into a table cell (i.e. between the | ... | bars) because every bullet item must start in a new line but all cells of a table row must be in one line.

Using the part feature this problem can be solved. Just create a hidden part that contains the cells content and use a <<tiddler >> macro to include its content in the table's cell.

Example

|!Subject|!Items|
|subject1|<<tiddler ./Cell1>>|
|subject2|<<tiddler ./Cell2>>|

<part Cell1 hidden>
* Item 1
* Item 2
* Item 3
</part>
...

Notice that inside the <<tiddler ...>> macro you may refer to the "current tiddler" using the ".".

BTW: The same approach can be used to create bullet lists with items that contain more than one line.

_[Top]

Creating Tabs

The build-in <<tabs ...>> macro requires that you defined an additional tiddler for every tab it displays. When you want to have "nested" tabs you need to define a tiddler for the "main tab" and one for every tab it contains. I.e. the definition of a set of tabs that is visually displayed at one place is distributed across multiple tiddlers.

With the part feature you can put the complete definition in one tiddler, making it easier to keep an overview and maintain the tab sets.

Example
The standard tabs at the sidebar are defined by the following eight tiddlers:

Instead of these eight tiddlers one could define the following SideBarTabs tiddler that uses the part feature:

<<tabs txtMainTab 
    Timeline Timeline SideBarTabs/Timeline 
    All 'All tiddlers' SideBarTabs/All 
    Tags 'All tags' SideBarTabs/Tags 
    More 'More lists' SideBarTabs/More>>
<part Timeline hidden><<timeline>></part>
<part All hidden><<list all>></part>
<part Tags hidden><<allTags>></part>
<part More hidden><<tabs txtMoreTab 
    Missing 'Missing tiddlers' SideBarTabs/Missing 
    Orphans 'Orphaned tiddlers' SideBarTabs/Orphans 
    Shadowed 'Shadowed tiddlers' SideBarTabs/Shadowed>></part>
<part Missing hidden><<list missing>></part>
<part Orphans hidden><<list orphans>></part>
<part Shadowed hidden><<list shadowed>></part>

Notice that you can easily "overwrite" individual parts in separate tiddlers that have the full name of the part.

E.g. if you don't like the classic timeline tab but only want to see the 100 most recent tiddlers you could create a tiddler "SideBarTabs/Timeline" with the following content:

<<forEachTiddler 
		sortBy 'tiddler.modified' descending 
		write '(index < 100) ? "* [["+tiddler.title+"]]\n":""'>>

_[Top]

Using Sliders

Very similar to the build-in <<tabs ...>> macro (see above) the <<slider ...>> macro requires that you defined an additional tiddler that holds the content "to be slid". You can avoid creating this extra tiddler by using the part feature

Example
In a tiddler "About" we may use the slider to show some details that are documented in the tiddler's "Details" part.

...
<<slider chkAboutDetails About/Details details "Click here to see more details">>
<part Details hidden>
To give you a better overview ...
</part>
...

Notice that putting the content of the slider into the slider's tiddler also has an extra benefit: When you decide you need to edit the content of the slider you can just doubleclick the content, the tiddler opens for editing and you can directly start editing the content (in the part section). In the "old" approach you would doubleclick the tiddler, see that the slider is using tiddler X, have to look for the tiddler X and can finally open it for editing. So using the part approach results in a much short workflow.

_[Top]

Revision history

v1.0.9 (2007-07-14)
- Bugfix: Error when using the SideBarTabs example and switching between "More" and "Shadow". Thanks to cmari for reporting the issue.
v1.0.8 (2007-06-16)
- Speeding up display of tiddlers containing multiple pard definitions. Thanks to Paco Rivière for reporting the issue.
- Support "./partName" syntax inside
  macro
v1.0.7 (2007-03-07)
- Bugfix: does not always render correctly after a refresh (e.g. like it happens when using the "Include" plugin). Thanks to Morris Gray for reporting the bug.
v1.0.6 (2006-11-07)
- Bugfix: cannot edit tiddler when UploadPlugin by Bidix is installed. Thanks to José Luis González Castro for reporting the bug.
v1.0.5 (2006-03-02)
- Bugfix: Example with multi-line table cells does not work in IE6. Thanks to Paulo Soares for reporting the bug.
v1.0.4 (2006-02-28)
- Bugfix: Shadow tiddlers cannot be edited (in TW 2.0.6). Thanks to Torsten Vanek for reporting the bug.
v1.0.3 (2006-02-26)
- Adapt code to newly introduced Tiddler.prototype.isReadOnly() function (in TW 2.0.6). Thanks to Paulo Soares for reporting the problem.
v1.0.2 (2006-02-05)
- Also allow other macros than the "tiddler" macro use the "." in the part reference (to refer to "this" tiddler)
v1.0.1 (2006-01-27)
- Added Table of Content for plugin documentation. Thanks to RichCarrillo for suggesting.
- Bugfix: newReminder plugin does not work when PartTiddler is installed. Thanks to PauloSoares for reporting.
v1.0.0 (2006-01-25)
- initial version

_[Top]

Code

_[Top]

view plain copy to clipboard print ?

//============================================================================
// PartTiddlerPlugin
// Ensure that the PartTiddler Plugin is only installed once.
//
if (!version.extensions.PartTiddlerPlugin) {
version.extensions.PartTiddlerPlugin = {
major: 1, minor: 0, revision: 9,
date: new Date(2007, 6, 14),
type: 'plugin',
source: "http://tiddlywiki.abego-software.de/#PartTiddlerPlugin"
};
if (!window.abego) window.abego = {};
if (version.major < 2) alertAndThrow("PartTiddlerPlugin requires TiddlyWiki 2.0 or newer.");
//============================================================================
// Common Helpers
// Looks for the next newline, starting at the index-th char of text.
//
// If there are only whitespaces between index and the newline
// the index behind the newline is returned,
// otherwise (or when no newline is found) index is returned.
//
var skipEmptyEndOfLine = function(text, index) {
var re = /(\n|[^\s])/g;
re.lastIndex = index;
var result = re.exec(text);
return (result && text.charAt(result.index) == '\n')
? result.index+1
: index;
}
//============================================================================
// Constants
var partEndOrStartTagRE = /(<\/part>)|(<part(?:\s+)((?:[^>])+)>)/mg;
var partEndTagREString = "<\\/part>";
var partEndTagString = "</part>";
//============================================================================
// Plugin Specific Helpers
// Parse the parameters inside a <part ...> tag and return the result.
//
// @return [may be null] {partName: ..., isHidden: ...}
//
var parseStartTagParams = function(paramText) {
var params = paramText.readMacroParams();
if (params.length == 0 || params[0].length == 0) return null;
var name = params[0];
var paramsIndex = 1;
var hidden = false;
if (paramsIndex < params.length) {
hidden = params[paramsIndex] == "hidden";
paramsIndex++;
}
return {
partName: name,
isHidden: hidden
};
}
// Returns the match to the next (end or start) part tag in the text,
// starting the search at startIndex.
//
// When no such tag is found null is returned, otherwise a "Match" is returned:
// [0]: full match
// [1]: matched "end" tag (or null when no end tag match)
// [2]: matched "start" tag (or null when no start tag match)
// [3]: content of start tag (or null if no start tag match)
//
var findNextPartEndOrStartTagMatch = function(text, startIndex) {
var re = new RegExp(partEndOrStartTagRE);
re.lastIndex = startIndex;
var match = re.exec(text);
return match;
}
//============================================================================
// Formatter
// Process the <part ...> ... </part> starting at (w.source, w.matchStart) for formatting.
//
// @return true if a complete part section (including the end tag) could be processed, false otherwise.
//
var handlePartSection = function(w) {
var tagMatch = findNextPartEndOrStartTagMatch(w.source, w.matchStart);
if (!tagMatch) return false;
if (tagMatch.index != w.matchStart || !tagMatch[2]) return false;
// Parse the start tag parameters
var arguments = parseStartTagParams(tagMatch[3]);
if (!arguments) return false;
// Continue processing
var startTagEndIndex = skipEmptyEndOfLine(w.source, tagMatch.index + tagMatch[0].length);
var endMatch = findNextPartEndOrStartTagMatch(w.source, startTagEndIndex);
if (endMatch && endMatch[1]) {
if (!arguments.isHidden) {
w.nextMatch = startTagEndIndex;
w.subWikify(w.output,partEndTagREString);
}
w.nextMatch = skipEmptyEndOfLine(w.source, endMatch.index + endMatch[0].length);
return true;
}
return false;
}
config.formatters.push( {
name: "part",
match: "<part\\s+[^>]+>",
handler: function(w) {
if (!handlePartSection(w)) {
w.outputText(w.output,w.matchStart,w.matchStart+w.matchLength);
}
}
} )
//============================================================================
// Extend "fetchTiddler" functionality to also recognize "part"s of tiddlers
// as tiddlers.
var currentParent = null; // used for the "." parent (e.g. in the "tiddler" macro)
// Return the match to the first <part ...> tag of the text that has the
// requrest partName.
//
// @return [may be null]
//
var findPartStartTagByName = function(text, partName) {
var i = 0;
while (true) {
var tagMatch = findNextPartEndOrStartTagMatch(text, i);
if (!tagMatch) return null;
if (tagMatch[2]) {
// Is start tag
// Check the name
var arguments = parseStartTagParams(tagMatch[3]);
if (arguments && arguments.partName == partName) {
return tagMatch;
}
}
i = tagMatch.index+tagMatch[0].length;
}
}
// Return the part "partName" of the given parentTiddler as a "readOnly" Tiddler
// object, using fullName as the Tiddler's title.
//
// All remaining properties of the new Tiddler (tags etc.) are inherited from
// the parentTiddler.
//
// @return [may be null]
//
var getPart = function(parentTiddler, partName, fullName) {
var text = parentTiddler.text;
var startTag = findPartStartTagByName(text, partName);
if (!startTag) return null;
var endIndexOfStartTag = skipEmptyEndOfLine(text, startTag.index+startTag[0].length);
var indexOfEndTag = text.indexOf(partEndTagString, endIndexOfStartTag);
if (indexOfEndTag >= 0) {
var partTiddlerText = text.substring(endIndexOfStartTag,indexOfEndTag);
var partTiddler = new Tiddler();
partTiddler.set(
fullName,
partTiddlerText,
parentTiddler.modifier,
parentTiddler.modified,
parentTiddler.tags,
parentTiddler.created);
partTiddler.abegoIsPartTiddler = true;
return partTiddler;
}
return null;
}
// Hijack the store.fetchTiddler to recognize the "part" addresses.
//
var hijackFetchTiddler = function() {
var oldFetchTiddler = store.fetchTiddler ;
store.fetchTiddler = function(title) {
var result = oldFetchTiddler.apply(this, arguments);
if (!result && title) {
var i = title.lastIndexOf('/');
if (i > 0) {
var parentName = title.substring(0, i);
var partName = title.substring(i+1);
var parent = (parentName == ".")
? store.resolveTiddler(currentParent)
: oldFetchTiddler.apply(this, [parentName]);
if (parent) {
return getPart(parent, partName, parent.title+"/"+partName);
}
}
}
return result;
};
};
// for debugging the plugin is not loaded through the systemConfig mechanism but via a script tag.
// At that point in the "store" is not yet defined. In that case hijackFetchTiddler through the restart function.
// Otherwise hijack now.
if (!store) {
var oldRestartFunc = restart;
window.restart = function() {
hijackFetchTiddler();
oldRestartFunc.apply(this,arguments);
};
} else
hijackFetchTiddler();
// The user must not edit a readOnly/partTiddler
//
config.commands.editTiddler.oldIsReadOnlyFunction = Tiddler.prototype.isReadOnly;
Tiddler.prototype.isReadOnly = function() {
// Tiddler.isReadOnly was introduced with TW 2.0.6.
// For older version we explicitly check the global readOnly flag
if (config.commands.editTiddler.oldIsReadOnlyFunction) {
if (config.commands.editTiddler.oldIsReadOnlyFunction.apply(this, arguments)) return true;
} else {
if (readOnly) return true;
}
return this.abegoIsPartTiddler;
}
config.commands.editTiddler.handler = function(event,src,title)
{
var t = store.getTiddler(title);
// Edit the tiddler if it either is not a tiddler (but a shadowTiddler)
// or the tiddler is not readOnly
if(!t || !t.abegoIsPartTiddler)
{
clearMessage();
story.displayTiddler(null,title,DEFAULT_EDIT_TEMPLATE);
story.focusTiddler(title,"text");
return false;
}
}
// To allow the "./partName" syntax in macros we need to hijack
// the invokeMacro to define the "currentParent" while it is running.
//
var oldInvokeMacro = window.invokeMacro;
function myInvokeMacro(place,macro,params,wikifier,tiddler) {
var oldCurrentParent = currentParent;
if (tiddler) currentParent = tiddler;
try {
oldInvokeMacro.apply(this, arguments);
} finally {
currentParent = oldCurrentParent;
}
}
window.invokeMacro = myInvokeMacro;
// To correctly support the "./partName" syntax while refreshing we need to hijack
// the config.refreshers.tiddlers to define the "currentParent" while it is running.
//
(function() {
var oldTiddlerRefresher= config.refreshers.tiddler;
config.refreshers.tiddler = function(e,changeList) {
var oldCurrentParent = currentParent;
try {
currentParent = e.getAttribute("tiddler");
return oldTiddlerRefresher.apply(this,arguments);
} finally {
currentParent = oldCurrentParent;
}
};
})();
// Support "./partName" syntax inside <<tabs ...>> macro
(function() {
var extendRelativeNames = function(e, title) {
var nodes = e.getElementsByTagName("a");
for(var i=0; i<nodes.length; i++) {
var node = nodes[i];
var s = node.getAttribute("content");
if (s && s.indexOf("./") == 0)
node.setAttribute("content",title+s.substr(1));
}
};
var oldHandler = config.macros.tabs.handler;
config.macros.tabs.handler = function(place,macroName,params,wikifier,paramString,tiddler) {
var result = oldHandler.apply(this,arguments);
if (tiddler)
extendRelativeNames(place, tiddler.title);
return result;
};
})();
// Scroll the anchor anchorName in the viewer of the given tiddler visible.
// When no tiddler is defined use the tiddler of the target given event is used.
window.scrollAnchorVisible = function(anchorName, tiddler, evt) {
var tiddlerElem = null;
if (tiddler) {
tiddlerElem = document.getElementById(story.idPrefix + tiddler);
}
if (!tiddlerElem && evt) {
var target = resolveTarget(evt);
tiddlerElem = story.findContainingTiddler(target);
}
if (!tiddlerElem) return;
var children = tiddlerElem.getElementsByTagName("a");
for (var i = 0; i < children.length; i++) {
var child = children[i];
var name = child.getAttribute("name");
if (name == anchorName) {
var y = findPosY(child);
window.scrollTo(0,y);
return;
}
}
}
} // of "install only once"

//============================================================================
//                           PartTiddlerPlugin

// Ensure that the PartTiddler Plugin is only installed once.
//
if (!version.extensions.PartTiddlerPlugin) {



version.extensions.PartTiddlerPlugin = {
    major: 1, minor: 0, revision: 9,
    date: new Date(2007, 6, 14), 
    type: 'plugin',
    source: "http://tiddlywiki.abego-software.de/#PartTiddlerPlugin"
};

if (!window.abego) window.abego = {};
if (version.major < 2) alertAndThrow("PartTiddlerPlugin requires TiddlyWiki 2.0 or newer.");

//============================================================================
// Common Helpers

// Looks for the next newline, starting at the index-th char of text. 
//
// If there are only whitespaces between index and the newline 
// the index behind the newline is returned, 
// otherwise (or when no newline is found) index is returned.
//
var skipEmptyEndOfLine = function(text, index) {
	var re = /(\n|[^\s])/g;
	re.lastIndex = index;
	var result = re.exec(text);
	return (result && text.charAt(result.index) == '\n') 
			? result.index+1
			: index;
}


//============================================================================
// Constants

var partEndOrStartTagRE = /(<\/part>)|(<part(?:\s+)((?:[^>])+)>)/mg;
var partEndTagREString = "<\\/part>";
var partEndTagString = "</part>";

//============================================================================
// Plugin Specific Helpers

// Parse the parameters inside a <part ...> tag and return the result.
//
// @return [may be null] {partName: ..., isHidden: ...}
//
var parseStartTagParams = function(paramText) {
	var params = paramText.readMacroParams();
	if (params.length == 0 || params[0].length == 0) return null;
	
	var name = params[0];
	var paramsIndex = 1;
	var hidden = false;
	if (paramsIndex < params.length) {
		hidden = params[paramsIndex] == "hidden";
		paramsIndex++;
	}
	
	return {
		partName: name, 
		isHidden: hidden
	};
}

// Returns the match to the next (end or start) part tag in the text, 
// starting the search at startIndex.
// 
// When no such tag is found null is returned, otherwise a "Match" is returned:
// [0]: full match
// [1]: matched "end" tag (or null when no end tag match)
// [2]: matched "start" tag (or null when no start tag match)
// [3]: content of start tag (or null if no start tag match)
//
var findNextPartEndOrStartTagMatch = function(text, startIndex) {
	var re = new RegExp(partEndOrStartTagRE);
	re.lastIndex = startIndex;
	var match = re.exec(text);
	return match;
}

//============================================================================
// Formatter

// Process the <part ...> ... </part> starting at (w.source, w.matchStart) for formatting.
//
// @return true if a complete part section (including the end tag) could be processed, false otherwise.
//
var handlePartSection = function(w) {
	var tagMatch = findNextPartEndOrStartTagMatch(w.source, w.matchStart);
	if (!tagMatch) return false;
	if (tagMatch.index != w.matchStart || !tagMatch[2]) return false;

	// Parse the start tag parameters
	var arguments = parseStartTagParams(tagMatch[3]);
	if (!arguments) return false;
	
	// Continue processing
	var startTagEndIndex = skipEmptyEndOfLine(w.source, tagMatch.index + tagMatch[0].length);
	var endMatch = findNextPartEndOrStartTagMatch(w.source, startTagEndIndex);
	if (endMatch && endMatch[1]) {
		if (!arguments.isHidden) {
			w.nextMatch = startTagEndIndex;
			w.subWikify(w.output,partEndTagREString);
		}
		w.nextMatch = skipEmptyEndOfLine(w.source, endMatch.index + endMatch[0].length);
		
		return true;
	}
	return false;
}

config.formatters.push( {
    name: "part",
    match: "<part\\s+[^>]+>",
	
	handler: function(w) {
		if (!handlePartSection(w)) {
			w.outputText(w.output,w.matchStart,w.matchStart+w.matchLength);
		}
	}
} )

//============================================================================
// Extend "fetchTiddler" functionality to also recognize "part"s of tiddlers 
// as tiddlers.

var currentParent = null; // used for the "." parent (e.g. in the "tiddler" macro)

// Return the match to the first <part ...> tag of the text that has the
// requrest partName.
//
// @return [may be null]
//
var findPartStartTagByName = function(text, partName) {
	var i = 0;
	
	while (true) {
		var tagMatch = findNextPartEndOrStartTagMatch(text, i);
		if (!tagMatch) return null;

		if (tagMatch[2]) {
			// Is start tag
	
			// Check the name
			var arguments = parseStartTagParams(tagMatch[3]);
			if (arguments && arguments.partName == partName) {
				return tagMatch;
			}
		}
		i = tagMatch.index+tagMatch[0].length;
	}
}

// Return the part "partName" of the given parentTiddler as a "readOnly" Tiddler 
// object, using fullName as the Tiddler's title. 
//
// All remaining properties of the new Tiddler (tags etc.) are inherited from 
// the parentTiddler.
// 
// @return [may be null]
//
var getPart = function(parentTiddler, partName, fullName) {
	var text = parentTiddler.text;
	var startTag = findPartStartTagByName(text, partName);
	if (!startTag) return null;
	
	var endIndexOfStartTag = skipEmptyEndOfLine(text, startTag.index+startTag[0].length);
	var indexOfEndTag = text.indexOf(partEndTagString, endIndexOfStartTag);

	if (indexOfEndTag >= 0) {
		var partTiddlerText = text.substring(endIndexOfStartTag,indexOfEndTag);
		var partTiddler = new Tiddler();
		partTiddler.set(
						fullName,
						partTiddlerText,
						parentTiddler.modifier,
						parentTiddler.modified,
						parentTiddler.tags,
						parentTiddler.created);
		partTiddler.abegoIsPartTiddler = true;
		return partTiddler;
	}
	
	return null;
}

// Hijack the store.fetchTiddler to recognize the "part" addresses.
//
var hijackFetchTiddler = function() {
	var oldFetchTiddler = store.fetchTiddler ;
	store.fetchTiddler = function(title) {
		var result = oldFetchTiddler.apply(this, arguments);
		if (!result && title) {
			var i = title.lastIndexOf('/');
			if (i > 0) {
				var parentName = title.substring(0, i);
				var partName = title.substring(i+1);
				var parent = (parentName == ".") 
						? store.resolveTiddler(currentParent)
						: oldFetchTiddler.apply(this, [parentName]);
				if (parent) {
					return getPart(parent, partName, parent.title+"/"+partName);
				}
			}
		}
		return result;	
	};
};

// for debugging the plugin is not loaded through the systemConfig mechanism but via a script tag. 
// At that point in the "store" is not yet defined. In that case hijackFetchTiddler through the restart function.
// Otherwise hijack now.
if (!store) {
	var oldRestartFunc = restart;
	window.restart = function() {
		hijackFetchTiddler();
		oldRestartFunc.apply(this,arguments);
	};
} else
	hijackFetchTiddler();




// The user must not edit a readOnly/partTiddler
//

config.commands.editTiddler.oldIsReadOnlyFunction = Tiddler.prototype.isReadOnly;

Tiddler.prototype.isReadOnly = function() {
	// Tiddler.isReadOnly was introduced with TW 2.0.6.
	// For older version we explicitly check the global readOnly flag
	if (config.commands.editTiddler.oldIsReadOnlyFunction) {
		if (config.commands.editTiddler.oldIsReadOnlyFunction.apply(this, arguments)) return true;
	} else {
		if (readOnly) return true;
	}

	return this.abegoIsPartTiddler;
}

config.commands.editTiddler.handler = function(event,src,title)
{
	var t = store.getTiddler(title);
	// Edit the tiddler if it either is not a tiddler (but a shadowTiddler)
	// or the tiddler is not readOnly
	if(!t || !t.abegoIsPartTiddler)
		{
		clearMessage();
		story.displayTiddler(null,title,DEFAULT_EDIT_TEMPLATE);
		story.focusTiddler(title,"text");
		return false;
		}
}

// To allow the "./partName" syntax in macros we need to hijack 
// the invokeMacro to define the "currentParent" while it is running.
// 
var oldInvokeMacro = window.invokeMacro;
function myInvokeMacro(place,macro,params,wikifier,tiddler) {
	var oldCurrentParent = currentParent;
	if (tiddler) currentParent = tiddler;
	try {
		oldInvokeMacro.apply(this, arguments);
	} finally {
		currentParent = oldCurrentParent;
	}
}
window.invokeMacro = myInvokeMacro;

// To correctly support the "./partName" syntax while refreshing we need to hijack 
// the config.refreshers.tiddlers to define the "currentParent" while it is running.
// 
(function() {
	var oldTiddlerRefresher= config.refreshers.tiddler;
	config.refreshers.tiddler = function(e,changeList) {
		var oldCurrentParent = currentParent;
		try {
			currentParent = e.getAttribute("tiddler");
			return oldTiddlerRefresher.apply(this,arguments);
		} finally {
			currentParent = oldCurrentParent;
		}
	};
})();

// Support "./partName" syntax inside <<tabs ...>> macro
(function() {
	var extendRelativeNames = function(e, title) {
		var nodes = e.getElementsByTagName("a");
		for(var i=0; i<nodes.length; i++) {
			var node = nodes[i];
			var s = node.getAttribute("content");
			if (s && s.indexOf("./") == 0)
				node.setAttribute("content",title+s.substr(1));
		}
	};
	var oldHandler = config.macros.tabs.handler;
	config.macros.tabs.handler = function(place,macroName,params,wikifier,paramString,tiddler) {
		var result = oldHandler.apply(this,arguments);
		if (tiddler)
			extendRelativeNames(place, tiddler.title);
		return result;
	};
})();

// Scroll the anchor anchorName in the viewer of the given tiddler visible.
// When no tiddler is defined use the tiddler of the target given event is used.
window.scrollAnchorVisible = function(anchorName, tiddler, evt) {
	var tiddlerElem = null;
	if (tiddler) {
		tiddlerElem = document.getElementById(story.idPrefix + tiddler);
	}
	if (!tiddlerElem && evt) {
		var target = resolveTarget(evt);
		tiddlerElem = story.findContainingTiddler(target);
	}
	if (!tiddlerElem) return;

	var children = tiddlerElem.getElementsByTagName("a");
	for (var i = 0; i < children.length; i++) {
		var child = children[i];
		var name = child.getAttribute("name");
		if (name == anchorName) {
			var y = findPosY(child);
			window.scrollTo(0,y);
			return;
		}
	}
}

} // of "install only once"

_[Top]

Licence and Copyright

Copyright (c) abego Software GmbH, 2006 (www.abego-software.de)

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.

Neither the name of abego Software nor the names of its contributors may be
used to endorse or promote products derived from this software without specific
prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

_[Top]