TiddlyWiki 5 Documentation

To extract tiddlers from an original HTML file (specifically for the great-interview-project-2010 edition) and import them into a new wiki build, follow these steps:

1. Extract JSON via Browser Console:

   • Load ./editions/tiddlywiki-surveys/great-interview-project-2010/The great TiddlyWiki interview project.htm in a web browser.
   • Open the developer console and execute the script found at ./editions/tiddlywiki-surveys/scripts/extract-text-tiddlers-via-console.js.
   • The script will generate a JSON representation of the text tiddlers and copy it to your clipboard.

2. Prepare JSON File:

   • Paste the clipboard content into a new file named 2010-great-interview-project.json located in the ./tmp folder at the repository root.

3. Run Import Script:

   • Open a terminal in the repository root.
   • Execute the shell script: ./editions/tiddlywiki-surveys/scripts/import-great-interview-project-json.sh.
   • After the script runs, go back to the browser developer console and copy the output. Note: This is a large block of text starting with mkdir -p. Ensure you select the entire block including newlines.

4. Execute Shell Commands and Build:

   • Paste the copied text from the browser console into your terminal.
   • Build the wiki using the TiddlyWiki Node.js CLI:

     node ./tiddlywiki.js ./editions/tiddlywiki-surveys --build index

5. Locate Output:

   • The built wiki will be available at ./editions/tiddlywiki-surveys/output/index.html.

To contribute to TiddlyWiki5, you must sign the Individual Contributor License Agreement (CLA). This is a legally binding document that grants the UnaMesa Association the rights to use, modify, and distribute your contribution.

Steps to Contribute:

1. Read the Agreement: Carefully review the licenses/cla-individual.md file.
2. Check Ownership: Ensure you own the copyright to your contribution. If you do not own the entire work of authorship, follow the specific instructions in contributing.md located in the project root.
3. Sign and Submit: Follow the electronic submission instructions provided in contributing.md to send your signed agreement to the UnaMesa Association.

Key Terms for Contributors:

• Copyright: You retain ownership of your contribution and its copyright.
• License Grant: You grant a perpetual, worldwide, non-exclusive, transferable, royalty-free, and irrevocable license to the UnaMesa Association to use your contribution as part of the TiddlyWiki5 material.
• Outbound License: The UnaMesa Association agrees to license your contribution under the same terms used for the project at the time of submission (typically BSD 3-clause "New" or "Revised" License) or Creative Commons Attribution 3.0 for non-software media.

sax.js is a SAX-style parser for XML and HTML. It can be used as a simple parser for XML strings or as a streaming parser in Node.js environments.

To use the parser, initialize it with a strict boolean (set to true for XML, false for HTML/loose mode) and assign callback functions to the parser's event properties (e.g., onopentag, ontext, onend).

var sax = require("./lib/sax"),
  strict = true, // set to false for html-mode
  parser = sax.parser(strict);

parser.onerror = function (e) {
  // an error happened.
};
parser.ontext = function (t) {
  // got some text.  t is the string of text.
};
parser.onopentag = function (node) {
  // opened a tag.  node has "name" and "attributes"
};
parser.onattribute = function (attr) {
  // an attribute.  attr has "name" and "value"
};
parser.onend = function () {
  // parser stream is done, and ready to have more stuff written to it.
};

parser.write('<xml>Hello, <who name="world">world</who>!</xml>').close();