Skip to content

Commit

Permalink
Docs updates and fixing broken links (#4628)
Browse files Browse the repository at this point in the history
* Corecting URL of LuckySushi shop

* Android-Instructions remained for Andtidwiki

* Updating description and feature set of Timimi
Updating URL of Widdly
Resolving minor camelcase issues in TiddlySpot

* Detailed instructions about termux and adding it to save methods

* Correcting the words "open source" and "Unix"

* Changing link protocols of verified domains to https
  • Loading branch information
ibnishak authored May 6, 2020
1 parent 33e9f88 commit 31c4fd5
Show file tree
Hide file tree
Showing 28 changed files with 122 additions and 70 deletions.
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/about/Developers.tid
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ type: text/vnd.tiddlywiki
There are several resources for developers to learn more about TiddlyWiki and to discuss and contribute to its development.

* [[tiddlywiki.com/dev|https://tiddlywiki.com/dev]] is the official developer documentation
* [[TiddlyWikiDev group|http://groups.google.com/group/TiddlyWikiDev]] for discussions about TiddlyWiki development
* [[TiddlyWikiDev group|https://groups.google.com/group/TiddlyWikiDev]] for discussions about TiddlyWiki development
* https://github.com/Jermolene/TiddlyWiki5 for the source code and development activity
6 changes: 3 additions & 3 deletions editions/tw5.com/tiddlers/community/Forums.tid
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: text/vnd.tiddlywiki

The ~TiddlyWiki discussion groups are mailing lists for talking about ~TiddlyWiki: requests for help, announcements of new releases and plugins, debating new features, or just sharing experiences. You can participate via the associated website, or subscribe via email.

* The main ~TiddlyWiki group: http://groups.google.com/group/TiddlyWiki
* The main ~TiddlyWiki group: https://groups.google.com/group/TiddlyWiki
*> Note that you do not need a Google Account to join the discussion groups. Subscribe by sending an email to mailto:[email protected] or mailto:[email protected].
** An enhanced group search facility is available on [[mail-archive.com|https://www.mail-archive.com/[email protected]/]]
* Watch recordings of our regular [[TiddlyWiki Hangouts]]
Expand All @@ -19,7 +19,7 @@ The ~TiddlyWiki discussion groups are mailing lists for talking about ~TiddlyWik

! Developers

* The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev
* The TiddlyWikiDev group for developers: https://groups.google.com/group/TiddlyWikiDev
*> Note that you do not need a Google Account to join the discussion groups. Subscribe by sending an email to mailto:[email protected] or mailto:[email protected].
** An enhanced group search facility is available on [[mail-archive.com|https://www.mail-archive.com/[email protected]/]]
* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news
Expand All @@ -30,4 +30,4 @@ New releases of TiddlyWiki, TiddlyDesktop and TiddlyFox are announced via the di

! Documentation

There is also a discussion group specifically for discussing TiddlyWiki documentation improvement initiatives: http://groups.google.com/group/tiddlywikidocs
There is also a discussion group specifically for discussing TiddlyWiki documentation improvement initiatives: https://groups.google.com/group/tiddlywikidocs
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/community/examples/PETTIL.tid
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "PETTIL - Forth for the Commodore PET" by Charlie Hitselberger
type: text/vnd.tiddlywiki
url: http://chitselb.com/files/tiddlypettil.html

A fast Forth interpreter for the [[Commodore PET|http://en.wikipedia.org/wiki/Commodore_PET]], written in 6502 assembly language. The TiddlyWiki containing program documentation is automatically generated from the source code: see https://github.com/chitselb/pettil.
A fast Forth interpreter for the [[Commodore PET|https://en.wikipedia.org/wiki/Commodore_PET]], written in 6502 assembly language. The TiddlyWiki containing program documentation is automatically generated from the source code: see https://github.com/chitselb/pettil.

{{!!url}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ modified: 20180309164105386
tags: Resources
title: Widdly by Opennota
type: text/vnd.tiddlywiki
url: https://github.com/opennota/widdly
url: https://gitlab.com/opennota/widdly

A cross platform server application that can save tiddlers to a local database

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ modified: 20161224181607230
tags: Resources
title: "Lucky Sushi" online shop by sini-Kit
type: text/vnd.tiddlywiki
url: http://luckysushi.ru/habarovsk/heeg35.html#index
url: http://luckysushi.ru/habarovsk/heeg.html#index

A complete online shop made in ~TiddlyWiki!

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
caption: Timimi
created: 20180830194141190
delivery: Browser Extension & Executable
description: Browser extension & executable for desktops
delivery: Browser Extension & Native host
description: Browser extension & native host for desktops
method: save
modified: 20181012165153986
tags: Windows Linux Chrome Firefox Saving Resources plugins
title: "Timimi" Extension and executable by Riz
modified: 20200501092235061
tags: Windows Linux Chrome Firefox Saving Resources plugins Mac Opera
title: Timimi: WebExtension and Native Host by Riz
type: text/vnd.tiddlywiki
url: https://github.com/ibnishak/Timimi
url: https://ibnishak.github.io/Timimi/

`Timimi` is a Web Extension and executable for Firefox, Chrome and Chromium that allows it to save standalone ~TiddlyWiki files.
Timimi is a web-extension accompanied by a native host that allows you to save and backup your standalone HTML tiddlywiki files ''anywhere in your hard-drive''. Once installed, you can save the tiddlywiki files without any extra steps, like the original Tiddlyfox addon.

{{!!url}}

This is an addon using native messaging, essentially handing over the contents to a webextension host (executable) which does the actual saving. Once installed, you can save the standalone TW from anywhere in your hard drive without any more interactions, like the original Tiddlyfox addon.
As of version 2.1, Timimi supports the following browsers

* Chrome/Chromium
* Firefox
* Opera
* Microsoft Edge (Chromium)

It is also reported to work seamlessly in chrome based browsers like Brave and Vivaldi.

Timimi also provides users with 4 backup strategies, viz:

* Create a backup Every n^^th^^ save
* Create a backup every n^^th^^ minute
* Customised Tower of Hanoi
* First in First Out
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/concepts/Date Fields.tid
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Values of date fields are 17-character strings:
* 2 digits for the second
* 3 digits for the millisecond

To avoid problems arising from differences of time zone, TiddlyWiki always uses [[UTC|http://en.wikipedia.org/wiki/Coordinated_Universal_Time]].
To avoid problems arising from differences of time zone, TiddlyWiki always uses [[UTC|https://en.wikipedia.org/wiki/Coordinated_Universal_Time]].

As an example, the <<.field created>> field of this tiddler has the value <<.value """<$view field="created"/>""">>.

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/concepts/Transclusion.tid
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ modified: 20141130195444237
tags: Concepts
title: Transclusion

[[Transclusion|http://en.wikipedia.org/wiki/Transclusion]] is the process of referencing one tiddler "A" from another tiddler "B" such that the content of "A" appears to be a part of "B".
[[Transclusion|https://en.wikipedia.org/wiki/Transclusion]] is the process of referencing one tiddler "A" from another tiddler "B" such that the content of "A" appears to be a part of "B".

Copying and pasting content creates multiple copies of the same content in several different places. With transclusion, there can be a single copy and a special instruction in "B" which indicates the point at which content should be inserted from tiddler "A".

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/Base64.tid
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ tags: Definitions
title: Base64
type: text/vnd.tiddlywiki

<<.dlink-ex Base64 "http://en.wikipedia.org/wiki/Base64">> is a way of representing binary data, such an image, as a string of text.
<<.dlink-ex Base64 "https://en.wikipedia.org/wiki/Base64">> is a way of representing binary data, such an image, as a string of text.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ tags: Definitions
title: Cascading Style Sheets
type: text/vnd.tiddlywiki

<<.dlink-ex CSS "http://en.wikipedia.org/wiki/Cascading_Style_Sheets">> is a standard plain-text format used for defining the presentational style of the various elements on a web page.
<<.dlink-ex CSS "https://en.wikipedia.org/wiki/Cascading_Style_Sheets">> is a standard plain-text format used for defining the presentational style of the various elements on a web page.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: Definitions
title: Comma-Separated Values
type: text/vnd.tiddlywiki

<<.dlink-ex CSV "http://en.wikipedia.org/wiki/Comma-separated_values">> is a standard plain-text format for storing a table of data.
<<.dlink-ex CSV "https://en.wikipedia.org/wiki/Comma-separated_values">> is a standard plain-text format for storing a table of data.

Each row of the table is called a <<.def record>> and occupies one line.

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/Data URI.tid
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ tags: Definitions
title: Data URI
type: text/vnd.tiddlywiki

A <<.dlink-ex "data URI" "http://en.wikipedia.org/wiki/Data_URI_scheme">> is a way of storing data (such as an image) in a way that is compatible with the addresses used by web pages and [[stylesheets|Cascading Style Sheets]] to access external resources.
A <<.dlink-ex "data URI" "https://en.wikipedia.org/wiki/Data_URI_scheme">> is a way of storing data (such as an image) in a way that is compatible with the addresses used by web pages and [[stylesheets|Cascading Style Sheets]] to access external resources.

The <<.mlink datauri>> macro can be used to generate data URIs within ~TiddlyWiki.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: Definitions
title: Document Object Model
type: text/vnd.tiddlywiki

The <<.dlink-ex DOM "http://en.wikipedia.org/wiki/Document_Object_Model">> of a web page is a tree-shaped model of its content, maintained internally by the web browser as the user interacts with that content. Each point in the tree is called a <<.def node>>.
The <<.dlink-ex DOM "https://en.wikipedia.org/wiki/Document_Object_Model">> of a web page is a tree-shaped model of its content, maintained internally by the web browser as the user interacts with that content. Each point in the tree is called a <<.def node>>.

When ~TiddlyWiki is running in a web browser, its [[widgets|Widgets]] are rendered into DOM nodes for display.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: Definitions
title: HyperText Markup Language
type: text/vnd.tiddlywiki

<<.dlink-ex HTML "http://en.wikipedia.org/wiki/HTML">> is a standard plain-text format used for defining the content of a web page.
<<.dlink-ex HTML "https://en.wikipedia.org/wiki/HTML">> is a standard plain-text format used for defining the content of a web page.

It consists of a tree of elements expressed using a system of special <<.def tags>> enclosed in angle brackets.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: Definitions
title: JavaScript Object Notation
type: text/vnd.tiddlywiki

<<.dlink-ex JSON "http://en.wikipedia.org/wiki/JSON">> is a standard plain-text format used for modelling hierarchical structures of objects that contain named fields.
<<.dlink-ex JSON "https://en.wikipedia.org/wiki/JSON">> is a standard plain-text format used for modelling hierarchical structures of objects that contain named fields.

DataTiddlers can have JSON content.

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/OpenSource.tid
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ modified: 201308251307
tags: Definitions
title: OpenSource

OpenSource is [[defined by Wikipedia|http://en.wikipedia.org/wiki/Open_source]] as //a philosophy, or pragmatic methodology that promotes free redistribution and access to an end product's design and implementation details//.
OpenSource is [[defined by Wikipedia|https://en.wikipedia.org/wiki/Open_source]] as //a philosophy, or pragmatic methodology that promotes free redistribution and access to an end product's design and implementation details//.

2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/Percent Encoding.tid
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: Definitions
title: Percent Encoding
type: text/vnd.tiddlywiki

<<.dlink-ex "Percent encoding" "http://en.wikipedia.org/wiki/Percent-encoding">> is a notation that allows otherwise invalid characters to be included in a [[URI]].
<<.dlink-ex "Percent encoding" "https://en.wikipedia.org/wiki/Percent-encoding">> is a notation that allows otherwise invalid characters to be included in a [[URI]].

Such characters are represented as a percent sign `%` followed by two additional characters.

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/Quine.tid
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: Definitions
title: Quine
type: text/vnd.tiddlywiki

Wikipedia [[defines a Quine|http://en.wikipedia.org/wiki/Quine_(computing)]] as //a computer program which takes no input and produces a copy of its own source code as its only output//.
Wikipedia [[defines a Quine|https://en.wikipedia.org/wiki/Quine_(computing)]] as //a computer program which takes no input and produces a copy of its own source code as its only output//.

TiddlyWiki is an unusual example of a practical quine: it is this ability to produce a copy of its own source code that lies at the heart of TiddlyWiki's ability to independently save changes to itself.

Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/URI.tid
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ tags: Definitions
title: URI
type: text/vnd.tiddlywiki

A <<.dlink-ex "URI" "http://en.wikipedia.org/wiki/Uniform_resource_identifier">> (also often known as a <<.def URL>>) is a string of characters used to specify the location of a resource such as a web page.
A <<.dlink-ex "URI" "https://en.wikipedia.org/wiki/Uniform_resource_identifier">> (also often known as a <<.def URL>>) is a string of characters used to specify the location of a resource such as a web page.
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/hellothere/HelloThere.tid
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use it to keep your [[to-do list|TaskManagementExample]], to plan an [[essay or
Unlike conventional online services, TiddlyWiki lets you choose where to keep your data, guaranteeing that in the decades to come you will [[still be able to use|Future Proof]] the notes you take today.

<div style="font-size:0.7em;text-align:center;margin:3em auto;">
<a href="http://groups.google.com/group/TiddlyWiki" class="tc-btn-big-green" style="border-radius:4px;background-color:#FF8C19;" target="_blank" rel="noopener noreferrer">
<a href="https://groups.google.com/group/TiddlyWiki" class="tc-btn-big-green" style="border-radius:4px;background-color:#FF8C19;" target="_blank" rel="noopener noreferrer">
{{$:/core/images/help}} Forum
</a>
<a href="https://www.youtube.com/c/JeremyRuston" class="tc-btn-big-green" style="border-radius:4px;background-color:#e52d27;" target="_blank" rel="noopener noreferrer">
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/howtos/Windows HTA Hack.tid
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Under Windows it is possible to convert TiddlyWiki into a true local application

Note that one disadvantage of this approach is that the TiddlyWiki file is saved in UTF-16 format, making it up to twice as large as it would be with the usual UTF-8 encoding. However, opening and saving the file via another saving method will re-encode the file to UTF-8.

See Wikipedia for more details: http://en.wikipedia.org/wiki/HTML_Application
See Wikipedia for more details: https://en.wikipedia.org/wiki/HTML_Application
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ type: text/vnd.tiddlywiki

<<.from-version "5.1.14">>

The `tm-open-external-window` message opens an external link eg: "http://tiddlywiki.com" in a new //browser// window. If no parameters are specified, it opens the help tiddler. Any additional parameters passed via the <<.param "paramObject">> are being provided as variables to the new window.
The `tm-open-external-window` message opens an external link eg: "https://tiddlywiki.com" in a new //browser// window. If no parameters are specified, it opens the help tiddler. Any additional parameters passed via the <<.param "paramObject">> are being provided as variables to the new window.

|!Name |!Description |
|param |URL of the tiddler to be opened in a new browser window, defaults to the [[TiddlyWiki help|http://tiddlywiki.com/#WidgetMessage%3A%20tm-open-external-window if empty]] |
|param |URL of the tiddler to be opened in a new browser window, defaults to the [[TiddlyWiki help|https://tiddlywiki.com/#WidgetMessage%3A%20tm-open-external-window if empty]] |
|paramObject |Optional: Hashmap of variables that will be provided to the window. see below |

''parmObject''
Expand All @@ -25,7 +25,7 @@ The `tm-open-external-window` message is usually generated with the ButtonWidget

<$macrocall $name='wikitext-example-without-html'
src='<$button>
<$action-sendmessage $message="tm-open-external-window" $param="http://tiddlywiki.com" windowName="_tiddlywiki" windowFeatures="height=500, width=900"/>
<$action-sendmessage $message="tm-open-external-window" $param="https://tiddlywiki.com" windowName="_tiddlywiki" windowFeatures="height=500, width=900"/>
Open ~TiddlyWiki - Action
</$button>

Expand All @@ -34,6 +34,6 @@ Open ~TiddlyWiki - Action
Open Mozilla Help - Action
</$button>

<$button message="tm-open-external-window" param="http://tiddlywiki.com" >
<$button message="tm-open-external-window" param="https://tiddlywiki.com" >
Open ~TiddlyWiki - Button
</$button>'/>
47 changes: 40 additions & 7 deletions editions/tw5.com/tiddlers/nodejs/Serving TW5 from Android.tid
Original file line number Diff line number Diff line change
@@ -1,13 +1,46 @@
created: 20160602043529506
modified: 20160602043531313
tags: [[TiddlyWiki on Node.js]]
caption: Node.js on Termux
created: 20200501120322327
delivery: App with DIY steps
description: Using Node.js to serve/create flatfile wikis
method: sync
modified: 20200501120801899
tags: Saving [[TiddlyWiki on Node.js]] Android
title: Serving TW5 from Android
type: text/vnd.tiddlywiki

[[Termux|https://termux.com/]] is an open source Android application that combines a Linux system and a terminal.
[[Termux|https://termux.com/]] is and open source android application providing limited Unix environment enabling users to install [[Node.js]] and npm modules in android. Users can install and run [[TiddlyWiki on Node.js]] using [[Termux|https://termux.com/]].

Once you open //Termux// on your Android system, it is straightforward to [[install|Installing TiddlyWiki on Node.js]] and [[run|Using TiddlyWiki on Node.js]] the [[Node.js flavour of TiddlyWiki|TiddlyWiki on Node.js]] from the command line.
!! Instructions

From then on, as long as //Termux// is not closed, you may access your wiki anytime from your favourite Web browser pointing on the expected address and port.
* Download and install Termux from [[Google Play Store|https://play.google.com/store/apps/details?id=com.termux]] or [[Fdroid|https://f-droid.org/en/packages/com.termux/]]
* Open termux and run the following commands one by one

> __note to contributors__: in //Termux//, you may as well install //git//, //emacs// or //vi//, in order to edit and maintain individual tiddler files. This would probably require that you also attach a more powerful keyboard to your Android, like the [[Hacker's Keyboard|https://github.com/klausw/hackerskeyboard/]] application or a Bluetooth external device.
```bash
apt update
apt upgrade
apt install nodejs
npm install -g tiddlywiki
```

* If you need to create/serve ''~TiddlyWiki on Node.js'' from the internal storage, you need to give termux storage permission by running the following command in termux

```
termux-setup-storage
```

* Now you can create and serve ''~TiddlyWiki on Node.js'' from internal storage. In the example given below, user is creating a new wiki called "mynewwiki" in his internal folder.

```
cd storage/shared
tiddlywiki mynewwiki --init server
tiddlywiki mynewwiki --listen
```
* Visit http://127.0.0.1:8080/ in your browser
* From then on, as long as //Termux// is not closed, you may access your wiki anytime from your favourite Web browser pointing on the expected address and port.

---

* For more information regarding ~TiddlyWiki on Node.js, please see [[Installing TiddlyWiki on Node.js]]
* For more information and tips regarding termux, please refer to [[Termux wiki|https://wiki.termux.com/wiki/Main_Page]]

<<.tip "In //Termux//, you may as well install //git//, //emacs// or //vi//, in order to edit and maintain individual tiddler files. This would probably require that you also attach a more powerful keyboard to your Android, like the [[Hacker's Keyboard|https://github.com/klausw/hackerskeyboard/]] application or a Bluetooth external device.">>
Loading

0 comments on commit 31c4fd5

Please sign in to comment.