mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-06-25 23:03:15 +00:00
Docs update
Tearing up the recent changes tab...
This commit is contained in:
Jeremy Ruston
parent
d0dff80d6d
commit
133069e0d0
|
|
@ -1,17 +0,0 @@
|
|||
modified: 201308021022
|
||||
title: Demos
|
||||
tags: introduction
|
||||
|
||||
Here are a few features of TiddlyWiki that you can explore:
|
||||
|
||||
* Invoke a sample: <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">wizard</$button> or <$button message="tw-notify" param="SampleNotification" class="btn btn-inverse">notification</$button>
|
||||
* Save this wiki as a static HTML file: <$button message="tw-save-wiki" param="$:/core/templates/static.template.html" class="btn">Save Static</$button>
|
||||
* Browse the list of AllTiddlers or the SystemTiddlers
|
||||
* Examine the example [[bitmap images|Motovun Jack.jpg]] and [[SVG images|Motovun Jack.svg]]
|
||||
* Check out the TaskManagementExample
|
||||
* Run the TiddlyWiki5 [[test suite|TestingMechanism]] from http://five.tiddlywiki.com/test.html
|
||||
* Explore the [[D3.js visualisation plugin|http://five.tiddlywiki.com/d3demo.html]]
|
||||
|
||||
Learn more about using TiddlyWiki5:
|
||||
|
||||
{{{ [tag[howto]sort[title]] }}}
|
||||
|
|
@ -1,76 +1,27 @@
|
|||
created: 201308251537
|
||||
creator: JeremyRuston
|
||||
modified: 201308251539
|
||||
modifier: JeremyRuston
|
||||
tags: docs introduction dev
|
||||
title: DeveloperDocs
|
||||
modified: 201304251644
|
||||
|
||||
This is the developer documentation hub for TiddlyWiki.
|
||||
|
||||
! Developer Cookbooks
|
||||
|
||||
* [[Using TiddlyWiki for GitHub Pages project documentation]]
|
||||
* [[Using TiddlyWiki as a component in node.js applications]]
|
||||
* [[Constructing TiddlyWiki documents in other applications]]
|
||||
<$list filter="[tag[dev]tag[howto]sort[title]]" type="ul"/>
|
||||
|
||||
! Internal Objects and Mechanisms
|
||||
|
||||
Internally, TiddlyWiki is built on a number of key objects and mechanisms:
|
||||
{{mechanism}}
|
||||
|
||||
* TiddlerObject
|
||||
* WikiObject
|
||||
* BootMechanism
|
||||
* PluginMechanism
|
||||
* ParsingMechanism
|
||||
* RenderingMechanism
|
||||
* DependencyMechanism
|
||||
* RefreshMechanism
|
||||
* MacroMechanism
|
||||
* StoryMechanism
|
||||
* EditingMechanism
|
||||
* SavingMechanism
|
||||
* SyncMechanism
|
||||
* CommandMechanism
|
||||
* ConfigMechanism
|
||||
* EncryptionMechanism
|
||||
* TestingMechanism
|
||||
|
||||
! Plugin Module Types
|
||||
|
||||
TiddlyWiki is built on a [[tiny microkernel|BootMechanism]] with all functionality provided as various types of plugin module:
|
||||
|
||||
* CommandModules
|
||||
* ConfigModules
|
||||
* EditorModules
|
||||
* GlobalModules
|
||||
* LibraryModules
|
||||
* MacroModules
|
||||
* ModuleModules
|
||||
* ParserModules
|
||||
* SaverModules
|
||||
* StartupModules
|
||||
* StoryViewModules
|
||||
* SyncerModules
|
||||
* TiddlerDeserializerModules
|
||||
* TiddlerFieldModules
|
||||
* TiddlerMethodModules
|
||||
* TreeNodeModules
|
||||
* TreeUtilsModules
|
||||
* UtilsModules
|
||||
* WikiMethodModules
|
||||
* WikiTextRuleModules
|
||||
|
||||
! Parsers
|
||||
|
||||
TiddlyWiki processes [[ContentTypes|ContentType]] such as WikiText using these parsers:
|
||||
|
||||
* WikiTextParser
|
||||
* JsonParser
|
||||
* ImageParser
|
||||
* PlainTextParser
|
||||
* JavaScriptParser
|
||||
<$list filter="[tag[mechanism]sort[title]]" type="ul"/>
|
||||
|
||||
! Deserializers
|
||||
|
||||
|
||||
Deserializers are modules that read tiddlers from different text formats:
|
||||
|
||||
* RecipeFiles
|
||||
* TiddlerFiles
|
||||
* TiddlyWikiFiles
|
||||
{{deserializers}}
|
||||
|
||||
<$list filter="[tag[deserializers]sort[title]]" type="ul"/>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
created: 201308241418
|
||||
creator: JeremyRuston
|
||||
modified: 201308241531
|
||||
modified: 201308251303
|
||||
modifier: JeremyRuston
|
||||
tags: docs introduction
|
||||
title: Docs
|
||||
|
|
@ -55,10 +55,15 @@ Widgets give WikiText dynamic functionality:
|
|||
|
||||
<$list filter="[tag[command]sort[title]]" type="ul"/>
|
||||
|
||||
! Tips
|
||||
|
||||
{{tips}}
|
||||
|
||||
<$list filter="[tag[tips]sort[title]]" type="ul"/>
|
||||
|
||||
! Miscellaneous
|
||||
|
||||
* ReportingBugs
|
||||
* JeremyRuston (aka [[Jermolene]])
|
||||
* FederatialLimited
|
||||
* [[History]]
|
||||
* [[Acknowledgements]]
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
created: 201308221702
|
||||
creator: JeremyRuston
|
||||
modified: 201308231811
|
||||
modified: 201308252014
|
||||
modifier: JeremyRuston
|
||||
tags: introduction
|
||||
title: HelloThere
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook [[first released in 2004|History]]. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful [[node.js application|node.js]].
|
||||
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook first released in 2004. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful [[node.js application|node.js]].
|
||||
|
||||
TiddlyWiki5 is currently in alpha, meaning it is working but incomplete. It is a great time to get involved and support its [[future development|RoadMap]]:
|
||||
|
||||
|
|
@ -14,4 +14,5 @@ TiddlyWiki5 is currently in alpha, meaning it is working but incomplete. It is a
|
|||
* Join the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]]
|
||||
* Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]]
|
||||
* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news
|
||||
* Learn how to [[help the TiddlyWiki project and community|HelpingTiddlyWiki]]
|
||||
|
||||
//TiddlyWiki is a free, open source project that depends on [[your love and support|HelpingTiddlyWiki]] for its survival//
|
||||
|
|
|
|||
|
|
@ -1,4 +1,8 @@
|
|||
modified: 201305201828
|
||||
created: 201308251605
|
||||
creator: JeremyRuston
|
||||
modified: 201308251605
|
||||
modifier: JeremyRuston
|
||||
tags: docs community
|
||||
title: HelpingTiddlyWiki
|
||||
|
||||
If you find TiddlyWiki useful, there are lots of ways you can help assure its future and make it better.
|
||||
|
|
@ -20,7 +24,7 @@ There's lively discussion about TiddlyWiki in the Google Groups:
|
|||
* The main TiddlyWiki group: http://groups.google.com/group/TiddlyWiki
|
||||
* The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev
|
||||
|
||||
! 4. Improve the Documentation and Code
|
||||
! 4. Improve the documentation and code
|
||||
|
||||
The main TiddlyWiki documentation and code lives on GitHub, and welcomes [[contributions||Contributing]]:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,32 +0,0 @@
|
|||
title: History
|
||||
modified: 201304262046
|
||||
|
||||
! Origins of TiddlyWiki
|
||||
|
||||
I was introduced to [[Ward Cunningham's original wiki|http://c2.com/cgi/wiki]] in 1997 and was stunned that something so powerful could fit into just 700 lines of Perl, and fascinated by the radical reimagining of security and permissions. Like many other developers, I took every opportunity I could to try out various wikis, and to explore their use at work.
|
||||
|
||||
The allure of the wiki for me was the feeling that this might be a paradigm that could eventually topple the prevailing hegemony of print-oriented documents and emails.
|
||||
|
||||
After watching people use wikis for a few years, I noticed that power users made extensive use of the ability to open multiple wiki pages at once in several browser tabs, making it easier for them to compare and review pages, to copy text between them and to act as a sort of queue of pages yet to be read.
|
||||
|
||||
I felt that this ability to manipulate multiple pages at once was central to the ability to refactor a wiki, and it is clear that a wiki that is lovingly refactored tends to be more useful. And yet, standard wiki user interfaces have always been designed exclusively for the presentation and manipulation of single pages at once.
|
||||
|
||||
All of these thoughts came together when I saw GMail in April 2004, which used AJAX cleverly to blend individual emails into threaded conversations.
|
||||
|
||||
I started experimenting with HTML and JavaScript to explore the idea further. I'd had virtually no experience of either, just having put together some static pages and simple ASP sites in previous lives. Getting my head around these client-side technologies was painful; like everyone else, I was horrified to discover how appalling were the incompatibilities and inconsistencies of web programming (this was long before niceties like jQuery).
|
||||
|
||||
! Launch of TiddlyWiki
|
||||
|
||||
So, in September 2004 I released a primitive [[first version of TiddlyWiki|http://tiddlywiki.com/firstversion.html]]. It was the smallest possible thing that demonstrated the idea that I had: it was a simple, self-contained static 48KB HTML file sitting on a dusty old Sun server in my friend Steph's attic.
|
||||
|
||||
The downside of writing the first version of TiddlyWiki in this way was that it made it completely impractical to use for editing - when you click 'save changes' it just pops up a window showing the data that would be saved if it were possible for an HTML page to write to the file system.
|
||||
|
||||
! Growth of TiddlyWiki
|
||||
|
||||
! BT Acquisition
|
||||
|
||||
! Osmosoft and TiddlySpace
|
||||
|
||||
! Leaving BT
|
||||
|
||||
//To be continued...//
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
tags: docs introduction
|
||||
modifier: JeremyRuston
|
||||
title: Improvements
|
||||
modified: 201304011801
|
||||
|
||||
TiddlyWiki5 is a complete rewrite of the original TiddlyWiki. It is now based on an elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules. The new code is much easier to work with, and will hopefully prove an even more fertile ground for the community of open source developers around TiddlyWiki.
|
||||
|
||||
For end users, the important improvements include:
|
||||
|
||||
* Improved WikiText, with much better generation of HTML, including proper `<p>` tags
|
||||
* Flexible TiddlerFilters that make it easier to work with several tiddlers in a single operation
|
||||
* TiddlyWiki can now be run under [[node.js]] as well as in the browser, allowing it to be used as a personal web server
|
||||
* Tiddlers containing images are now supported just like WikiText tiddlers, including integrated editing of bitmap and SVG images
|
||||
* TiddlyWiki5 can directly build both itself and previous (2.x.x) versions of TiddlyWiki from their constituent separate files, without needing external tools
|
||||
* Easily [[import|ImportTiddlers]] content via drag and drop, copy and paste, or browsing for local files
|
||||
|
||||
The internal changes mean that TiddlyWiki5 is not compatible with previous versions, using different plugins, themes and so on. The changes to the WikiText have been carefully developed to try to maximise backwards compatibility but content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5.
|
||||
|
|
@ -1,4 +1,7 @@
|
|||
modified: 201307022116
|
||||
created: 201308251618
|
||||
creator: JeremyRuston
|
||||
modified: 201308251618
|
||||
modifier: JeremyRuston
|
||||
tags: docs dev
|
||||
title: TiddlyWiki5 Development Environment
|
||||
|
||||
|
|
@ -6,9 +9,7 @@ title: TiddlyWiki5 Development Environment
|
|||
|
||||
! Setting up npm
|
||||
|
||||
[[Installing TiddlyWiki5]] with NPM essentially downloads a
|
||||
|
||||
To use a development copy of the TiddlyWiki5 repository instead of the copy installed by [[NPM]], use this command within the root of the TiddlyWiki5 repo:
|
||||
[[Installing TiddlyWiki5]] with NPM downloads a snapshot release of TiddlyWIki5. To use a development copy of the TiddlyWiki5 repository instead of the copy installed by [[NPM]], use this command within the root of the TiddlyWiki5 repo:
|
||||
|
||||
```
|
||||
npm link
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
created: 201308251457
|
||||
creator: JeremyRuston
|
||||
modified: 201308251457
|
||||
modifier: JeremyRuston
|
||||
tags: introduction
|
||||
title: TiddlyWiki5 Editions
|
||||
modified: 201305141912
|
||||
|
||||
The core TiddlyWiki5 code is packaged into several distinct editions designed for different situations:
|
||||
|
||||
|
|
@ -14,3 +17,7 @@ The core TiddlyWiki5 code is packaged into several distinct editions designed fo
|
|||
** Including [[Building classic TiddlyWiki with TiddlyWiki5]]
|
||||
* [[TiddlyWiki5 in the Sky for TiddlyWeb]] (and TiddlySpace)
|
||||
* [[TiddlyWiki5 in the Sky for Dropbox]]
|
||||
|
||||
Learn more about using TiddlyWiki5:
|
||||
|
||||
{{{ [tag[howto]sort[title]] }}}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
title: TiddlyWikiArchitecture
|
||||
created: 201308251621
|
||||
creator: JeremyRuston
|
||||
modified: 201308251621
|
||||
modifier: JeremyRuston
|
||||
tags: docs internals
|
||||
modified: 201304212156
|
||||
tags: docs dev
|
||||
title: TiddlyWikiArchitecture
|
||||
|
||||
The heart of TiddlyWiki can be seen as an extensible representation transformation engine for text and images. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,8 @@
|
|||
title: ContextTiddler
|
||||
created: 201308251449
|
||||
creator: JeremyRuston
|
||||
modified: 201308251449
|
||||
modifier: JeremyRuston
|
||||
tags: docs concepts
|
||||
title: ContextTiddler
|
||||
|
||||
The ContextTiddler is the current tiddler during WikiText processing. It allows you to write a widget like `<$view field="title" format="link"/>` in TiddlerTemplates without explicitly specifying the tiddler that it applies to.
|
||||
The ContextTiddler is the current tiddler during WikiText processing. A context tiddler is set by the TiddlerWidget. It allows you to write references like `<$view field="title" format="link"/>` in TiddlerTemplates without explicitly specifying the tiddler that it applies to.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
created: 201308221707
|
||||
creator: JeremyRuston
|
||||
modified: 201308221707
|
||||
modified: 201308252013
|
||||
modifier: JeremyRuston
|
||||
tags: docs concepts
|
||||
title: TiddlyWiki
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
title: FederatialLimited
|
||||
created: 201308251549
|
||||
creator: JeremyRuston
|
||||
modified: 201308251604
|
||||
modifier: JeremyRuston
|
||||
tags: definitions
|
||||
title: FederatialLimited
|
||||
|
||||
Federatial Limited is a software consultancy founded by JeremyRuston specializing in understanding the impact of the web on the way that we work together.
|
||||
|
||||
Through human history we have used hierarchies to organize ourselves to undertake big challenges: from raising an army to building a modern global enterprise. Now we see the rise of small, loosely federated groups that use the web to establish agreement and organize action.
|
||||
See http://federatial.com/ and http://twitter.com/federatial for more information.
|
||||
|
|
|
|||
8
editions/tw5.com/tiddlers/definitions/JavaScript.tid
Normal file
8
editions/tw5.com/tiddlers/definitions/JavaScript.tid
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
created: 201308251421
|
||||
creator: JeremyRuston
|
||||
modified: 201308251421
|
||||
modifier: JeremyRuston
|
||||
tags: definitions
|
||||
title: JavaScript
|
||||
|
||||
JavaScript is a computer language originally introduced by browsers as the standard scripting language for the web. It has since been recognised as a powerful language in its own right, and has been adopted widely beyond the browser.
|
||||
|
|
@ -1,10 +1,11 @@
|
|||
title: JeremyRuston
|
||||
created: 201308251625
|
||||
creator: JeremyRuston
|
||||
modified: 201308251625
|
||||
modifier: JeremyRuston
|
||||
tags: definitions
|
||||
title: JeremyRuston
|
||||
|
||||
I've spent my life inventing software products with great user experiences, and building the teams to develop them. I'm the inventor of TiddlyWiki, a popular open source personal organiser that's grown to be the platform for a whole new class of web applications. I lead the community around TiddlyWiki, and am dedicated to building a great product for users all over the world.
|
||||
|
||||
I am available through my company FederatialLimited for consultancy and speaking engagements.
|
||||
I'm the inventor of TiddlyWiki. I am available through my company FederatialLimited for consultancy and speaking engagements.
|
||||
|
||||
You can find me on these services:
|
||||
|
||||
|
|
@ -16,3 +17,4 @@ Further information:
|
|||
|
||||
* An [[interview with me in The Inquirer|http://www.theinquirer.net/inquirer/feature/2105529/bt-software-engineer-tells-telco-source]] by Wendy Grossman
|
||||
* A [[hilarious interview with me|http://www.youtube.com/watch?v=auyIhw8MTmQ]] from British television in 1983
|
||||
* Here's a video of a presentation I did in 2007 called [["How to Start an Open Source Project"|http://vimeo.com/856110]].
|
||||
|
|
|
|||
|
|
@ -1,18 +1,9 @@
|
|||
tags: definitions
|
||||
created: 201308251307
|
||||
creator: JeremyRuston
|
||||
modified: 201308251307
|
||||
modifier: JeremyRuston
|
||||
tags: definitions
|
||||
title: OpenSource
|
||||
modified: 201304021921
|
||||
|
||||
OpenSource is [[defined by Wikipedia|http://en.wikipedia.org/wiki/Open_source]] as //a philosophy, or pragmatic methodology that promotes free redistribution and access to an end product's design and implementation details//.
|
||||
|
||||
For me, OpenSource speaks to a fundamental truth about software: software is unlike anything else we produce in our post-industrial revolution era. Initially, we thought that programming would evolve to be a branch of engineering: a process that was amenable to conventional techniques of mass production, and the traditional business models we have wrapped around the things we make and the things we dig out of the ground.
|
||||
|
||||
As it has turned out, programming isn't like engineering at all. With an endeavour such as bridge building, engineers can reliably build bridges to any required specification, with a full understanding of the practical limitations under which it has to operate. In software, we struggle to manage large scale development. We can't even reliably estimate the complexity of non-trivial programming tasks. Organisations increasingly think of custom software as being a liability, and not the asset that it first appears.
|
||||
|
||||
OpenSource doesn't change the nature of software, but instead incorporates it into the philosophy of its production. The most fundamental insight is that programming is hard, and that the best way to mitigate the problem is to have lots and lots of smart brains working on it. But open source doesn't seek to do that by prescribing a reductionist, hierarchical breakdown of the required tasks that can be allocated to an army of programmers. Instead, OpenSource suggests that our code should be accessible to everyone, to create the widest possible surface area for potential collaborators.
|
||||
|
||||
This leads to an intense, organic, chaotic way of working, but the results can be impressive.
|
||||
|
||||
TiddlyWiki is part of a small band of OpenSource projects like Firefox that don't just target software developers, but provide something that end users can use themselves, without any special programming ability.
|
||||
|
||||
Here's a video of a presentation I did in 2007 called [["How to Start an Open Source Project"|http://vimeo.com/856110]].
|
||||
|
|
|
|||
10
editions/tw5.com/tiddlers/definitions/TiddlyFox.tid
Normal file
10
editions/tw5.com/tiddlers/definitions/TiddlyFox.tid
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
created: 201308251611
|
||||
creator: JeremyRuston
|
||||
modified: 201308251611
|
||||
modifier: JeremyRuston
|
||||
tags: docs definitions
|
||||
title: TiddlyFox
|
||||
|
||||
TiddlyFox is an extension for Firefox that allows standalone TiddlyWiki files to save their changes directly to the file system. TiddlyFox works on both desktop and smartphone versions of Firefox.
|
||||
|
||||
See [[How to use TiddlyWiki5 as a standalone HTML file with TiddlyFox]].
|
||||
|
|
@ -1,6 +1,9 @@
|
|||
title: TiddlerFiles
|
||||
created: 201308251500
|
||||
creator: JeremyRuston
|
||||
modified: 201308251621
|
||||
modifier: JeremyRuston
|
||||
tags: internals
|
||||
tags: deserializers dev
|
||||
title: TiddlerFiles
|
||||
|
||||
Tiddlers can be stored in text files in several different formats. Files containing single tiddlers can also have an auxiliary `.meta` file formatted as a sequence of name:value pairs:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,13 @@
|
|||
title: ImportTiddlers
|
||||
created: 201308251620
|
||||
creator: JeremyRuston
|
||||
modified: 201308251620
|
||||
modifier: JeremyRuston
|
||||
tags: docs features
|
||||
modified: 201304011804
|
||||
title: ImportTiddlers
|
||||
|
||||
You can import content into a TiddlyWiki file in several ways:
|
||||
|
||||
* Use the ''browse'' button to select one or more local files
|
||||
* Use the ''browse'' button (under the ''Tools'' tab in the sidebar, or in the [[ControlPanel|$:/ControlPanel]]) to select one or more local files
|
||||
* Drag and drop files from Windows Explorer or Mac OS X Finder into the TiddlyWiki5 browser window
|
||||
* Paste content directly from the clipboard using the keyboard shortcut (control-V or command-V)
|
||||
** Pasting is currently only supported in GoogleChrome
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
created: 201308251614
|
||||
creator: JeremyRuston
|
||||
modified: 201308251614
|
||||
modifier: JeremyRuston
|
||||
tags: docs howto
|
||||
title: How to use TiddlyWiki5 as a standalone HTML file with AndTidWiki
|
||||
|
||||
The AndTidWiki app for Android devices makes it possible to edit and save changes to TiddlyWiki5, including working offline without a network connection.
|
||||
|
||||
//Note that AndTidWiki is published independently of TiddlyWiki//
|
||||
|
|
@ -1,11 +1,15 @@
|
|||
title: How to build a TiddlyWiki5 from individual tiddlers
|
||||
created: 201308251606
|
||||
creator: JeremyRuston
|
||||
modified: 201308251607
|
||||
modifier: JeremyRuston
|
||||
tags: docs howto
|
||||
title: How to build a TiddlyWiki5 from individual tiddlers
|
||||
|
||||
# Create an empty TiddlyWikiDirectory
|
||||
# Create an empty [[TiddlyWikiFolder|TiddlyWikiFolders]]
|
||||
## Create a new folder in a convenient place (for example `~/MyWiki`)
|
||||
## Create a file called `tiddlywiki.info` containing just a pair of braces: `{}`
|
||||
## Create a subfolder called `tiddlers`
|
||||
##* Alternatively, just copy the `editions/empty` folder from the TiddlyWiki5 repo
|
||||
# Create individual tiddler files in the `~/MyWiki/tiddlers` directory
|
||||
# Create individual TiddlerFiles in the `~/MyWiki/tiddlers` directory
|
||||
# Execute the following command from the TiddlyWiki5 root directory to build a TiddlyWiki5 file from the tiddlers:
|
||||
## `node ./tiddlywiki.js ~/MyWiki --rendertiddler $:/core/templates/tiddlywiki5.template.html index.html text/plain`
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
created: 201308251609
|
||||
creator: JeremyRuston
|
||||
modified: 201308251609
|
||||
modifier: JeremyRuston
|
||||
tags: docs howto
|
||||
title: How to use TiddlyWiki5 as a standalone HTML file with encryption
|
||||
modified: 201304152154
|
||||
|
||||
[[TiddlyWiki5 Standalone Edition]] allows content to be encrypted using the [[Stanford JavaScript Crypto Library]].
|
||||
|
||||
# Scroll to the bottom of the page where you should see the words "This wiki is not encrypted" and a button labelled "Set password"
|
||||
# Click "Set password"
|
||||
# Type a password and click the "Set" button (or use the enter key)
|
||||
# The control panel should now say "This wiki is encrypted" with buttons for changing and clearing the password
|
||||
# Save the wiki using the "Save" button in the left sidebar
|
||||
# Switch to the ''Tools'' tab in the sidebar and look for the words //This wiki is not encrypted// and a button labelled ''Set password''
|
||||
# Click ''Set password''
|
||||
# Type a password and click the ''Set'' button (or use the enter key)
|
||||
# The control panel should now say //This wiki is encrypted// with buttons for changing and clearing the password
|
||||
# Save the wiki using the button in the sidebar
|
||||
# Optionally, open the saved file in a text editor and verify that your data is encrypted
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
modified: 201306251332
|
||||
tags: docs dev
|
||||
created: 201308251501
|
||||
creator: JeremyRuston
|
||||
modified: 201308251501
|
||||
modifier: JeremyRuston
|
||||
tags: docs dev howto
|
||||
title: Using TiddlyWiki for GitHub Pages project documentation
|
||||
|
||||
TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets you maintain a single set of documentation as a [[TiddlyWikiFolder|TiddlyWikiFolders]] containing separate tiddler files under source code control, and then use it to produce `readme.md` files for inclusion in project folders, or HTML files for storage in [[GitHub Pages|http://pages.github.com/]]. Both features are demonstrated by TiddlyWiki5 itself.
|
||||
|
|
|
|||
|
|
@ -1,26 +1,28 @@
|
|||
title: BootMechanism
|
||||
created: 201308251429
|
||||
creator: JeremyRuston
|
||||
modified: 201308251429
|
||||
modifier: JeremyRuston
|
||||
tags: docs mechanism
|
||||
title: BootMechanism
|
||||
|
||||
!Introduction
|
||||
|
||||
TiddlyWiki5 is based on a 1,000 line boot kernel that runs on node.js or in the browser, with all other functionality added via dynamically loaded modules.
|
||||
It its heart, TiddlyWiki5 is a relatively small boot kernel that runs on node.js or in the browser with all other functionality added via dynamically loaded [[modules|Modules]].
|
||||
|
||||
The kernel boots just enough of the TiddlyWiki environment to allow it to load tiddlers and execute JavaScript modules. Plugin modules are written like `node.js` modules.
|
||||
The kernel boots just enough of the TiddlyWiki environment to allow it to load and execute module tiddlers. The module system is compatible with CommonJS and [[node.js]].
|
||||
|
||||
There are many [[different types of module|ModuleType]]: parsers, deserializers, widgets etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the `tags` field, and another that knows how to handle the special behaviour of the `modified` and `created` fields.
|
||||
There are many [[different types of module|ModuleType]]: parsers, deserializers, widgets etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the `tags` field, and another that knows how to handle the special behaviour of the `modified` and `created` fields. Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts parsing rules as individual plugin modules.
|
||||
|
||||
Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts rules as individual plugin modules.
|
||||
|
||||
!Plugins and Modules
|
||||
!Plugins
|
||||
|
||||
In TiddlyWiki5, [[Plugins]] are bundles of tiddlers that are distributed and managed as one; [[Modules]] are JavaScript tiddlers with a module type identifying when and how they should be executed.
|
||||
|
||||
The tiddler [[$:/boot/boot.js]] is a barebones TiddlyWiki kernel that is just sufficient to load the core plugin modules and trigger a startup module to load up the rest of the application.
|
||||
|
||||
The kernel includes:
|
||||
The boot kernel includes:
|
||||
|
||||
* Several short shared utility functions
|
||||
* A handful of methods implementing the plugin module mechanism
|
||||
* A handful of methods implementing the module mechanism
|
||||
* The `$tw.Tiddler` class (and field definition plugins)
|
||||
* The `$tw.Wiki` class (and tiddler deserialization methods)
|
||||
* Code for the browser to load tiddlers from the HTML DOM
|
||||
|
|
|
|||
|
|
@ -1,8 +1,14 @@
|
|||
title: EncryptionMechanism
|
||||
created: 201308251542
|
||||
creator: JeremyRuston
|
||||
modified: 201308251543
|
||||
modifier: JeremyRuston
|
||||
tags: docs mechanism
|
||||
title: EncryptionMechanism
|
||||
|
||||
TiddlyWiki5 allows the entire content of a TiddlyWiki HTML file to be encrypted with the Stanford JavaScript Crypto Library. Opening an encrypted TiddlyWiki in the browser prompts for a password before decrypting and displaying the content.
|
||||
|
||||
For instructions on how to use TiddlyWiki5's encryption features, see [[How to use TiddlyWiki5 as a standalone HTML file with encryption]].
|
||||
|
||||
The EncryptionMechanism is implemented with the following elements:
|
||||
|
||||
* A crypto "password vault" within the BootMechanism that holds the current encryption password
|
||||
|
|
@ -11,4 +17,4 @@ The EncryptionMechanism is implemented with the following elements:
|
|||
* The `<$encrypt>` widget within the main file template that encrypts a filtered list of tiddlers with the currently held password
|
||||
* The [[$:/isEncrypted]] tiddler that contains "yes" or "no" according to whether there is a password in the password vault
|
||||
** The availability of this tiddler allows the RevealWidget to be used to selectively display user interface elements according to whether encryption is in force
|
||||
* The [[$:/snippets/encryptionstatus]] snippet that displays the current encryption status
|
||||
* The [[$:/snippets/encryptionstatus]] snippet displays the current encryption status
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
title: LazyLoading
|
||||
modified: 201308051412
|
||||
created: 201308251625
|
||||
creator: JeremyRuston
|
||||
modified: 201308251626
|
||||
modifier: JeremyRuston
|
||||
tags: dev docs mechanism
|
||||
title: LazyLoadingMechanism
|
||||
|
||||
TiddlyWiki5 currently only implements lazy loading when its running in the browser talking to a TiddlyWeb-compatible server. When it syncs, it first requests a "skinny" version of each tiddler (consisting of all the fields apart from the text field). Subsequently, an attempt to read those skinny tiddlers with `wiki.getTiddler()` returns just the skinny fields, but an attempt to read one using `wiki.getTiddlerText()` will trigger an asynchronous load of the full tiddler text, which in turn triggers a refresh cycle, updating the display to reflect the newly loaded tiddler. Widgets that loop through all tiddlers are fine; it's only if they trigger `wiki.getTiddlerText()` for a tiddler that it will get loaded.
|
||||
|
||||
|
|
@ -1,5 +1,9 @@
|
|||
created: 201308251621
|
||||
creator: JeremyRuston
|
||||
modified: 201308251621
|
||||
modifier: JeremyRuston
|
||||
tags: dev docs
|
||||
title: SyncAdaptorModules
|
||||
tags: internals
|
||||
|
||||
! Introduction
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
created: 201308251449
|
||||
creator: JeremyRuston
|
||||
modified: 201308251449
|
||||
modifier: JeremyRuston
|
||||
title: ContributingTemplate
|
||||
|
||||
\define tw-wikilink-template() http://five.tiddlywiki.com/static/$uri_encoded$.html
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
title: Compose ballad
|
||||
created: 201308251430
|
||||
creator: JeremyRuston
|
||||
modified: 201308251430
|
||||
modifier: JeremyRuston
|
||||
tags: task
|
||||
title: Compose ballad
|
||||
|
||||
//This is a sample task for the TaskManagementExample//
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
title: Get the Ring
|
||||
created: 201308251431
|
||||
creator: JeremyRuston
|
||||
modified: 201308251431
|
||||
modifier: JeremyRuston
|
||||
tags: task
|
||||
title: Get the Ring
|
||||
|
||||
//This is a sample task for the TaskManagementExample//
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
title: Go to Mordor
|
||||
created: 201308251431
|
||||
creator: JeremyRuston
|
||||
modified: 201308251431
|
||||
modifier: JeremyRuston
|
||||
tags: task done
|
||||
title: Go to Mordor
|
||||
|
||||
//This is a sample task for the TaskManagementExample//
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
title: Kill the Dragon
|
||||
created: 201308251431
|
||||
creator: JeremyRuston
|
||||
modified: 201308251431
|
||||
modifier: JeremyRuston
|
||||
tags: task
|
||||
title: Kill the Dragon
|
||||
|
||||
//This is a sample task for the TaskManagementExample//
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
title: Make the beds
|
||||
created: 201308251431
|
||||
creator: JeremyRuston
|
||||
modified: 201308251431
|
||||
modifier: JeremyRuston
|
||||
tags: task
|
||||
title: Make the beds
|
||||
|
||||
//This is a sample task for the TaskManagementExample//
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
title: MainMenu
|
||||
modified: 201304021952
|
||||
|
||||
! TiddlyWiki
|
||||
|
||||
{{Motovun Jack.jpg}}
|
||||
|
||||
a reusable non-linear personal web notebook
|
||||
|
||||
//TiddlyWiki is a free, open source project that depends on [[your love and support|HelpingTiddlyWiki]] for its survival//
|
||||
|
||||
* HelloThere
|
||||
* [[Introduction]]
|
||||
* [[Docs]]
|
||||
* [[Acknowledgements]]
|
||||
|
|
@ -1,4 +1,8 @@
|
|||
title: concepts
|
||||
modified: 201306041416
|
||||
color: #FF8383
|
||||
created: 201308251447
|
||||
creator: JeremyRuston
|
||||
modified: 201308251447
|
||||
modifier: JeremyRuston
|
||||
title: concepts
|
||||
|
||||
These are the concepts underlying TiddlyWiki. Understanding how these ideas fit together is the key to getting the most from TiddlyWiki.
|
||||
|
|
@ -1,4 +1,8 @@
|
|||
color: #7bb95d
|
||||
modified: 201306131058
|
||||
created: 201308251451
|
||||
creator: JeremyRuston
|
||||
modified: 201308251451
|
||||
modifier: JeremyRuston
|
||||
title: definitions
|
||||
|
||||
These are definitions of technical words and phrases used in this documentation. (As distinct from the [[concepts]] that make up TiddlyWiki itself).
|
||||
|
|
|
|||
|
|
@ -1,4 +1,8 @@
|
|||
color: #b893c3
|
||||
modified: 201306131058
|
||||
created: 201308251452
|
||||
creator: JeremyRuston
|
||||
modified: 201308251452
|
||||
modifier: JeremyRuston
|
||||
title: demo
|
||||
|
||||
These are sample tiddlers provided as part of TiddlyWiki's documentation.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,8 @@
|
|||
color: #e37a61
|
||||
modified: 201306131058
|
||||
created: 201308251459
|
||||
creator: JeremyRuston
|
||||
modified: 201308251500
|
||||
modifier: JeremyRuston
|
||||
title: dev
|
||||
|
||||
See DeveloperDocs.
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
title: docs
|
||||
color: #8080FF
|
||||
created: 201308251539
|
||||
creator: JeremyRuston
|
||||
modified: 201308251539
|
||||
modifier: JeremyRuston
|
||||
title: docs
|
||||
|
||||
See [[Docs]] for the main TiddlyWiki documentation hub.
|
||||
7
editions/tw5.com/tiddlers/tags/faq.tid
Normal file
7
editions/tw5.com/tiddlers/tags/faq.tid
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
color: #cf7d89
|
||||
created: 201308251622
|
||||
creator: JeremyRuston
|
||||
modified: 201308251622
|
||||
modifier: JeremyRuston
|
||||
title: faq
|
||||
|
||||
|
|
@ -1,4 +1,9 @@
|
|||
title: introduction
|
||||
modified: 201306041707
|
||||
color: plum
|
||||
created: 201308251622
|
||||
creator: JeremyRuston
|
||||
list: HelloThere Acknowledgements Improvements Demos [[TiddlyWiki5 Editions]] Docs DeveloperDocs
|
||||
modified: 201308251622
|
||||
modifier: JeremyRuston
|
||||
title: introduction
|
||||
|
||||
Introductory documentation.
|
||||
|
|
|
|||
7
editions/tw5.com/tiddlers/tags/mechanism.tid
Normal file
7
editions/tw5.com/tiddlers/tags/mechanism.tid
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
created: 201308251538
|
||||
creator: JeremyRuston
|
||||
modified: 201308251538
|
||||
modifier: JeremyRuston
|
||||
title: mechanism
|
||||
|
||||
These are the internal mechanisms that fit together to make up TiddlyWiki.
|
||||
7
editions/tw5.com/tiddlers/tags/tips.tid
Normal file
7
editions/tw5.com/tiddlers/tags/tips.tid
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
created: 201308251034
|
||||
creator: JeremyRuston
|
||||
modified: 201308251034
|
||||
modifier: JeremyRuston
|
||||
title: tips
|
||||
|
||||
Hints and tips to help you get the most from TiddlyWiki.
|
||||
|
|
@ -1,6 +1,9 @@
|
|||
created: 201308251604
|
||||
creator: JeremyRuston
|
||||
modified: 201308251604
|
||||
modifier: JeremyRuston
|
||||
tags: docs tips
|
||||
title: GoogleChromeTips
|
||||
modified: 201304050954
|
||||
tags: docs
|
||||
|
||||
Some suggestions for streamlining [[using TiddlyWiki as a single file|How to use TiddlyWiki5 as a standalone HTML file]] with GoogleChrome.
|
||||
|
||||
19
editions/tw5.com/tiddlers/tips/TitlesPolicy.tid
Normal file
19
editions/tw5.com/tiddlers/tips/TitlesPolicy.tid
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
created: 201308251033
|
||||
creator: JeremyRuston
|
||||
modified: 201308251418
|
||||
modifier: JeremyRuston
|
||||
tags: docs tips
|
||||
title: TitlesPolicy
|
||||
|
||||
As the structures within your TiddlyWiki documents get more complex it can be hard to keep the titles of tiddlers consistent. For example, should terms be defined in the plural or the singular? Camel case or separate words?
|
||||
|
||||
Recording a formal titling policy can help to reduce confusion. For example, the titling policies for this wiki are:
|
||||
|
||||
* Use lowercase single words for tags
|
||||
** e.g. [[task]], [[demo]]
|
||||
* Use CamelCase for definitions and concepts
|
||||
** e.g. TiddlerFields, DeveloperDocs
|
||||
* Use separate words for titles that are full phrases or sentences, such as FAQs, howtos or tasks
|
||||
** e.g. [[How to build a TiddlyWiki5 from individual tiddlers]]
|
||||
* Where TiddlyWiki or TiddlyWiki5 is used as a qualifier at the start of the title, always use separate words
|
||||
** e.g. [[TiddlyWiki5 Editions]]
|
||||
12
readme.md
12
readme.md
|
|
@ -5,8 +5,7 @@ TiddlyWiki5</a></h1><div class='tw-tiddler'>
|
|||
<p>
|
||||
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
|
||||
TiddlyWiki5</a>, a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
|
||||
TiddlyWiki</a>, the non-linear personal web notebook <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/History.html'>
|
||||
first released in 2004</a>. It is a complete interactive wiki in <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/JavaScript.html'>
|
||||
TiddlyWiki</a>, the non-linear personal web notebook first released in 2004. It is a complete interactive wiki in <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/JavaScript.html'>
|
||||
JavaScript</a> that can be run from a single HTML file in the browser or as a powerful <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/node.js.html'>
|
||||
node.js application</a>.</p><p>
|
||||
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
|
||||
|
|
@ -20,9 +19,12 @@ the TiddlyWikiDev Google Group</a></li><li>
|
|||
Get involved in the <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>
|
||||
development on GitHub</a></li><li>
|
||||
Follow <a class='tw-tiddlylink tw-tiddlylink-external' href='http://twitter.com/#!/TiddlyWiki'>
|
||||
@TiddlyWiki on Twitter</a> for the latest news</li><li>
|
||||
Learn how to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/HelpingTiddlyWiki.html'>
|
||||
help the TiddlyWiki project and community</a></li></ul></div></div><h1 class=''>
|
||||
@TiddlyWiki on Twitter</a> for the latest news</li></ul><p>
|
||||
<em>
|
||||
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
|
||||
TiddlyWiki</a> is a free, open source project that depends on <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/HelpingTiddlyWiki.html'>
|
||||
your love and support</a> for its survival</em>
|
||||
</p></div></div><h1 class=''>
|
||||
Getting started with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
|
||||
TiddlyWiki</a> under node.js</h1><div class='tw-tiddler'>
|
||||
<div class='tw-transclude'>
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user