mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-09-12 07:46:06 +00:00
Code Issues Releases Wiki Activity

Move the docs to the right place

Browse Source
This commit is contained in:
Jermolene
2013-12-03 09:17:59 +00:00
parent ecdfce1985
commit 9dcbdb5297
2 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
editions/clientserver/tiddlers/TiddlyWiki5 for Developers.tid
View File

@@ -1,26 +0,0 @@
created: 20131203074550710
creator: JeremyRuston
modified: 20131203075203153
modifier: JeremyRuston
tags: introduction dev
title: TiddlyWiki5 for Developers
type: text/vnd.tiddlywiki
TiddlyWiki5 is published as OpenSource which means that anyone can read the code and contribute to its development. It's a big, complex piece of software and can be overwhelming to newcomers.
! Resources
! The one thing you need to know
TiddlyWiki5's architecture is very different from an HTML page written using jQuery. This section concisely explains what TiddlyWiki5 does differently. It may not make much sense on the first reading.
The key to understanding how TW5 works internally is to see that the RefreshMechanism requires that any region of the DOM can be regenerated at any time. This means that the entire state of the user interface must reside in the tiddler store, and not in the DOM.
It also determines the standard UI flow:
# An event handler on a widget is triggered
# The event handler can manipulate the DOM nodes directly created by the widget, and/or modify the state of the tiddler store
# The core then issues a store change event which triggers the refresh cycle
# Each widget in the tree then gets a chance to refresh itself to reflect the changes in the store if they need to
From a technical perspective, TiddlyWiki5 is a fairly classic MVC architecture, with strict separation of concerns. The model is the tiddler store, the view is a rendering tree (such as the one created from $:/core/ui/PageMacros in startup.js), and the controller is the TW5 core code itself.

25
editions/clientserver/tiddlers/Upgrading.tid
View File

@@ -1,25 +0,0 @@
created: 20131202102427114
creator: JeremyRuston
modified: 20131202102732309
modifier: JeremyRuston
tags: howto
title: Upgrading
type: text/vnd.tiddlywiki
There are several methods for upgrading an existing TiddlyWiki5 document to a new release.
! Online updating
Note that none of your personal data leaves your browser with this process.
# Visit http://five.tiddlywiki.com/empty.html
# Drag your old TiddlyWiki5 HTML file into the browser window
#* Your tiddlers should be imported
# Save changes to save the new version
//Currently you'll have to manually update any plugins you're using that are not included in empty.html//
! Offline updating
You can also download http://five.tiddlywiki.com/empty.html locally and perform the same drag-and-drop procedure to upgrade your files.