- -TiddlyWiki5 welcomes contributions to its code and documentation via -GitHub. Please take a moment to read these notes to help make the process as smooth as possible.
-From the perspective of the developers, a bug report that says little more than "it doesn't work" can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:
-There's a lot of good material on the web about bug reports:
-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).
- -This is a first pass at a CLA for -TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again
-git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5 +Contributing to TiddlyWiki5
TiddlyWiki5 welcomes contributions to its code and documentation via GitHub. Please take a moment to read these notes to help make the process as smooth as possible.
Bug Reports
From the perspective of the developers, a bug report that says little more than "it doesn't work" can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:
There's a lot of good material on the web about bug reports:
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).
This is a first pass at a CLA for TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again
git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5 cd TiddlyWiki5 -git checkout -b sign-cla
-
-Add your name and the date to cla-individual.md or cla-entity.md. Date format (YYYY/MM/DD)
-eg:
-Jeremy Ruston, @Jermolene, 2011/11/22
-git add . +git checkout -b sign-cla
Add your name and the date to cla-individual.md or cla-entity.md. Date format (YYYY/MM/DD)
+eg: Jeremy Ruston, @Jermolene, 2011/11/22
git add . git commit -m "sign contributor license agreement" -git push origin sign-cla
- -Go to your github repo and create a pull request.
- -Thank you!
-The CLA documents used for this project where created using -Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity" -
- -This file was automatically generated by -TiddlyWiki5 +git push origin sign-cla
Go to your github repo and create a pull request.
Thank you!
The CLA documents used for this project where created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity" +
This file was automatically generated by TiddlyWiki5
\ No newline at end of file diff --git a/readme.md b/readme.md index 98cc0b8a0..dcc67330a 100644 --- a/readme.md +++ b/readme.md @@ -1,195 +1,5 @@ --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, meaning it is working but incomplete. It is a great time to get involved and support its -future development:
- - -TiddlyWiki is a free, open source project that depends on -your love and support for its survival -
- -TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, -TiddlyWikiFolders, -TiddlerFiles and -TiddlyWikiFiles. For example, the following command loads the tiddlers from a -TiddlyWiki HTML file and then saves one of them in HTML:
-node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html
-In order to use -TiddlyWiki5 on the command line you must first install node.js from -http://nodejs.org/
-Running
-tiddlywiki.js from the command line boots the
-TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.
-The first argument is the optional path to the -TiddlyWikiFolder to be loaded. If not present, then the current directory is used.
-The commands and their individual arguments follow, each command being identified by the prefix
---.
-node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]
-For trying -TiddlyWiki5 out under node.js, several batch files are provided:
-bld.sh builds tw5.com-This batch file builds several variants of -TiddlyWiki5 for deployment on tiddlywiki.com.
-By default, files are output to a folder called
-jermolene.github.com in the same directory as the main
-TiddlyWiki5 directory. You will need to create the directory before running the batch file. For example:
-* /TiddlyWork/ - Directory for working with TiddlyWiki5 +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, meaning it is working but incomplete. It is a great time to get involved and support its future development:
TiddlyWiki is a free, open source project that depends on your love and support for its survival +
TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles. For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:
node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html
In order to use TiddlyWiki5 on the command line you must first install node.js from http://nodejs.org/
Running tiddlywiki.js from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.
The first argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.
The commands and their individual arguments follow, each command being identified by the prefix --.
node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]
For trying TiddlyWiki5 out under node.js, several batch files are provided:
bld.sh builds tw5.comThis batch file builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.
By default, files are output to a folder called jermolene.github.com in the same directory as the main TiddlyWiki5 directory. You will need to create the directory before running the batch file. For example:
* /TiddlyWork/ - Directory for working with TiddlyWiki5 * /TiddlyWork/TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub -* /TiddlyWork/jermolene.github.com/ - Directory for output files
-You can override the build output directory by defining the environment variable
-TW5_BUILD_OUTPUT. The easiest way to do this is to create a personal batch file to invoke
-TiddlyWiki5 that first sets the environment variable and then invokes
-bld.sh.
-The files output by
-bld.sh are:
-readme.md main readme file, output to the
-TiddlyWiki5 directory
-index.html
-TiddlyWiki5 standalone HTML file with content from the
-tw5.com edition
-empty.html
-TiddlyWiki5 standalone HTML file with no content
-encrypted.html
-TiddlyWiki5 standalone HTML file encrypted with the password
-password
-test.html
-TiddlyWiki5 browser-based test suite (see
-TestingMechanism)
-static.html static HTML version of the
-DefaultTiddlers of the
-tw5.com edition
-static/*.html and
-static/static.css static HTML versions of individual tiddlers
-
-bld.sh also runs the
-TiddlyWiki5 node.js-based test suite (see
-TestingMechanism)
-serve.sh serves tw5.com
-This batch file starts
-TiddlyWiki5 running as an HTTP server with the content from the
-clientserver edition. By default, the script serves on port 8080.
-./server.sh UserName
-The single parameter to the script is the username to use for signing edits.
-To experiment with this configuration, run the script and then visit
-http://0.0.0.0:8080 in a browser.
-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.sh builds
-TiddlyWiki5 for
-TiddlyWeb-This batch file 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.
-2bld.sh builds
-TiddlyWiki 2.6.5
-This batch file builds
-TiddlyWiki 2.6.5 from the original source and then uses the
-opendiff program to display the differences between them.
-The following commands are available:
-Load tiddlers from 2.x.x
-TiddlyWiki files (
-.html),
-.tiddler,
-.tid,
-.json or other files
---load <filepath>
-Set a password for subsequent crypto operations
---password <password>
-The
-print command outputs specified information.
-Output the titles of the tiddlers in the wiki store
---print tiddlers
-Print the fields of an individual tiddler
---print tiddler <title>
-Print the titles of the system tiddlers in the wiki store
---print system
-Print the current core configuration
---print config
-Render an individual tiddler as a specified
-ContentType, defaults to
-text/html and save it to the specified filename
---rendertiddler <title> <filename> [<type>]
-Render a set of tiddlers matching a filter to separate files of a specified
-ContentType (defaults to
-text/html) and extension (defaults to
-.html).
---rendertiddlers <filter> <template> <pathname> [<type>] [<extension>]
-For example:
---rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain
-The server built in to -TiddlyWiki5 is very simple. Although compatible with -TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage - in particular, -TiddlyWiki5 is an old-school wiki in the sense that it offers no authentication.
-At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for
-GET,
-PUT and
-DELETE.
---server <port> <roottiddler> <rendertype> <servetype> <username>
-The parameters are:
-For example:
---server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName
-Triggers verbose output, useful for debugging
---verbose
-Displays the version number of -TiddlyWiki.
---version
- -This readme file was automatically generated by -TiddlyWiki5 +* /TiddlyWork/jermolene.github.com/ - Directory for output files
You can override the build output directory by defining the environment variable TW5_BUILD_OUTPUT. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes bld.sh.
The files output by bld.sh are:
readme.md main readme file, output to the TiddlyWiki5 directoryindex.html TiddlyWiki5 standalone HTML file with content from the tw5.com editionempty.html TiddlyWiki5 standalone HTML file with no contentencrypted.html TiddlyWiki5 standalone HTML file encrypted with the password passwordtest.html TiddlyWiki5 browser-based test suite (see TestingMechanism)static.html static HTML version of the DefaultTiddlers of the tw5.com editionstatic/*.html and static/static.css static HTML versions of individual tiddlersbld.sh also runs the TiddlyWiki5 node.js-based test suite (see TestingMechanism)
serve.sh serves tw5.comThis batch file starts TiddlyWiki5 running as an HTTP server with the content from the clientserver edition. By default, the script serves on port 8080.
./server.sh UserName
The single parameter to the script is the username to use for signing edits.
To experiment with this configuration, run the script and then visit http://0.0.0.0:8080 in a browser.
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.sh builds TiddlyWiki5 for TiddlyWebThis batch file 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.
2bld.sh builds TiddlyWiki 2.6.5This batch file builds TiddlyWiki 2.6.5 from the original source and then uses the opendiff program to display the differences between them.
The following commands are available:
Load tiddlers from 2.x.x TiddlyWiki files (.html), .tiddler, .tid, .json or other files
--load <filepath>
Set a password for subsequent crypto operations
--password <password>
The print command outputs specified information.
Output the titles of the tiddlers in the wiki store
--print tiddlers
Print the fields of an individual tiddler
--print tiddler <title>
Print the titles of the system tiddlers in the wiki store
--print system
Print the current core configuration
--print config
Render an individual tiddler as a specified ContentType, defaults to text/html and save it to the specified filename
--rendertiddler <title> <filename> [<type>]
Render a set of tiddlers matching a filter to separate files of a specified ContentType (defaults to text/html) and extension (defaults to .html).
--rendertiddlers <filter> <template> <pathname> [<type>] [<extension>]
For example:
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain
The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage - in particular, TiddlyWiki5 is an old-school wiki in the sense that it offers no authentication.
At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for GET, PUT and DELETE.
--server <port> <roottiddler> <rendertype> <servetype> <username>
The parameters are:
For example:
--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName
Triggers verbose output, useful for debugging
--verbose
Displays the version number of TiddlyWiki.
--version
This readme file was automatically generated by TiddlyWiki5
\ No newline at end of file