Docs updates

This commit is contained in:
Jeremy Ruston 2013-11-01 11:18:37 +00:00
parent fbc1f5e5f6
commit 1b991f2a74
7 changed files with 33 additions and 12 deletions

View File

@ -0,0 +1,7 @@
created: 201311010911
creator: JeremyRuston
modified: 201311010911
modifier: JeremyRuston
title: BT
BT (née British Telecom) is the UK's largest telecommunications company. In 2007, [[Osmosoft]] was acquired by BT. JeremyRuston subsequently left BT in 2011.

View File

@ -0,0 +1,13 @@
created: 201311010913
creator: JeremyRuston
modified: 201311010924
modifier: JeremyRuston
title: Osmosoft
Founded in 2005 by JeremyRuston, Osmosoft was originally a consultancy for software services around TiddlyWiki. Notable engagements included working with Socialtext on [[Socialtext Unplugged|https://www.socialtext.net/open/socialtext_unplugged]].
In 2007, Osmosoft was acquired by [[BT]] and became the champions for open source within the enterprise. As part of BT, Osmosoft has worked on a diverse range of projects within BT and for BT's customers.
See http://osmosoft.com/

View File

@ -1,6 +1,9 @@
modified: 201309210933
title: Contributing
created: 201311011114
creator: JeremyRuston
modified: 201311011114
modifier: JeremyRuston
tags: introduction
title: Contributing
TiddlyWiki5 welcomes contributions to its code and documentation via [[GitHub|https://github.com/Jermolene/TiddlyWiki5]]. Please take a moment to read these notes to help make the process as smooth as possible.
@ -21,7 +24,7 @@ There's a lot of good material on the web about bug reports:
!! Pull Requests
Like other OpenSource projects, TiddlyWiki5 needs a signed ContributorLicenseAgreement from individual contributors before contributions of code can be accepted. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors before contributions of code can be accepted. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
* For individuals use: [[CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]]
* For entities use: [[CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]]

View File

@ -1,6 +1,6 @@
created: 201308270759
creator: JeremyRuston
modified: 201308270759
modified: 201311011115
modifier: JeremyRuston
tags: concepts
title: TextReference
@ -20,5 +20,3 @@ Text references can be used in several places:
* As IndirectAttributes of an element or widget (eg, `<$widget attrib={{Title!!description}}/>`)
* As the operand of a shortcut transclusion (eg, `{{MyTiddler!!title}}`)
* As the `state` attribute of the RevealWidget and the LinkCatcherWidget
//There are probably other places where a title is being used but it would be more flexible to support arbitrary text references//

View File

@ -1,13 +1,13 @@
created: 201308251429
creator: JeremyRuston
modified: 201308251429
modified: 201310312218
modifier: JeremyRuston
tags: mechanism
title: BootMechanism
!Introduction
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]].
At its heart, TiddlyWiki5 is a relatively small boot kernel that runs either under 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 and execute module tiddlers. The module system is compatible with CommonJS and [[node.js]].

View File

@ -1,6 +1,6 @@
created: 201308251542
creator: JeremyRuston
modified: 201310311543
modified: 201311010906
modifier: JeremyRuston
tags: mechanism
title: EncryptionMechanism
@ -13,7 +13,7 @@ The EncryptionMechanism is implemented with the following elements:
* A PasswordVault within the BootMechanism that holds the current encryption password
* The ability of the BootMechanism to read a block of encrypted tiddlers from the TiddlyWiki file, to prompt the user for a password, and to decrypt the tiddlers
* Handlers for the messages SetPasswordMessage and ClearPasswordMessage that handle the user interface for password changes
* Handlers for the messages [[WidgetMessage: tw-set-password]] and [[WidgetMessage: tw-clear-password]] that handle the user interface for password changes
* The EncryptWidget 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

View File

@ -1,6 +1,6 @@
created: 201308232038
creator: JeremyRuston
modified: 201309232017
modified: 201311011116
modifier: JeremyRuston
tags: planning
title: RoadMap
@ -30,7 +30,7 @@ The following additional features are planned or under consideration for impleme
* Proper use of ARIA roles
* Simpler upgrading to new core versions
* Import wizard allowing individual tiddlers to be selected for import
* Switching to more MarkDown-like syntax for basic formatting such as headings and lists
* Switching to more [[MarkDown-like]] syntax for basic formatting such as headings and lists
* `[img[url]]` for remote image embedding, and `[ext[url]]` for explicit external links
* Further WikiText features including block quotes
* Facebook, Twitter, G+ and LinkedIn widgets