From 41fc06ab4dae3ba022ef5f6d0528a46433b34857 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Mon, 2 Dec 2013 09:59:44 +0000 Subject: [PATCH] Docs updates --- .../tw5.com/tiddlers/Release 5.0.0alpha18.tid | 7 ++++ .../tiddlers/dev/TiddlyWiki5 Versioning.tid | 42 +++++++++++++++++++ readme.md | 2 +- 3 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 editions/tw5.com/tiddlers/dev/TiddlyWiki5 Versioning.tid diff --git a/editions/tw5.com/tiddlers/Release 5.0.0alpha18.tid b/editions/tw5.com/tiddlers/Release 5.0.0alpha18.tid index eae355e24..186114176 100644 --- a/editions/tw5.com/tiddlers/Release 5.0.0alpha18.tid +++ b/editions/tw5.com/tiddlers/Release 5.0.0alpha18.tid @@ -11,8 +11,15 @@ type: text/vnd.tiddlywiki !! Improvements * If `$:/theme` isn't defined or refers to a missing tiddler, then fallback through ''Snow White'' to ''Vanilla''. This means that `empty.html` now defaults to ''Snow White'' +* Changes to the importing process to enable a smoother [[TiddlyWiki5 Upgrade Process]] +** Ignores attempts to import plugins that are older than currently installed plugins +** System tiddlers are now imported as usual !! Bug fixes * Fixed bug that was preventing `$:/tags/PageControls` tiddlers from being reordered +!! Internal changes + +* Changed the [[TiddlyWiki5 Versioning]] policy +** New alpha releases will be `5.0.x-alpha`, beta releases will be `5.1.x-beta` and the final release will be `5.2.x` diff --git a/editions/tw5.com/tiddlers/dev/TiddlyWiki5 Versioning.tid b/editions/tw5.com/tiddlers/dev/TiddlyWiki5 Versioning.tid new file mode 100644 index 000000000..cedcfbfb1 --- /dev/null +++ b/editions/tw5.com/tiddlers/dev/TiddlyWiki5 Versioning.tid @@ -0,0 +1,42 @@ +created: 20131202081424080 +creator: JeremyRuston +modified: 20131202082237877 +modifier: JeremyRuston +tags: dev +title: TiddlyWiki5 Versioning +type: text/vnd.tiddlywiki + +Each release of TiddlyWiki5 is identified by a version number that complies with the [[Semantic Versioning 2.0.0|http://semver.org/]] standard. + +! TiddlyWiki Core Version + +According to the standard: + +``` +Given a version number MAJOR.MINOR.PATCH, increment the: + +MAJOR version when you make incompatible API changes, +MINOR version when you add functionality in a backwards-compatible manner, and +PATCH version when you make backwards-compatible bug fixes. +Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. +``` + +!! Alpha and Beta versions + +While in alpha TiddlyWiki5 uses the pre-release label "alpha", for example: + +``` +5.0.1-alpha +``` + +Each new alpha or beta release will bump the `PATCH` version number. This breaks the strict semantics of versioning because `PATCH` increments are supposed to be reserved for compatible changes. + +!! Interim versions + +During development when a new release is being prepared, the pre-release label is set to `prerelease`. + +! Plugin Versions + +Version numbers + +TiddlyWiki5 uses the version information attached to plugins for determining which of two plugins is more recent during an upgrade or import. The pre-release label is ignored when performing these comparisons. diff --git a/readme.md b/readme.md index 302834314..3dac4798d 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -

Welcome to TiddlyWiki5

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.

TiddlyWiki5 is currently in alpha at version 5.0.0-alpha.18-prerelease (see the detailed ReleaseHistory). There is a RoadMap for moving to beta and getting to the full release. It is a great time to get involved and support the future development of TiddlyWiki5.

TiddlyWiki is a free, open source project that depends on your love and support for its survival.

+

Welcome to TiddlyWiki5

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.

TiddlyWiki5 is currently in alpha at version 5.0.1-prerelease (see the detailed ReleaseHistory). There is a RoadMap for moving to beta and getting to the full release. It is a great time to get involved and support the future development of TiddlyWiki5.

TiddlyWiki is a free, open source project that depends on your love and support for its survival.

The deep internal improvements mean that TiddlyWiki5 is not fully compatible with older versions. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as TiddlyWiki5 matures.

The original TiddlyWiki Classic is still available at http://tiddlywiki.com/.

Getting started with TiddlyWiki under Node.js

Installation

For working on the command line with Node.js, you can install TiddlyWiki via npm:

npm -g install tiddlywiki

The -g flag causes TiddlyWiki to be installed globally.

Working with the TiddlyWiki5 repository

Working with the TiddlyWiki5 repository is recommended if you plan on forking the TiddlyWiki5 source code.

This readme file was automatically generated by TiddlyWiki5