mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 00:50:28 +00:00
Code Issues Releases Wiki Activity

Improve text slicer docs

Browse Source
This commit is contained in:
Jermolene 2015-08-03 09:13:36 +01:00
parent cc1acdaf74
commit 8b9e790e69
4 changed files with 35 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
editions/text-slicer/tiddlers/HelloThere.tid
View File

@ -2,7 +2,9 @@ title: HelloThere
This edition of ~TiddlyWiki contains tools to help slice up long texts into individual tiddlers.
//It is currently only intended for advanced users. The tools are in the early stages of development, and likely to need some customisation to do what you need.//
//''This plugin is under active development, and is subject to change in the future''. It is currently only intended for advanced users. The tools are in the early stages of development, and likely to need some customisation to do what you need.//
! Usage
The source document must first be marked up as an ordinary wikitext tiddler. Currently only the following formatting is recognised:
@ -16,10 +18,8 @@ To try it out:
# Click the ''import'' button in the resulting import listing
# Open the tiddler [[Sliced up Sample Text]]
#* It should match the content of [[Sample Text]]
#* The table of contents at the top allows the structure to be explored
The table of contents at the top of the output tiddler shows how the document has been split up into individual tiddlers:
! Plugin Instructions
* A tiddler for each heading, with the children of the heading tagged with the title of the heading
* A tiddler for each paragraph
* A tiddler for each list, and a tiddler for each list item
* The list field of tag tiddlers is used to control ordering of children
{{$:/plugins/tiddlywiki/text-slicer/docs}}

26
plugins/tiddlywiki/text-slicer/docs.tid Normal file
View File

@ -0,0 +1,26 @@
title: $:/plugins/tiddlywiki/text-slicer/docs
!! Text Slicing Approach
Individual tiddlers are created for each heading, paragraph and list item. They are linked together using TiddlyWiki's tagging mechanism.
For example, consider a tiddler titled ''Example'' containing this simple text:
<<<
! This is a heading
This is a paragraph.
* And the first list item
* Second list item
<<<
It will be sliced up into:
* a tiddler for the overall document
** a tiddler for the heading
*** a tiddler for the paragraph
*** a tiddler for the list
**** and a tiddler for each list item
These tiddlers are bound together using tagging: child tiddlers are tagged with the title of their parent, and the parent tiddler has a ''list'' field that lists each child in the correct order.

2
plugins/tiddlywiki/text-slicer/plugin.info
View File

@ -3,5 +3,5 @@
"description": "Tools for slicing text into tiddlers",
"author": "JeremyRuston",
"core-version": ">=5.0.0",
"list": "readme"
"list": "readme docs"
}

2
plugins/tiddlywiki/text-slicer/readme.tid
View File

@ -1,3 +1,5 @@
title: $:/plugins/tiddlywiki/text-slicer/readme
//''This plugin is under active development, and is subject to change in the future''. It is currently only intended for advanced users. The tools are in the early stages of development, and likely to need some customisation to do what you need.//
This plugin contains tools to help slice up long texts into individual tiddlers.