mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2026-07-05 11:22:44 +00:00
Docs
This commit is contained in:
@@ -30,6 +30,7 @@ name: The human readable name associated with a plugin tiddler
|
||||
parent-plugin: For a plugin, specifies which plugin of which it is a sub-plugin
|
||||
plugin-priority: A numerical value indicating the priority of a plugin tiddler
|
||||
plugin-type: The type of plugin in a plugin tiddler
|
||||
stability: The development status of a plugin: deprecated, experimental, stable, or legacy
|
||||
revision: The revision of the tiddler held at the server
|
||||
released: Date of a TiddlyWiki release
|
||||
source: The source URL associated with a tiddler
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
created: 20130825213300000
|
||||
modified: 20240416103247799
|
||||
modified: 20240520162904479
|
||||
tags: Concepts
|
||||
title: TiddlerFields
|
||||
type: text/vnd.tiddlywiki
|
||||
@@ -39,6 +39,7 @@ Other fields used by the core are:
|
||||
|`name` |<<lingo name>> |
|
||||
|`plugin-priority` |<<lingo plugin-priority>> |
|
||||
|`plugin-type` |<<lingo plugin-type>> |
|
||||
|`stability` |<<lingo stability>> |
|
||||
|`source` |<<lingo source>> |
|
||||
|`subtitle` |<<lingo subtitle>> |
|
||||
|`throttle.refresh` |<<lingo throttle.refresh>> |
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
created: 20130826122000000
|
||||
modified: 20220613124446953
|
||||
modified: 20240520162828577
|
||||
tags: Mechanisms
|
||||
title: PluginMechanism
|
||||
type: text/vnd.tiddlywiki
|
||||
@@ -16,6 +16,10 @@ By convention, plugin titles have the form `$:/plugins/<publisher>/<name>`. Plug
|
||||
|
||||
When [[running TiddlyWiki under Node.js|TiddlyWiki on Node.js]], plugins can also be stored as individual tiddler files in [[PluginFolders]].
|
||||
|
||||
! Plugin Stability
|
||||
|
||||
{{Plugin Stability}}
|
||||
|
||||
! Plugin Types
|
||||
|
||||
{{Plugin Types}}
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
created: 20240520155341641
|
||||
modified: 20240520162820882
|
||||
tags: PluginMechanism
|
||||
title: Plugin Stability
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
Plugins are recommended to have a `stability` field that communicates the state of development of the plugin. It can contain the following values:
|
||||
|
||||
* ''STABILITY_0_DEPRECATED'' - Deprecated. This plugin is not recommended for new projects
|
||||
* ''STABILITY_1_EXPERIMENTAL'' - Experimental. Non-backward compatible changes or removal may occur in any future release. Use of the plugin is not recommended in production environments
|
||||
* ''STABILITY_2_STABLE'' - Stable.
|
||||
* ''STABILITY_3_LEGACY'' - Legacy. Although this plugin is unlikely to be removed, it is no longer actively maintained, and other alternatives are available
|
||||
|
||||
These stability levels are taken from the Node.js project - https://nodejs.org/api/documentation.html#stability-index.
|
||||
Reference in New Issue
Block a user