mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-24 22:33:16 +00:00
Code Issues Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jermolene 2016-01-07 23:00:38 +00:00
parent 334497ce4e
commit 5109e96cec
19 changed files with 121 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
editions/tw5.com/tiddlers/demonstrations/SampleAlert.tid
View File

@ -1,6 +0,0 @@
title: SampleAlert
component: demo
This is a demonstration alert.
Note that the trashcan icon deletes the tiddler containing this alert. You can also remove it by opening the tiddler SampleAlert and editing it to remove the tag [[$:/tags/Alert]].

4
editions/tw5.com/tiddlers/editions/Editions.tid
View File

@ -1,6 +1,6 @@
created: 20140908125500000
list: [[Empty Edition]]
modified: 20160107211902478
modified: 20160107222125923
tags: TableOfContents
title: Editions
type: text/vnd.tiddlywiki
@ -13,4 +13,4 @@ You can mix and match the components of these editions, to make a unique solutio
<<list-links "[tag[Editions]]">>
<$macrocall $name=".tip" _="""Note that editions should not be confused with the [[platforms|Platforms]] on which TiddlyWiki runs (eg as a [[single HTML file|Saving]] vs. [[under Node.js|TiddlyWiki on Node.js]]"""/>
<$macrocall $name=".tip" _="""Note that editions should not be confused with the [[platforms|Platforms]] on which TiddlyWiki runs (eg as a [[single HTML file|Saving]] vs. [[under Node.js|TiddlyWiki on Node.js]])"""/>

16
editions/tw5.com/tiddlers/features/Features.tid
View File

@ -1,23 +1,11 @@
created: 20130822172800000
modified: 20140920143945484
modified: 20160107225826644
tags: TableOfContents
title: Features
type: text/vnd.tiddlywiki
\define alert-demo()
<$fieldmangler tiddler="SampleAlert"><$set name="currentTiddler" value="SampleAlert"><$button message="tm-add-tag" param="$:/tags/Alert">alerts</$button></$set></$fieldmangler>
\end
Further information about specific TiddlyWiki features:
<<list-links "[tag[Features]]">>
----
* Familiar user interface elements like <<alert-demo>>, <$button message="tm-modal" param="SampleWizard">wizards</$button> and <$button message="tm-notify" param="SampleNotification">notifications</$button>
* Try out the <$button message="tm-full-screen">full screen support</$button>
* Explore the [[D3.js visualisation plugin|http://tiddlywiki.com/plugins/tiddlywiki/d3/index.html]]
* [[CodeMirror support via a plugin|http://tiddlywiki.com/plugins/tiddlywiki/codemirror/index.html]]
* [[Markdown support via a plugin|http://tiddlywiki.com/plugins/tiddlywiki/markdown/index.html]]
* [[Classic TiddlyWiki markup support via a plugin|http://tiddlywiki.com/plugins/tiddlywiki/tw2parser/index.html]]
* Last but not least, TiddlyWiki is a rare example of a practical [[quine|Quine]]
Last but not least, TiddlyWiki is a rare example of a practical [[quine|Quine]]

11
editions/tw5.com/tiddlers/features/Modals.tid Normal file
View File

@ -0,0 +1,11 @@
created: 20160107225427489
modified: 20160107225651558
tags: Features
title: Modals
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 are displayed with the [[WidgetMessage: tm-modal]].
<$button message="tm-modal" param="SampleWizard">Open demo modal</$button>

9
editions/tw5.com/tiddlers/features/Notifications.tid Normal file
View File

@ -0,0 +1,9 @@
created: 20160107225753340
modified: 20160107225855353
tags: Features
title: Notifications
type: text/vnd.tiddlywiki
Notifications are small informational messages that appear at the top right of the TiddlyWiki window, and automatically disappear after a preset time.
<$button message="tm-notify" param="SampleNotification">Display sample notification</$button>

0
editions/tw5.com/tiddlers/LanguageGallery.tid → editions/tw5.com/tiddlers/languages/LanguageGallery.tid
View File

4
editions/tw5.com/tiddlers/mechanisms/AlertMechanism.tid
View File

@ -1,6 +1,6 @@
created: 20140213224306412
modified: 20140213224622441
tags: Mechanisms
modified: 20160107225720338
tags: Mechanisms Features
title: AlertMechanism
type: text/vnd.tiddlywiki

7
editions/tw5.com/tiddlers/plugins/CodeMirror Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223435497
list:
modified: 20160107223725809
tags: [[Plugin Editions]]
title: CodeMirror Plugin
modified: 20140922074322741
tags: Plugins
type: text/vnd.tiddlywiki
The CodeMirror plugin adds a sophisticated web-based editor to TiddlyWiki.

7
editions/tw5.com/tiddlers/plugins/D3 Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223425581
list:
modified: 20160107223725807
tags: [[Plugin Editions]]
title: D3 Plugin
modified: 20140922074322741
tags: Plugins
type: text/vnd.tiddlywiki
The D3 plugin integrates the D3 visualisation library with TiddlyWiki.

7
editions/tw5.com/tiddlers/plugins/Highlight Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223417655
list:
modified: 20160107223725805
tags: [[Plugin Editions]]
title: Highlight Plugin
modified: 20140922074322741
tags: Plugins
type: text/vnd.tiddlywiki
The Highlight plugin provides the ability to apply syntax colouring to text.

17
editions/tw5.com/tiddlers/plugins/Installing_a_plugin_from_the_plugin_library.tid Normal file
View File

@ -0,0 +1,17 @@
created: 20160107222352710
modified: 20160107224746041
tags: Plugins
title: Installing a plugin from the plugin library
type: text/vnd.tiddlywiki
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# Open the [[$:/ControlPanel]], click on the ''Plugins'' tab and then the ''Get more plugins'' button
# Click ''open plugin library'' to open the official plugin library
# When the library listing is loaded:
## Use the dropdown to select between ''plugins'', ''themes'' and ''languages''
## Use the ''search'' box to search the plugin details
# Click the ''install'' button to install a plugin
# Save your TiddlyWiki
# ''Refresh the page so that TiddlyWiki loads the new plugin''
# The plugin should now be available for use

7
editions/tw5.com/tiddlers/plugins/KaTeX Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223410181
list:
modified: 20160107223725803
tags: [[Plugin Editions]]
title: KaTeX Plugin
modified: 20140922074322741
tags: Plugins
type: text/vnd.tiddlywiki
This plugin adds the ability to display mathematical notation written in ~LaTeX.

13
editions/tw5.com/tiddlers/plugins/Manually_installing_a_plugin.tid Normal file
View File

@ -0,0 +1,13 @@
created: 20160107222430613
modified: 20160107222721398
tags: Plugins
title: Manually installing a plugin
type: text/vnd.tiddlywiki
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# In another browser window, find a link to the plugin, e.g. [[$:/plugins/tiddlywiki/example]]. You will typically find these links on the home page of the plugin (for example, http://tiddlywiki.com/plugins/tiddlywiki/katex/)
# Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki
# Save your TiddlyWiki
# ''Refresh the page so that TiddlyWiki loads the new plugin''
# The plugin should now be available for use

7
editions/tw5.com/tiddlers/plugins/Markdown Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223401584
list:
modified: 20160107223725801
tags: [[Plugin Editions]]
title: Markdown Plugin
modified: 20140922074322741
tags: Plugins
type: text/vnd.tiddlywiki
The Markdown plugin enables you to use tiddlers that are written in standard Markdown markup.

9
editions/tw5.com/tiddlers/plugins/Plugin_Editions.tid Normal file
View File

@ -0,0 +1,9 @@
created: 20160107223443647
modified: 20160107223732928
tags: Editions
title: Plugin Editions
type: text/vnd.tiddlywiki
These editions contain simple demos of the original set of TiddlyWiki plugins. They were prepared for earlier versions of TiddlyWiki that lacked the plugin library.
<<list-links "[tag[Plugin Editions]]">>

55
editions/tw5.com/tiddlers/plugins/Plugins.tid
View File

@ -1,55 +1,16 @@
created: 20140910215514237
modified: 20150313101514237
modified: 20160107224627982
tags: Concepts TableOfContents
title: Plugins
type: text/vnd.tiddlywiki
! Available Plugins
Plugins in TiddlyWiki5 are used to distribute optional components that customise and extend TiddlyWiki. You can install them from the [[official plugin library|Installing a plugin from the plugin library]] or from [[community sites|Resources]].
{{$:/core/ui/ControlPanel/Plugins/AddPlugins}}
Internally, plugins are a bundle of tiddlers packaged together as a single tiddler that can be installed, copied or deleted as a unit. The individual tiddlers within a plugin appear as ShadowTiddlers. See the PluginMechanism discussion for more details about how plugins are implemented internally.
Plugins can contain JavaScript modules, style sheets, and templates. Plugins can also be used to distribute ordinary text, images or any other content.
The following plugins are distributed on tiddlywiki.com as part of the main TiddlyWiki distribution.
<<list-links "[tag[Plugins]]">>
! What is a plugin?
A plugin in TiddlyWiki5 is a bundle of tiddlers packaged together as a single tiddler. Plugins are used to distribute optional, custom components for TiddlyWiki and also to package the core components of TiddlyWiki itself.
The tiddlers within a plugin appear as ShadowTiddlers.
Plugins can contain JavaScript modules, style sheets, and templates to extend the functionality of TiddlyWiki itself. Plugins can also be used to distribute ordinary text, images or other content. Plugins can be updated from their source as a unit.
See the PluginMechanism discussion for more details about how plugins are implemented internally.
! Installing a plugin from the plugin library
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# Open the [[$:/ControlPanel]] and click on the ''Plugins'' tab and then the ''Add'' tab
# Click ''open plugin library'' to open the official plugin library
# When the library listing is loaded:
## Use the dropdown to select between ''plugins'', ''themes'' and ''languages''
## Use the ''search'' box to search the plugin details
# Click the ''install'' button to install a plugin
# Save your TiddlyWiki
# ''Refresh the page so that TiddlyWiki loads the new plugin''
# The plugin should now be available for use
! Manually installing a plugin
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# In another browser window, find a link to the plugin, e.g. [[$:/plugins/tiddlywiki/example]]. You will typically find these links on the home page of the plugin (for example, http://tiddlywiki.com/plugins/tiddlywiki/katex/)
# Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki
# Save your TiddlyWiki
# ''Refresh the page so that TiddlyWiki loads the new plugin''
# The plugin should now be available for use
! How to uninstall / delete a plugin
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open the [[$:/ControlPanel]] and go to the ''Plugins'' tab
# Click on the plugin you want to delete to open its tiddler
# Click the edit icon and then delete the tiddler
# Save your TiddlyWiki
# ''Refresh the window so that TiddlyWiki completely removes the plugin''
# The plugin should now be deleted

7
editions/tw5.com/tiddlers/plugins/Railroad Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223348621
list:
modified: 20160107223725798
tags: [[Plugin Editions]]
title: Railroad Plugin
modified: 20150105134500000
tags: Plugins
type: text/vnd.tiddlywiki
{{$:/plugins/tiddlywiki/railroad/readme}}

7
editions/tw5.com/tiddlers/plugins/TW2Parser Plugin.tid
View File

@ -1,6 +1,9 @@
created: 20160107223340750
list:
modified: 20160107223725794
tags: [[Plugin Editions]]
title: TW2Parser Plugin
modified: 20140922074322741
tags: Plugins
type: text/vnd.tiddlywiki
This experimental plugin adds the ability to display WikiText written for the original Classic version of TiddlyWiki.

13
editions/tw5.com/tiddlers/plugins/Uninstalling_a_plugin.tid Normal file
View File

@ -0,0 +1,13 @@
created: 20160107222504269
modified: 20160107222727164
tags: Plugins
title: Uninstalling a plugin
type: text/vnd.tiddlywiki
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open the [[$:/ControlPanel]] and go to the ''Plugins'' tab
# Click on the plugin you want to delete to open its tiddler
# Click the edit icon and then delete the tiddler
# Save your TiddlyWiki
# ''Refresh the window so that TiddlyWiki completely removes the plugin''
# The plugin should now be deleted