mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jermolene 2014-02-23 19:22:42 +00:00
parent 6947f8ebc2
commit 6cd13efd48
2 changed files with 62 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/tw5.com/tiddlers/Release 5.0.8beta.tid
View File

@ -1,5 +1,5 @@
created: 20140127143652456
modified: 20140206191028534
modified: 20140223191618338
tags: releasenote
title: Release 5.0.8-beta
type: text/vnd.tiddlywiki
@ -10,8 +10,9 @@ type: text/vnd.tiddlywiki
See [[Notes for upgrading to 5.0.8-beta]] for more details of these changes:
* Changed wikitext syntax rules for parsing content of HTML elements
* Changed rules for parsing content of HTML elements
* Switched SiteTitle and SiteSubtitle to [[$:/SiteTitle]] and [[$:/SiteSubtitle]]
* Changes to commands used with [[TiddlyWiki on Node.js]]
!! Documentation Improvements
@ -20,6 +21,7 @@ See [[Notes for upgrading to 5.0.8-beta]] for more details of these changes:
!! Usability Improvements
* Rejigged [[$:/ControlPanel]] to use nested tabs
* Added confirmation dialogue when deleting tiddlers
* [[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
@ -39,6 +41,7 @@ See [[Notes for upgrading to 5.0.8-beta]] for more details of these changes:
!! Hackability Improvements
* Extended ButtonWidget to allow navigating to a tiddler
* Added experimental support for building plugins in the browser: [[How to create plugins in the browser]]
* Extend the TranscludeWidget to display its content as a fallback if the tiddler or field is missing
* Add logging and AlertMechanism

57
editions/tw5.com/tiddlers/howtos/Notes for upgrading to 5.0.8-beta.tid Normal file
View File

@ -0,0 +1,57 @@
created: 20140223183404938
modified: 20140223192031783
tags: howto
title: Notes for upgrading to 5.0.8-beta
type: text/vnd.tiddlywiki
Version 5.0.8-beta includes some changes that can break content from earlier releases of ~TiddlyWiki 5.
! Change to [[$:/SiteTitle]] and [[$:/SiteSubtitle]]
You should rename any existing SiteTitle and SiteSubtitle tiddlers to [[$:/SiteTitle]] and [[$:/SiteSubtitle]] respectively.
! Changed parsing rules for content of HTML elements
Version 5.0.8-beta marks a change in the way that TiddlyWiki determines whether to parse the content of an HTML element or widget in //block mode// or //inline mode//.
* In block mode, TiddlyWiki parses text into paragraphs, creating `<p>` tags to wrap them. It also recognises block syntax like headings, lists and tables.
* In inline mode, TiddlyWiki ignores paragraph formatting, and just recognises character formatting, like bold and italic.
It's important to be able to control which type of parsing is performed for different situations.
Prior to 5.0.8-beta, TiddlyWiki parsed the content of an element in inline mode unless the opening tag of the element were immediately followed by a line break. This meant that much of the time element tags would be shunted together into a long line, hindering readability.
The new behaviour for 5.0.8-beta is to parse the content of an element in inline mode unless the opening tag is immediately followed by two line breaks.
To adjust existing content for 5.0.8-beta you will need to manually add the additional line break after the opening tag of elements and widgets whose content should be parsed in block mode.
The positive aspect of the change is that it removes the need to pack multiple HTML tags onto a single line, improving readability.
!! Examples
Consider the difference between these two examples. First, here's an HTML tag that starts with two line breaks:
<<wikitext-example src:"
<blockquote>
! This is a heading
And a paragraph of text.
</blockquote>
">>
Secondly, here's an HTML tag with just a single line break. Notice how the heading is no longer recognised as a heading
<<wikitext-example src:"
<blockquote>
! This is a heading
And a paragraph of text.
</blockquote>
">>
! Changed commands for [[TiddlyWiki on Node.js]]
The handling of wiki folders has changed. Previously, if the `tiddlywiki` command was run against a wiki folder that didn't have the necessary `tiddlywiki.info` file then it would be automatically created. Now, the wiki folder must be initialised with the CreateWikiCommand.