mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-23 18:17:20 +00:00
parent
494ee984f8
commit
0ee53bbc01
@ -1,6 +1,6 @@
|
|||||||
title: HelloThere
|
title: HelloThere
|
||||||
|
|
||||||
This is a demo of TiddlyWiki5 incorporating a plugin for the [[D3.js]] visualization library.
|
This is a demo of TiddlyWiki5 incorporating a plugin for the [[D3.js]] visualisation library.
|
||||||
|
|
||||||
! Word Cloud
|
! Word Cloud
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ sectionnumber: 2
|
|||||||
tags: section doc
|
tags: section doc
|
||||||
title: Microkernel Architecture
|
title: Microkernel Architecture
|
||||||
|
|
||||||
This section describes the architecture of the ~TiddlyWiki-kernel. ~TiddlyWiki is based on a micro-kernel which provides only a small stack of functions. This design decision was made to introduce a cleaner mechanism for customization of ~TiddlyWiki. This section also describes the data-model of ~TiddlyWiki called tiddler. And it gives a overview to the modul system which developers can use to extend the functionality of the ~TiddlyWiki application.
|
This section describes the architecture of the ~TiddlyWiki-kernel. ~TiddlyWiki is based on a micro-kernel which provides only a small stack of functions. This design decision was made to introduce a cleaner mechanism for customisation of ~TiddlyWiki. This section also describes the data-model of ~TiddlyWiki called tiddler. And it gives a overview to the module system which developers can use to extend the functionality of the ~TiddlyWiki application.
|
||||||
|
|
||||||
<$list filter="[!has[draft.of]has[chapter.of]chapter.of[Microkernel Architecture]tag[doc]sort[sub.num]]">
|
<$list filter="[!has[draft.of]has[chapter.of]chapter.of[Microkernel Architecture]tag[doc]sort[sub.num]]">
|
||||||
|
|
||||||
|
@ -5,6 +5,6 @@ sub.num: 3
|
|||||||
tags: doc
|
tags: doc
|
||||||
title: Syncadaptor
|
title: Syncadaptor
|
||||||
|
|
||||||
A module with ``module-type: syncadaptor`` provides functionality to get a list of tiddlers (this list is provided as ~SkinnyTiddlers, which are normal tiddlers without the text field) and to load, save and delete single tiddlers. A syncadaptor can also provide functions to login and logout so that syncadaptor modules can be used to synchronize tiddlers with a remote server.
|
A module with ``module-type: syncadaptor`` provides functionality to get a list of tiddlers (this list is provided as ~SkinnyTiddlers, which are normal tiddlers without the text field) and to load, save and delete single tiddlers. A syncadaptor can also provide functions to login and logout so that syncadaptor modules can be used to synchronise tiddlers with a remote server.
|
||||||
|
|
||||||
The syncer module only uses one syncadaptor and honours a special [[system tiddler|System Tiddlers]] [[$:/config/SyncFilter]] containing a [[filter string|Tags and Filter Mechanism]]. Tiddlers matching this filter string are saved to the server with a syncadapter. It uses the [[WebServer API|https://tiddlywiki.com/#WebServer%20API%3A%20Get%20All%20Tiddlers]] to load modified tiddlers from the server, which returns only non-system tiddlers.
|
The syncer module only uses one syncadaptor and honours a special [[system tiddler|System Tiddlers]] [[$:/config/SyncFilter]] containing a [[filter string|Tags and Filter Mechanism]]. Tiddlers matching this filter string are saved to the server with a syncadapter. It uses the [[WebServer API|https://tiddlywiki.com/#WebServer%20API%3A%20Get%20All%20Tiddlers]] to load modified tiddlers from the server, which returns only non-system tiddlers.
|
||||||
|
@ -27,10 +27,10 @@ On a different level, a tiddler is also the basic unit of work for the wiki user
|
|||||||
This makes sense for multiple reasons:
|
This makes sense for multiple reasons:
|
||||||
Because the UI of TiddlyWiki is build from tiddlers, the wiki user is able to edit the interface of his own TiddlyWiki just by editing a wiki page.
|
Because the UI of TiddlyWiki is build from tiddlers, the wiki user is able to edit the interface of his own TiddlyWiki just by editing a wiki page.
|
||||||
For example to add a list of tiddler links to the sidebar, the user just needs to create a new tiddler, put the links into this tiddler and tag this tiddler with ``$:/tags/SideBar``.
|
For example to add a list of tiddler links to the sidebar, the user just needs to create a new tiddler, put the links into this tiddler and tag this tiddler with ``$:/tags/SideBar``.
|
||||||
This way the user can customize his work environment just by using mechanisms he already uses to manage his wiki pages.
|
This way the user can customise his work environment just by using mechanisms he already uses to manage his wiki pages.
|
||||||
Tiddlers consist of fields. When using a tiddler as wiki page, the user can use these fields to store meta information, like tags.
|
Tiddlers consist of fields. When using a tiddler as wiki page, the user can use these fields to store meta information, like tags.
|
||||||
|
|
||||||
Because fields for metadata and especially tags are an easy way for the user to organize his wiki pages, TiddlyWiki provides a special filter mechanism to choose tiddlers using their metadata.
|
Because fields for metadata and especially tags are an easy way for the user to organise his wiki pages, TiddlyWiki provides a special filter mechanism to choose tiddlers using their metadata.
|
||||||
A filter string like ``[tag[learncard]topic[math]!tag[successful]]`` would filter all tiddlers tagged with "learncard", with the value "math" in the topic-field and are not tagged with "successful".
|
A filter string like ``[tag[learncard]topic[math]!tag[successful]]`` would filter all tiddlers tagged with "learncard", with the value "math" in the topic-field and are not tagged with "successful".
|
||||||
A user could use this filter together with the ``<$list>`` widget to display a list of all math learncards which are not yet answered successfully in a wiki page.
|
A user could use this filter together with the ``<$list>`` widget to display a list of all math learncards which are not yet answered successfully in a wiki page.
|
||||||
|
|
||||||
|
@ -23,7 +23,7 @@ The boot kernel includes:
|
|||||||
* Several short shared utility functions
|
* Several short shared utility functions
|
||||||
* A handful of methods implementing the module mechanism
|
* A handful of methods implementing the module mechanism
|
||||||
* The `$tw.Tiddler` class (and field definition plugins)
|
* The `$tw.Tiddler` class (and field definition plugins)
|
||||||
* The `$tw.Wiki` class (and tiddler deserialization methods)
|
* The `$tw.Wiki` class (and tiddler deserialisation methods)
|
||||||
* Code for the browser to load tiddlers from the HTML DOM
|
* Code for the browser to load tiddlers from the HTML DOM
|
||||||
* Code for the server to load tiddlers from the file system
|
* Code for the server to load tiddlers from the file system
|
||||||
|
|
||||||
|
@ -15,7 +15,7 @@ You can have multiple template tiddlers that use the same input and options tidd
|
|||||||
|
|
||||||
!!Display tiddler
|
!!Display tiddler
|
||||||
|
|
||||||
This is the container used to display the section in the résumé itself, there isn't any customization here.
|
This is the container used to display the section in the résumé itself, there isn't any customisation here.
|
||||||
|
|
||||||
''Required tags'': `Section Display`<br>
|
''Required tags'': `Section Display`<br>
|
||||||
''Required name format'': `$:/display/(section name) Display`<br>
|
''Required name format'': `$:/display/(section name) Display`<br>
|
||||||
|
@ -268,7 +268,7 @@ describe("Widget module", function() {
|
|||||||
expect(wrapper.innerHTML).toBe("<p>Happy Result</p>");
|
expect(wrapper.innerHTML).toBe("<p>Happy Result</p>");
|
||||||
|
|
||||||
// This is important. $Let needs to be aware enough not to let its
|
// This is important. $Let needs to be aware enough not to let its
|
||||||
// own variables interfere with its ability to recognize no change.
|
// own variables interfere with its ability to recognise no change.
|
||||||
// Doesn't matter that nothing has changed, we just need to make sure
|
// Doesn't matter that nothing has changed, we just need to make sure
|
||||||
// it recognizes that that its outward facing variables are unchanged
|
// it recognizes that that its outward facing variables are unchanged
|
||||||
// EVEN IF some intermediate variables did change, there's no need to
|
// EVEN IF some intermediate variables did change, there's no need to
|
||||||
|
@ -10,7 +10,7 @@ A adaptation of TiddlyWiki perfect for using as a Notebook sysetem.
|
|||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
<<<
|
<<<
|
||||||
Drift is an adaptation of TiddlyWiki with the goal of helping you Collect. Organize. and Grow. your ideas while keeping tab on how they interconnect together and fluidly Drift from one to another.
|
Drift is an adaptation of TiddlyWiki with the goal of helping you Collect. Organise. and Grow. your ideas while keeping tab on how they interconnect together and fluidly Drift from one to another.
|
||||||
|
|
||||||
The 2 main components of Drift are TWCrosslinks and DailyNotes so you never miss an idea
|
The 2 main components of Drift are TWCrosslinks and DailyNotes so you never miss an idea
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ title: "Noteself" by Danielo Rodríguez
|
|||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
url: https://noteself.github.io/
|
url: https://noteself.github.io/
|
||||||
|
|
||||||
~NoteSelf is your personal, private, customizable, Evernote-like experience.
|
~NoteSelf is your personal, private, customisable, Evernote-like experience.
|
||||||
You want cloud? Fine! You don't? Fine too! It's all yours, It's your decision!
|
You want cloud? Fine! You don't? Fine too! It's all yours, It's your decision!
|
||||||
Why not be a bit selfish?
|
Why not be a bit selfish?
|
||||||
|
|
||||||
@ -26,9 +26,9 @@ You already know and love Evernote, we know it. It is comfortable, it syncs, has
|
|||||||
Wow, it's almost perfect, but what about:
|
Wow, it's almost perfect, but what about:
|
||||||
|
|
||||||
* Privacy - Everything is stored on the Evernote's servers!
|
* Privacy - Everything is stored on the Evernote's servers!
|
||||||
* Customization - If you don't like the interface of Evernote, there's nothing you can do
|
* Customisation - If you don't like the interface of Evernote, there's nothing you can do
|
||||||
|
|
||||||
~NoteSelf is built on top of ~TiddlyWiki, a powerful, free, highly customizable and open-source personal wiki.
|
~NoteSelf is built on top of ~TiddlyWiki, a powerful, free, highly customisable and open-source personal wiki.
|
||||||
We took the best of it, it's powerful customization system, and mixed it with one of the best
|
We took the best of it, it's powerful customisation system, and mixed it with one of the best
|
||||||
embedded databases available, [[PouchDb|http://www.pouchdb.com]], for bringing the synchronization capabilities you need.
|
embedded databases available, [[PouchDb|http://www.pouchdb.com]], for bringing the synchronisation capabilities you need.
|
||||||
<<<
|
<<<
|
||||||
|
@ -11,7 +11,7 @@ A thesis notebook based on TiddlyWiki.
|
|||||||
<<<
|
<<<
|
||||||
This is an example of a thesis notebook powered by TiddlyWiki 5.0.8-beta.
|
This is an example of a thesis notebook powered by TiddlyWiki 5.0.8-beta.
|
||||||
|
|
||||||
TiddlyWiki is a great piece of software created by Jeremy Ruston. It allows you, among other things, to take notes, organize ideas, store information, and display all your stuff the way you want. It is an incredibly flexible tool you can adapt to fit almost all your needs.
|
TiddlyWiki is a great piece of software created by Jeremy Ruston. It allows you, among other things, to take notes, organise ideas, store information, and display all your stuff the way you want. It is an incredibly flexible tool you can adapt to fit almost all your needs.
|
||||||
|
|
||||||
This TiddlyWiki has been customized to serve as a philosophy notebook centered around authors, books and papers, concepts and theories, and personal notes. I use it along with Zotero, which is a dedicated bibliography software. Both are free, open source projects. TiddlyWiki can be downloaded at https://tiddlywiki.com.
|
This TiddlyWiki has been customized to serve as a philosophy notebook centered around authors, books and papers, concepts and theories, and personal notes. I use it along with Zotero, which is a dedicated bibliography software. Both are free, open source projects. TiddlyWiki can be downloaded at https://tiddlywiki.com.
|
||||||
<<<
|
<<<
|
||||||
|
@ -12,11 +12,11 @@ A collection of plugins from TheDiveO.
|
|||||||
[[TheDiveO's Third Flow|http://thediveo.github.io/ThirdFlow/]] plugin construction system:
|
[[TheDiveO's Third Flow|http://thediveo.github.io/ThirdFlow/]] plugin construction system:
|
||||||
|
|
||||||
<<<
|
<<<
|
||||||
The ~ThirdFlow plugin brings to you another way to develop customization plugins for TiddlyWiki 5. It is not enforcing a specific development flow, it simply tries to help you. Otherwise, it tries to stay out of your way.
|
The ~ThirdFlow plugin brings to you another way to develop customisation plugins for TiddlyWiki 5. It is not enforcing a specific development flow, it simply tries to help you. Otherwise, it tries to stay out of your way.
|
||||||
<<<
|
<<<
|
||||||
|
|
||||||
[[TheDiveO's FontAwesome|http://thediveo.github.io/TW5FontAwesome/]] plugin:
|
[[TheDiveO's FontAwesome|http://thediveo.github.io/TW5FontAwesome/]] plugin:
|
||||||
|
|
||||||
<<<
|
<<<
|
||||||
The FontAwesome plugin supports embedding Font Awesome in TiddlyWiki 5. There is no need to install this font into your operating system in order to use it with TiddlyWiki 5. The font is already embedded in this TiddlyWiki 5 customization plugin instead, so nothing else to install.
|
The FontAwesome plugin supports embedding Font Awesome in TiddlyWiki 5. There is no need to install this font into your operating system in order to use it with TiddlyWiki 5. The font is already embedded in this TiddlyWiki 5 customisation plugin instead, so nothing else to install.
|
||||||
<<<
|
<<<
|
||||||
|
@ -9,7 +9,7 @@ Shiraz plugin is a very small in size and framework to create stylish contents i
|
|||||||
|
|
||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
Shiraz plugin contains extended markups, macros, styles, and many customization to empty Tiddlywiki and can be used as a ''starter kit''.
|
Shiraz plugin contains extended markups, macros, styles, and many customisation to empty Tiddlywiki and can be used as a ''starter kit''.
|
||||||
|
|
||||||
Some of Shiraz features are:
|
Some of Shiraz features are:
|
||||||
|
|
||||||
@ -18,7 +18,7 @@ Some of Shiraz features are:
|
|||||||
* Sortable tables
|
* Sortable tables
|
||||||
* Display on demand, slider, and details
|
* Display on demand, slider, and details
|
||||||
* Images, basic image macros, slidein, and overlay images, polaroid and pretty images
|
* Images, basic image macros, slidein, and overlay images, polaroid and pretty images
|
||||||
* Table customization tools
|
* Table customisation tools
|
||||||
* Sticky footer
|
* Sticky footer
|
||||||
* Multi columns tiddler
|
* Multi columns tiddler
|
||||||
* Multi column story river
|
* Multi column story river
|
||||||
|
@ -11,8 +11,8 @@ An interactive network visualisation plugin based on [[Vis.js|http://visjs.org]]
|
|||||||
~TiddlyMap is a TiddlyWiki plugin that allows you to link your wiki-topics (tiddlers) in order to create clickable graphs. By creating relations between your topics you can easily do the following:
|
~TiddlyMap is a TiddlyWiki plugin that allows you to link your wiki-topics (tiddlers) in order to create clickable graphs. By creating relations between your topics you can easily do the following:
|
||||||
|
|
||||||
* Create concept maps and quickly manifest your ideas in tiddlers.
|
* Create concept maps and quickly manifest your ideas in tiddlers.
|
||||||
* Create task-dependency graphs to organize and describe your tasks.
|
* Create task-dependency graphs to organise and describe your tasks.
|
||||||
* Visualize your topic structures to get an immediate grasp of topics and relations.
|
* Visualise your topic structures to get an immediate grasp of topics and relations.
|
||||||
|
|
||||||
In general you may create, visualize and describe any network-structure you have in mind.
|
In general you may create, visualise and describe any network-structure you have in mind.
|
||||||
<<<
|
<<<
|
||||||
|
@ -10,5 +10,5 @@ An early release of an edition of TiddlyWiki customised for rigorous, academic n
|
|||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
<<<
|
<<<
|
||||||
TiddlyWiki for Scholars is a personal customization of TiddlyWiki 5.0.13-beta I made for note-taking from readings, but it can be useful for other purposes. The idea behind this adaptation is to show and to allow creating relevant data related to the current tiddler without leaving the tiddler.
|
TiddlyWiki for Scholars is a personal customisation of TiddlyWiki 5.0.13-beta I made for note-taking from readings, but it can be useful for other purposes. The idea behind this adaptation is to show and to allow creating relevant data related to the current tiddler without leaving the tiddler.
|
||||||
<<<
|
<<<
|
||||||
|
@ -13,4 +13,4 @@ Tiddlyshow contains the following features
|
|||||||
|
|
||||||
* Tools for preparing slides
|
* Tools for preparing slides
|
||||||
* Shortcut keys for navigation (forward and backward)
|
* Shortcut keys for navigation (forward and backward)
|
||||||
* Themes to colorify and customize the slideshow
|
* Themes to colorify and customise the slideshow
|
||||||
|
@ -9,6 +9,6 @@ Todolist is a small pure wikitext plugin, contain all tools to work with todo l
|
|||||||
|
|
||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
With Todolist, easily organize and prioritize your tasks and projects so you’ll always know exactly what to work on next.
|
With Todolist, easily organise and prioritise your tasks and projects so you’ll always know exactly what to work on next.
|
||||||
|
|
||||||
Todolist creates custom UI and lets you to add new items, set priority, done/undone items, archive, delete. Using Todolist plugin it is possible to create several todo lists in one Tiddlywiki.
|
Todolist creates custom UI and lets you to add new items, set priority, done/undone items, archive, delete. Using Todolist plugin it is possible to create several todo lists in one Tiddlywiki.
|
||||||
|
@ -5,7 +5,7 @@ title: "Slides and Stories" by Jan
|
|||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
url: http://slidesnstories.tiddlyspot.com
|
url: http://slidesnstories.tiddlyspot.com
|
||||||
|
|
||||||
Slides and Stories is a repository of the tools to optimize TW for scientific research and for presenting and publishing results.
|
Slides and Stories is a repository of the tools to optimise TW for scientific research and for presenting and publishing results.
|
||||||
|
|
||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
|
@ -5,14 +5,14 @@ title: Semantic Colors by Mohammad
|
|||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
url: https://kookma.github.io/TW-Semantic-Colors/
|
url: https://kookma.github.io/TW-Semantic-Colors/
|
||||||
|
|
||||||
Semantic colors are set of CSS to apply colorful theme to individual tiddlers for categorization purpose.
|
Semantic colors are set of CSS to apply colorful theme to individual tiddlers for categorisation purpose.
|
||||||
|
|
||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
Tiddlywiki "semantic colors" has two objectives:
|
Tiddlywiki "semantic colors" has two objectives:
|
||||||
|
|
||||||
# How it is simply possible to apply theme to an individual tiddler
|
# How it is simply possible to apply theme to an individual tiddler
|
||||||
# Use semantic colors for categorization
|
# Use semantic colors for categorisation
|
||||||
|
|
||||||
;Some use cases
|
;Some use cases
|
||||||
:Learning materials (each topic, category can have dedicated semantic color, like learning a foreign language)
|
:Learning materials (each topic, category can have dedicated semantic color, like learning a foreign language)
|
||||||
|
@ -20,7 +20,7 @@ I've been using TiddlyWiki5 with Google Firebase for over a year now. It's stabl
|
|||||||
|
|
||||||
Please consider this version a proof of concept rather than a polished product! My focus was on multi-device or small-team collaboration:
|
Please consider this version a proof of concept rather than a polished product! My focus was on multi-device or small-team collaboration:
|
||||||
|
|
||||||
* Basic authorization (bags have an access policy determining who can read / write them).
|
* Basic authorisation (bags have an access policy determining who can read / write them).
|
||||||
* Multiple wikis can be hosted under a single firebase account.
|
* Multiple wikis can be hosted under a single firebase account.
|
||||||
* It uses Firebase's built-in social auth to log in users.
|
* It uses Firebase's built-in social auth to log in users.
|
||||||
* Tiddlers are written individually with locking, preventing users overwriting each others' updates.
|
* Tiddlers are written individually with locking, preventing users overwriting each others' updates.
|
||||||
|
@ -18,7 +18,7 @@ An extension to the Node.js configuration of TiddlyWiki that adds support for st
|
|||||||
<<<
|
<<<
|
||||||
TiddlyServer 2.0 takes the server command of TiddlyWiki on NodeJS and adds it to a static file server. This means you can load and serve any TiddlyWiki data folder in the same way you can serve a single file TiddlyWiki.
|
TiddlyServer 2.0 takes the server command of TiddlyWiki on NodeJS and adds it to a static file server. This means you can load and serve any TiddlyWiki data folder in the same way you can serve a single file TiddlyWiki.
|
||||||
|
|
||||||
But you don't need to serve files and folders from just one place, you can serve them from multiple places anywhere on your harddrive (literally anywhere NodeJS can stat, readdir, and readFile). You can even organize them into virtual folders (aka aliases in Apache and mounts in Express).
|
But you don't need to serve files and folders from just one place, you can serve them from multiple places anywhere on your harddrive (literally anywhere NodeJS can stat, readdir, and readFile). You can even organise them into virtual folders (aka aliases in Apache and mounts in Express).
|
||||||
|
|
||||||
The main point, of course, is that you can actually edit your files, not just look at them. Single file TiddlyWikis use the put saver, which needs to be patched using a bookmarklet included on the index page. The instructions for this are below under the heading "One thing that needs to be noted".
|
The main point, of course, is that you can actually edit your files, not just look at them. Single file TiddlyWikis use the put saver, which needs to be patched using a bookmarklet included on the index page. The instructions for this are below under the heading "One thing that needs to be noted".
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ title: "Dropboard" by Reid Gould
|
|||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
url: https://github.com/reidgould/tiddlywiki-dropboard
|
url: https://github.com/reidgould/tiddlywiki-dropboard
|
||||||
|
|
||||||
A TiddlyWiki plugin for kanban-like organization in the style of Trello™ using boards, lists, and cards.
|
A TiddlyWiki plugin for kanban-like organisation in the style of Trello™ using boards, lists, and cards.
|
||||||
|
|
||||||
{{!!url}}
|
{{!!url}}
|
||||||
|
|
||||||
|
@ -3,4 +3,4 @@ tags: Concepts
|
|||||||
|
|
||||||
Groups of uniquely titled tiddlers are contained in WikiStore objects.
|
Groups of uniquely titled tiddlers are contained in WikiStore objects.
|
||||||
|
|
||||||
The WikiStore also manages the plugin modules used for widgets, and operations like serializing, deserializing, parsing and rendering tiddlers.
|
The WikiStore also manages the plugin modules used for widgets, and operations like serialising, deserialising, parsing and rendering tiddlers.
|
||||||
|
@ -6,7 +6,7 @@ type: text/vnd.tiddlywiki
|
|||||||
|
|
||||||
Modals (or "wizards") fade the main TiddlyWiki window to display an isolated tiddler that must be explicitly dismissed by the user.
|
Modals (or "wizards") fade the main TiddlyWiki window to display an isolated tiddler that must be explicitly dismissed by the user.
|
||||||
|
|
||||||
The tiddler to be displayed can contain the following optional fields that are used to customize the modal:
|
The tiddler to be displayed can contain the following optional fields that are used to customise the modal:
|
||||||
|
|
||||||
|!Field |!Description |
|
|!Field |!Description |
|
||||||
|footer|The footer text for the modal|
|
|footer|The footer text for the modal|
|
||||||
|
@ -12,7 +12,7 @@ type: text/vnd.tiddlywiki
|
|||||||
|
|
||||||
The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core.
|
The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core.
|
||||||
|
|
||||||
[[Fields within the tiddler|Modals]] being displayed in the modal can be used to customize its appearance.
|
[[Fields within the tiddler|Modals]] being displayed in the modal can be used to customise its appearance.
|
||||||
|
|
||||||
!! paramObject
|
!! paramObject
|
||||||
|
|
||||||
|
@ -52,7 +52,7 @@ Directory specifications in the `directories` array may take the following forms
|
|||||||
** ''filesRegExp'' - (optional) a [[regular expression|https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions]] that matches the filenames of the files that should be processed within the directory
|
** ''filesRegExp'' - (optional) a [[regular expression|https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions]] that matches the filenames of the files that should be processed within the directory
|
||||||
** ''isTiddlerFile'' - (required) if `true`, the file will be treated as a [[tiddler file|TiddlerFiles]] and deserialised to extract the tiddlers. Otherwise, the raw content of the file is assigned to the `text` field without any parsing
|
** ''isTiddlerFile'' - (required) if `true`, the file will be treated as a [[tiddler file|TiddlerFiles]] and deserialised to extract the tiddlers. Otherwise, the raw content of the file is assigned to the `text` field without any parsing
|
||||||
** ''isEditableFile'' - <<.from-version "5.1.23">> (optional) if `true`, changes to the tiddler be saved back to the original file. The tiddler will be saved back to the original filepath as long as it does not generate a result from the $:/config/FileSystemPath filters, which will override the final filepath generated if a result is returned from a filter.
|
** ''isEditableFile'' - <<.from-version "5.1.23">> (optional) if `true`, changes to the tiddler be saved back to the original file. The tiddler will be saved back to the original filepath as long as it does not generate a result from the $:/config/FileSystemPath filters, which will override the final filepath generated if a result is returned from a filter.
|
||||||
** ''searchSubdirectories'' - <<.from-version "5.1.23">> (optional) if `true`, all subdirectories of the //path// are searched recursively for files that match the (optional) //filesRegExp//. If no //filesRegExp// is provided, all files in all subdirectoies of the //path// are loaded. Tiddler titles generated via a //source// attribute (see above) will only include the filename, not any of the subdirectories of the path. If this results in multiple files with loaded with the same tiddler title, then only the last file loaded under that tiddler title will be in memory. In order to prevent this, you must have multiple directory objects listed and customize the title field with a //prefix// or //suffix// alongside the //source// attribute.
|
** ''searchSubdirectories'' - <<.from-version "5.1.23">> (optional) if `true`, all subdirectories of the //path// are searched recursively for files that match the (optional) //filesRegExp//. If no //filesRegExp// is provided, all files in all subdirectories of the //path// are loaded. Tiddler titles generated via a //source// attribute (see above) will only include the filename, not any of the subdirectories of the path. If this results in multiple files with loaded with the same tiddler title, then only the last file loaded under that tiddler title will be in memory. In order to prevent this, you must have multiple directory objects listed and customise the title field with a //prefix// or //suffix// alongside the //source// attribute.
|
||||||
** ''fields'' - (required) an object containing values that override or customise the fields provided in the tiddler file (see above)
|
** ''fields'' - (required) an object containing values that override or customise the fields provided in the tiddler file (see above)
|
||||||
|
|
||||||
Fields can also be overridden for particular files by creating a file with the same name plus the suffix `.meta` -- see TiddlerFiles.
|
Fields can also be overridden for particular files by creating a file with the same name plus the suffix `.meta` -- see TiddlerFiles.
|
||||||
|
@ -26,7 +26,7 @@ tiddlywiki YOUR_WIKI_FOLDER --listen 'root-tiddler=$:/core/save/all-external-js'
|
|||||||
|
|
||||||
<<.tip """On Windows, Command Prompt (CMD) users need to replace single quotes `'` with double quotation marks `"`.""">>
|
<<.tip """On Windows, Command Prompt (CMD) users need to replace single quotes `'` with double quotation marks `"`.""">>
|
||||||
|
|
||||||
!! Initializing a new wiki
|
!! Initialising a new wiki
|
||||||
|
|
||||||
The provided edition `server-external-js` contains all the configuration necessary to use the external ~JavaScript template. Here is an example:
|
The provided edition `server-external-js` contains all the configuration necessary to use the external ~JavaScript template. Here is an example:
|
||||||
|
|
||||||
@ -37,10 +37,10 @@ tiddlywiki ./myNewWiki --build listen
|
|||||||
|
|
||||||
The above commands perform the following:
|
The above commands perform the following:
|
||||||
|
|
||||||
* Create a new wiki with external JavaScript customization included.
|
* Create a new wiki with external JavaScript customisation included.
|
||||||
* Start the server with external ~JavaScript enabled. The server listens on port 8080. Visit http://localhost:8080 in your browser.
|
* Start the server with external ~JavaScript enabled. The server listens on port 8080. Visit http://localhost:8080 in your browser.
|
||||||
|
|
||||||
To customize your `--build listen` command, see [[tiddlywiki.info Files]] and [[ListenCommand]].
|
To customise your `--build listen` command, see [[tiddlywiki.info Files]] and [[ListenCommand]].
|
||||||
|
|
||||||
! Using the external ~JavaScript template with the single file configuration
|
! Using the external ~JavaScript template with the single file configuration
|
||||||
|
|
||||||
@ -52,7 +52,7 @@ You can use the "external-js" template with your single file wiki, but this requ
|
|||||||
|
|
||||||
If you start your ~TiddlyWiki server in the "external-js" configuration, snapshots you save from the wiki will also have the external-js configuration.
|
If you start your ~TiddlyWiki server in the "external-js" configuration, snapshots you save from the wiki will also have the external-js configuration.
|
||||||
|
|
||||||
You can click on the "cloud" button and choose <<.icon $:/core/images/download-button>> ''Save snapshot for offline use''. The html wiki you saved will have a reduced file size compared to a regular snapshot because the ~TiddlyWiki core code has been externalized. However, to be able to use this wiki, you ''must'' also have a copy of ~TiddlyWiki's core ~JavaScript in the same directory; see below for instructions for obtaining it
|
You can click on the "cloud" button and choose <<.icon $:/core/images/download-button>> ''Save snapshot for offline use''. The html wiki you saved will have a reduced file size compared to a regular snapshot because the ~TiddlyWiki core code has been externalised. However, to be able to use this wiki, you ''must'' also have a copy of ~TiddlyWiki's core ~JavaScript in the same directory; see below for instructions for obtaining it
|
||||||
|
|
||||||
The "server-external-js" edition lets you save the snapshot from the command line:
|
The "server-external-js" edition lets you save the snapshot from the command line:
|
||||||
|
|
||||||
|
@ -4,5 +4,5 @@ tags: [[WebServer Authentication]]
|
|||||||
title: WebServer Anonymous Access
|
title: WebServer Anonymous Access
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
Anonymous access is only permitted if the special ''(anon)'' token is present in the [[readers|WebServer Parameter: readers]] (for reading) and optionally [[writers|WebServer Parameter: writers]] (for writing) authorization parameters.
|
Anonymous access is only permitted if the special ''(anon)'' token is present in the [[readers|WebServer Parameter: readers]] (for reading) and optionally [[writers|WebServer Parameter: writers]] (for writing) authorisation parameters.
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ type: text/vnd.tiddlywiki
|
|||||||
The [[web server configuration parameter|WebServer Parameters]] ''username'', in conjunction with its companion [[password|WebServer Parameter: password]]:
|
The [[web server configuration parameter|WebServer Parameters]] ''username'', in conjunction with its companion [[password|WebServer Parameter: password]]:
|
||||||
|
|
||||||
* Enables [[Basic Authentication|WebServer Basic Authentication]] with the specified username/password combination being added to any credentials specified with the [[credentials|WebServer Parameter: credentials]] parameter
|
* Enables [[Basic Authentication|WebServer Basic Authentication]] with the specified username/password combination being added to any credentials specified with the [[credentials|WebServer Parameter: credentials]] parameter
|
||||||
* The specified username is used as a default value for the [[readers|WebServer Parameter: readers]] and [[writers|WebServer Parameter: writers]] authorization parameters if they are not specified
|
* The specified username is used as a default value for the [[readers|WebServer Parameter: readers]] and [[writers|WebServer Parameter: writers]] authorisation parameters if they are not specified
|
||||||
|
|
||||||
!! Examples
|
!! Examples
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user