mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-10-02 00:40:47 +00:00
Code Issues Releases Wiki Activity

Add a relative date field viewer

Browse Source 
With a bit of attendant refactoring
This commit is contained in:
Jeremy Ruston 2012-10-28 18:18:05 +00:00
parent ecd933dd25
commit c6add09e54
7 changed files with 136 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
core/modules/macros/view/view.js
View File

@ -48,14 +48,22 @@ exports.executeMacro = function() {
} }
// Figure out which viewer to use // Figure out which viewer to use
// TODO: Tiddler field modules should be able to specify a field type from which the viewer is derived // TODO: Tiddler field modules should be able to specify a field type from which the viewer is derived
var Viewer;
if(tiddler && this.params.format) { if(tiddler && this.params.format) {
var viewer = this.wiki.macros.view.fieldviewers[this.params.format]; Viewer = this.wiki.macros.view.fieldviewers[this.params.format];
} }
if(!viewer) { if(!Viewer) {
viewer = this.wiki.macros.view.fieldviewers["text"]; Viewer = this.wiki.macros.view.fieldviewers["text"];
} }
this.viewer = new Viewer(this,tiddler,field,value);
// Call the viewer to generate the content // Call the viewer to generate the content
return viewer(tiddler,field,value,this); return this.viewer.render();
};
exports.postRenderInDom = function() {
if(this.viewer.postRenderInDom) {
this.viewer.postRenderInDom();
}
}; };
})(); })();

19
core/modules/macros/view/viewers/date.js
View File

@ -12,15 +12,22 @@ A viewer for viewing tiddler fields as a date
/*global $tw: false */ /*global $tw: false */
"use strict"; "use strict";
function renderValue(tiddler,field,value,viewMacro) { var DateViewer = function(viewMacro,tiddler,field,value) {
var template = viewMacro.params.template || "DD MMM YYYY"; this.viewMacro = viewMacro;
if(value === undefined) { this.tiddler = tiddler;
this.field = field;
this.value = value;
};
DateViewer.prototype.render = function() {
var template = this.viewMacro.params.template || "DD MMM YYYY";
if(this.value === undefined) {
return $tw.Tree.Text(""); return $tw.Tree.Text("");
} else { } else {
return $tw.Tree.Text($tw.utils.formatDateString(value,template)); return $tw.Tree.Text($tw.utils.formatDateString(this.value,template));
} }
} };
exports["date"] = renderValue; exports["date"] = DateViewer;
})(); })();

23
core/modules/macros/view/viewers/link.js
View File

@ -12,21 +12,28 @@ A viewer for viewing tiddler fields as a link
/*global $tw: false */ /*global $tw: false */
"use strict"; "use strict";
function renderValue(tiddler,field,value,viewMacro) { var LinkViewer = function(viewMacro,tiddler,field,value) {
if(value === undefined) { this.viewMacro = viewMacro;
this.tiddler = tiddler;
this.field = field;
this.value = value;
};
LinkViewer.prototype.render = function() {
if(this.value === undefined) {
return $tw.Tree.Text(""); return $tw.Tree.Text("");
} else { } else {
var link = $tw.Tree.Macro("link",{ var link = $tw.Tree.Macro("link",{
srcParams: {to: value}, srcParams: {to: this.value},
content: [$tw.Tree.Text(value)], content: [$tw.Tree.Text(this.value)],
isBlock: viewMacro.isBlock, isBlock: this.viewMacro.isBlock,
wiki: viewMacro.wiki wiki: this.viewMacro.wiki
}); });
link.execute(viewMacro.parents,viewMacro.tiddlerTitle); link.execute(this.viewMacro.parents,this.viewMacro.tiddlerTitle);
return link; return link;
} }
} }
exports["link"] = renderValue; exports["link"] = LinkViewer;
})(); })();

60
core/modules/macros/view/viewers/relativedate.js
View File

@ -12,16 +12,62 @@ A viewer for viewing tiddler fields as a relative date
/*global $tw: false */ /*global $tw: false */
"use strict"; "use strict";
function renderValue(tiddler,field,value,viewMacro) { var RelativeDateViewer = function(viewMacro,tiddler,field,value) {
if(value === undefined) { this.viewMacro = viewMacro;
this.tiddler = tiddler;
this.field = field;
this.value = value;
};
RelativeDateViewer.prototype.render = function() {
if(this.value === undefined) {
return $tw.Tree.Text(""); return $tw.Tree.Text("");
} else { } else {
return $tw.Tree.Text( this.relativeDate = $tw.utils.getRelativeDate((new Date()) - this.value);
$tw.utils.getRelativeDate((new Date()) - value).description return $tw.Tree.Element(this.viewMacro.isBlock ? "div" : "span",{},[
); $tw.Tree.Text(
this.relativeDate.description
)
]);
} }
} };
exports["relativedate"] = renderValue; /*
Trigger the timer when the relative date is put into the DOM
*/
RelativeDateViewer.prototype.postRenderInDom = function() {
if(this.relativeDate) {
this.setTimer();
}
};
/*
Trigger the timer for the next update of the relative date
*/
RelativeDateViewer.prototype.setTimer = function() {
var self = this;
if(this.relativeDate.updatePeriod < 24 * 60 * 60 * 1000) {
window.setTimeout(function() {
// Only call the update function if the dom node is still in the document
if($tw.utils.domContains(document,self.viewMacro.child.domNode)) {
self.update.call(self);
}
},this.relativeDate.updatePeriod);
}
};
/*
Update the relative date display, and trigger the timer for the next update
*/
RelativeDateViewer.prototype.update = function() {
while(this.viewMacro.child.domNode.hasChildNodes()) {
this.viewMacro.child.domNode.removeChild(this.viewMacro.child.domNode.firstChild);
}
this.relativeDate = $tw.utils.getRelativeDate((new Date()) - this.value);
this.viewMacro.child.domNode.appendChild(document.createTextNode(this.relativeDate.description));
this.setTimer();
};
exports["relativedate"] = RelativeDateViewer;
})(); })();

19
core/modules/macros/view/viewers/text.js
View File

@ -12,19 +12,26 @@ A viewer for viewing tiddler fields as plain text
/*global $tw: false */ /*global $tw: false */
"use strict"; "use strict";
function renderValue(tiddler,field,value,viewMacro) { var TextViewer = function(viewMacro,tiddler,field,value) {
this.viewMacro = viewMacro;
this.tiddler = tiddler;
this.field = field;
this.value = value;
};
TextViewer.prototype.render = function() {
// Get the value as a string // Get the value as a string
if(field !== "text" && tiddler) { if(this.field !== "text" && this.tiddler) {
value = tiddler.getFieldString(field); this.value = this.tiddler.getFieldString(this.field);
} }
// Return the text // Return the text
if(value === undefined || value === null) { if(this.value === undefined || this.value === null) {
return $tw.Tree.Text(""); return $tw.Tree.Text("");
} else { } else {
return $tw.Tree.Text(value); return $tw.Tree.Text(this.value);
} }
} }
exports["text"] = renderValue; exports["text"] = TextViewer;
})(); })();

19
core/modules/macros/view/viewers/transclude.js
View File

@ -12,20 +12,27 @@ A viewer that transcludes the tiddler whose title is specified in the viewed fie
/*global $tw: false */ /*global $tw: false */
"use strict"; "use strict";
function renderValue(tiddler,field,value,viewMacro) { var TranscludeViewer = function(viewMacro,tiddler,field,value) {
if(tiddler && viewMacro.params.field && (viewMacro.params.field in tiddler.fields)) { this.viewMacro = viewMacro;
var children = viewMacro.wiki.parseTiddler(tiddler.fields[viewMacro.params.field]).tree, this.tiddler = tiddler;
this.field = field;
this.value = value;
};
TranscludeViewer.prototype.render = function() {
if(this.tiddler && this.viewMacro.params.field && (this.viewMacro.params.field in this.tiddler.fields)) {
var children = this.viewMacro.wiki.parseTiddler(this.tiddler.fields[this.viewMacro.params.field]).tree,
childrenClone = [],t; childrenClone = [],t;
for(t=0; t<children.length; t++) { for(t=0; t<children.length; t++) {
childrenClone.push(children[t].clone()); childrenClone.push(children[t].clone());
} }
for(t=0; t<childrenClone.length; t++) { for(t=0; t<childrenClone.length; t++) {
childrenClone[t].execute(viewMacro.parents,viewMacro.tiddlerTitle); childrenClone[t].execute(this.viewMacro.parents,this.viewMacro.tiddlerTitle);
} }
return $tw.Tree.Element(viewMacro.isBlock ? "div" : "span",{},childrenClone); return $tw.Tree.Element(this.viewMacro.isBlock ? "div" : "span",{},childrenClone);
} }
} }
exports["transclude"] = renderValue; exports["transclude"] = TranscludeViewer;
})(); })();

27
core/modules/macros/view/viewers/wikified.js
View File

@ -12,31 +12,38 @@ A viewer for viewing tiddler fields as wikified text
/*global $tw: false */ /*global $tw: false */
"use strict"; "use strict";
function renderValue(tiddler,field,value,viewMacro) { var WikifiedViewer = function(viewMacro,tiddler,field,value) {
this.viewMacro = viewMacro;
this.tiddler = tiddler;
this.field = field;
this.value = value;
};
WikifiedViewer.prototype.render = function() {
// Check for recursion // Check for recursion
var parents = viewMacro.parents, var parents = this.viewMacro.parents,
children,t,childrenClone = []; children,t,childrenClone = [];
if(tiddler && viewMacro.params.field === "text") { if(this.tiddler && this.viewMacro.params.field === "text") {
if(parents.indexOf(tiddler.fields.title) !== -1) { if(parents.indexOf(this.tiddler.fields.title) !== -1) {
children = [$tw.Tree.errorNode("Tiddler recursion error in <<view>> macro")]; children = [$tw.Tree.errorNode("Tiddler recursion error in <<view>> macro")];
} else { } else {
children = viewMacro.wiki.parseTiddler(tiddler.fields.title).tree; children = this.viewMacro.wiki.parseTiddler(this.tiddler.fields.title).tree;
} }
parents = parents.slice(0); parents = parents.slice(0);
parents.push(tiddler.fields.title); parents.push(this.tiddler.fields.title);
} else { } else {
children = viewMacro.wiki.parseText("text/x-tiddlywiki",value).tree; children = this.viewMacro.wiki.parseText("text/x-tiddlywiki",value).tree;
} }
// Clone and execute the parsed wikitext // Clone and execute the parsed wikitext
for(t=0; t<children.length; t++) { for(t=0; t<children.length; t++) {
childrenClone.push(children[t].clone()); childrenClone.push(children[t].clone());
} }
for(t=0; t<childrenClone.length; t++) { for(t=0; t<childrenClone.length; t++) {
childrenClone[t].execute(parents,viewMacro.tiddlerTitle); childrenClone[t].execute(parents,this.viewMacro.tiddlerTitle);
} }
return $tw.Tree.Element(viewMacro.isBlock ? "div" : "span",{},childrenClone); return $tw.Tree.Element(this.viewMacro.isBlock ? "div" : "span",{},childrenClone);
} }
exports["wikified"] = renderValue; exports["wikified"] = WikifiedViewer;
})(); })();