Skip to content

Commit

Permalink
[DOCS] Improve documentation about TW Concepts (#8942)
Browse files Browse the repository at this point in the history
  • Loading branch information
pmario authored Feb 14, 2025
1 parent f5a6ac9 commit 4f0bdac
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
8 changes: 8 additions & 0 deletions editions/tw5.com/tiddlers/Tags.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
created: 20250211093401937
modified: 20250211093527189
tags: Concepts
title: Tags

Tags are used to organise tiddlers into categories.

For more details see: [[Tagging]]
8 changes: 8 additions & 0 deletions editions/tw5.com/tiddlers/Title.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
created: 20250211094052630
modified: 20250211094419548
tags: Concepts
title: Title

The minimum requirement for a valid tiddler is a ''unique'' title.

Learn more at: [[Tiddlers]]
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/concepts/Concepts.tid
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ type: text/vnd.tiddlywiki

These are the concepts underlying TiddlyWiki. Understanding how these ideas fit together is the key to getting the most from TiddlyWiki.

<<list-links "[tag[Concepts]]" class:"multi-columns">>
<<list-links "[tag[Concepts]sort[title]]" class:"multi-columns">>
4 changes: 2 additions & 2 deletions editions/tw5.com/tiddlers/concepts/Tiddlers.tid
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ tags: Concepts
title: Tiddlers
type: text/vnd.tiddlywiki

Tiddlers are the fundamental units of information in TiddlyWiki. Tiddlers work best when they are as small as possible so that they can be reused by weaving them together in different ways.
Tiddlers are the fundamental units of information in ~TiddlyWiki. Tiddlers work best when they are as small as possible so that they can be reused by weaving them together in different ways.

A "tiddler" is an informal British word meaning a small fish, typically a stickleback or a minnow. Other systems have analogous concepts with generic names like "items", "entries", "entities", "nodes" or "records". TiddlyWiki takes the view that it is better to be confusingly distinctive than confusingly generic.
A "tiddler" is an informal British word meaning a small fish, typically a stickleback or a minnow. Other systems have analogous concepts with generic names like "items", "entries", "entities", "nodes" or "records". ~TiddlyWiki takes the view that it is better to be confusingly distinctive than confusingly generic.

Internally, tiddlers are a list of uniquely named values called fields. The only field that is required is the `title` field, but useful tiddlers also have a `text` field, and some or all of the standard fields listed in TiddlerFields.

Expand Down

0 comments on commit 4f0bdac

Please sign in to comment.