1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-25 23:03:15 +00:00

Docs updates

This commit is contained in:
Jermolene 2014-02-06 22:21:03 +00:00
parent dbd63e6fe7
commit 68bcfe1c8c
6 changed files with 69 additions and 16 deletions

View File

@ -18,10 +18,17 @@ These are changes that might affect users upgrading from previous betas.
!! Improvements
* Added [[automatic saving|AutoSave]] on editing a tiddler
* Added a warning when attempting to close the window with unsaved changes
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/e3a05625b2368b2167a2a1b30aa82369e96a7538]] experimental KeyboardWidget, including support for ''ctrl-enter'' (or ''cmd-enter'') to finish editing a tiddler
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/a01bbd4b9c7ca284141078340c8f568b1e0561a2]] [[automatic saving|AutoSave]] on editing a tiddler and a warning when attempting to close the window with unsaved changes
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/e6fa9b8a859867c147fb289859169b204dea003e]] number of tags to control panel ''Basics'' tab
* [[Added|https://github.com/Jermolene/TiddlyWiki5/commit/fa5938221552846c255eb50004996528a09534a9]] support for LazyLoading of images
!! Bug Fixes
*
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/8e8e31fb9f5ed8f2e5deff0271d434dbe91f503c]] problem with tag pills not working inside table cells
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/6d3d3322e5c676e63d1f64dce89ce86e58dcd715]] problem in client server configuration with ''%'' in tiddler titles
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/7eafd51a7dd89d2174be3dec97033dc0bb206677]] problem with not using placeholder text when editing missing tiddlers
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/1a54d590e1e67825057d7693ac89466a093b4577]] problem with test data in certain time zones
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/5af30086c02b9d4466c133c87aca76f9b85eea49]] problem with non-breaking space characters being converted into '@' symbols
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/5d3dda1a1721af05e56e301a8b896e53f9868540]] problem with highlighting plugin only working in the browser
* [[Fixed|https://github.com/Jermolene/TiddlyWiki5/commit/175e86078ce2fed34953f337baf2f0edfc093742]] crash when wiki/themes folder contains files that are not themes

View File

@ -1,5 +1,5 @@
created: 20131219100637788
modified: 20140102200458024
modified: 20140206221215805
tags: howto dev
title: Scripts for TiddlyWiki on Node.js
type: text/vnd.tiddlywiki
@ -52,9 +52,23 @@ To experiment with this configuration, run the script and then visit `http://127
Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).
!! `wbld`: builds TiddlyWiki5 for TiddlyWeb
!! `lazy`: serves tw5.com with lazily loaded images
This script builds and deploys the code for [[TiddlyWiki5 in the Sky for TiddlyWeb]]. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.
```
lazy.sh <username> [<password>]
```
Or:
```
lazy.cmd <username> [<password>]
```
This script serves the `clientserver` edition content with LazyLoading applied to images.
!! `wbld`: builds TiddlyWiki for TiddlyWeb
This script builds and deploys the code for [[TiddlyWiki in the Sky for TiddlyWeb]]. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.
!! `2bld`: builds TiddlyWiki 2.6.5

View File

@ -1,10 +1,10 @@
created: 20131129100250644
modified: 20131129100250644
modified: 20140206221253685
tags: howto
title: TiddlyWiki5 in the Sky for TiddlyWeb
title: TiddlyWiki in the Sky for TiddlyWeb
type: text/vnd.tiddlywiki
The TiddlyWiki5 in the Sky for TiddlyWeb allows content to be synchronised between TiddlyWiki5 running in the browser and a TiddlyWeb (or TiddlySpace) server. Features include:
TiddlyWiki in the Sky for TiddlyWeb allows content to be synchronised between TiddlyWiki running in the browser and a TiddlyWeb (or TiddlySpace) server. Features include:
* Lazy loading
* Two way synchronisation between the browser and the server
@ -13,11 +13,11 @@ The TiddlyWiki5 in the Sky for TiddlyWeb allows content to be synchronised betwe
The implementation is somewhat experimental, and includes these limitations:
* Only works with tiddlers written in TiddlyWiki5 WikiText. Tiddlers in the old syntax will be parsed as TiddlyWiki5 syntax
* Only works with tiddlers written in TiddlyWiki version 5 WikiText. Tiddlers in the old syntax will be parsed as TiddlyWikiClassic syntax
* New tiddlers are not saved to the server
* No way to delete tiddlers
To try out TiddlyWiki5 in the Sky for TiddlyWeb:
To try out TiddlyWiki in the Sky for TiddlyWeb:
# If necessary, create an account at http://tiddlyspace.com/
# Create a new space, eg `<myspace>`

View File

@ -0,0 +1,27 @@
created: 20140206214608586
modified: 20140206220940132
tags: features concepts
title: LazyLoading
type: text/vnd.tiddlywiki
Ordinarily with TiddlyWiki, the full content of all tiddlers is embedded into the main HTML file. Lazy loading refers to the technique of only embedding metadata about the tiddler (in other words all fields except the ''text'' field), and requesting the body from the server when required.
Lazy loading can be used in two configurations:
* When running [[TiddlyWiki on Node.js]], image tiddlers can be subject to lazy loading
* When running [[TiddlyWiki in the Sky for TiddlyWeb]], all tiddlers are subject to lazy loading
See the LazyLoadingMechanism for details of how lazy loading is implemented.
! Lazy loading under Node.js
To run TiddlyWiki with lazy loading for images, use this alternative ServerCommand to start the server:
```
tiddlywiki --server 8080 $:/core/save/lazy-images
```
! Lazy loading under TiddlyWeb
With the current configuration, lazy loading is enabled by default.

View File

@ -1,8 +1,13 @@
created: 201308251625
modified: 201308251626
created: 20130825162500000
modified: 20140206221900969
tags: dev mechanism
title: LazyLoadingMechanism
type: text/vnd.tiddlywiki
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.
TiddlyWiki currently only implements LazyLoading when it is running in the browser talking to a TiddlyWeb-compatible server.
So, the browser-based search built into TiddlyWiki5 will only search the text of tiddlers that have been fully loaded. The expectation is that when lazy loading is used in a client-server configuration, then it's the server that really needs to handle search operations, because it's only the server that can "see" the text of all tiddlers. So, the plan is to integrate TW's built in search with TiddlyWeb's search API. The simplest approach is that any local search triggers an asynchronous server side search. The results of the search would be asynchronously loaded such that they would dynamically appear in the local search results.
In the [[configuration for TiddlyWeb|TiddlyWiki in the Sky for TiddlyWeb]], the browser 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.
Lazy loading can also be used with TiddlyWiki's own server. The core provides a template that enables images to be lazily loaded while other tiddlers are packaged into the initial HTML file in the usual way.
The browser-based search built into TiddlyWiki5 will only search the text of tiddlers that have been fully loaded. The expectation is that when lazy loading is used in a client-server configuration, then it is the server that really needs to handle search operations, because it is only the server that can "see" the text of all tiddlers. So, the plan is to integrate the built in search with TiddlyWeb's search API. The simplest approach is that any local search triggers an asynchronous server side search. The results of the search would be asynchronously loaded such that they would dynamically appear in the local search results.