diff --git a/editions/dev/tiddlers/Continuous Deployment.tid b/editions/dev/tiddlers/Continuous Deployment.tid new file mode 100644 index 000000000..f516b1be5 --- /dev/null +++ b/editions/dev/tiddlers/Continuous Deployment.tid @@ -0,0 +1,8 @@ +created: 20190115173727727 +modified: 20190115173903645 +title: Continuous Deployment +type: text/vnd.tiddlywiki + +TiddlyWiki 5 uses [[Travis CI|https://travis-ci.org/]] for continuous deployment. It is driven by the `.travis.yml` file in the root of the repo, along with the scripts in the `bin` folder that it invokes. + +The build history can be seen at https://travis-ci.org/Jermolene/TiddlyWiki5 diff --git a/editions/dev/tiddlers/GitHub Branches.tid b/editions/dev/tiddlers/GitHub Branches.tid new file mode 100644 index 000000000..eb4ff4e5b --- /dev/null +++ b/editions/dev/tiddlers/GitHub Branches.tid @@ -0,0 +1,11 @@ +created: 20190115173458112 +modified: 20190115173645658 +title: GitHub Branches +type: text/vnd.tiddlywiki + +Development of TiddlyWiki 5 in the GitHub repo at https://github.com/Jermolene/TiddlyWiki5 uses two branches: + +* `master` contains the latest version of the code, and is deployed to https://tiddlywiki.com/prerelease +* `tiddlywiki-com` contains the latest version of the documentation, and is deployed to https://tiddlywiki.com/, built by the latest released version of TiddlyWiki + +When preparing pull requests it is important to target the correct branch. diff --git a/editions/dev/tiddlers/HelloThere.tid b/editions/dev/tiddlers/HelloThere.tid index 83dd24d04..8afc1b22c 100644 --- a/editions/dev/tiddlers/HelloThere.tid +++ b/editions/dev/tiddlers/HelloThere.tid @@ -1,10 +1,18 @@ -modified: 20141122200310516 +created: 20190115173333457 +modified: 20190115173723915 tags: TableOfContents title: HelloThere +type: text/vnd.tiddlywiki Welcome to the developer documentation for TiddlyWiki (https://tiddlywiki.com/). It is currently a work in progress as material from two different sources is adapted and merged in addition to original content being added: * An assignment by Christian Jurke and Christian Heigele, two students working on their Master's degree in Information Technology at the Gießen University of Applied Sciences (Technische Hochschule Mittelhessen). Their work can be seen in the [[Introduction]] and the tiddlers that link from it. +* New developer documentation +** [[Continuous Deployment]] +** [[GitHub Branches]] +** HookMechanism +** [[Using ES2016 for Writing Plugins]] +** [[Adding Babel Polyfill to TiddlyWiki]] * The original developer documentation from https://tiddlywiki.com: ** [[TiddlyWiki for Developers]] ** [[TiddlyWiki Coding Style Guidelines]] @@ -21,6 +29,4 @@ Welcome to the developer documentation for TiddlyWiki (https://tiddlywiki.com/). ** [[Scripts for building tiddlywiki.com]] ** SyncAdaptorModules ** WidgetModules -** WikiRuleModules -*Original developer documentation -** HookMechanism +** WikiRuleModules \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/community/Contributing.tid b/editions/tw5.com/tiddlers/community/Contributing.tid index ca0513d3a..e481866fc 100644 --- a/editions/tw5.com/tiddlers/community/Contributing.tid +++ b/editions/tw5.com/tiddlers/community/Contributing.tid @@ -1,5 +1,5 @@ created: 20131101111400000 -modified: 20150630205715827 +modified: 20190115165616599 tags: Community title: Contributing type: text/vnd.tiddlywiki @@ -25,9 +25,8 @@ There are other ways to [[help TiddlyWiki|HelpingTiddlyWiki]] too. //The CLA documents used for this project were created using [[Harmony Project Templates|http://www.harmonyagreements.org]]. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".// -Remarks -------- +!! Remarks -**When not owning the copyright in the entire work of authorship** +''If you do not own the copyright in the entire work of authorship'': -In this case, please clearly state so, since otherwise we assume that you are the legal copyright holder of the contributed work! Please provide links and additional information that clarify under which license the rest of the code is distributed. +In this case, please clearly state so and provide links and any additional information that clarify under which license the rest of the code is distributed. diff --git a/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid b/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid index 87781d214..3e73d8705 100644 --- a/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid +++ b/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid @@ -1,11 +1,13 @@ created: 20140820151051019 -modified: 20150630205758258 +modified: 20190115165616599 tags: Community title: Improving TiddlyWiki Documentation type: text/vnd.tiddlywiki Anyone can submit improvements to the TiddlyWiki documentation that appears on https://tiddlywiki.com. (For improvements to the core code a more complicated process must be used because of the need to test the changes both in the browser and under Node.js before submission). +<<.warning """If you already know GitHub, note that documentation updates must be directed to the `tiddlywiki-com` branch""">> + # Read and observe the [[Documentation Style Guide]] # Create an account on https://github.com if you don't already have one # If you haven't done so already, sign the [[Contributor License Agreement]] as described in [[Signing the Contributor License Agreement]] diff --git a/editions/tw5.com/tiddlers/community/Signing the Contributor License Agreement.tid b/editions/tw5.com/tiddlers/community/Signing the Contributor License Agreement.tid index c77d052f2..9f924bfde 100644 --- a/editions/tw5.com/tiddlers/community/Signing the Contributor License Agreement.tid +++ b/editions/tw5.com/tiddlers/community/Signing the Contributor License Agreement.tid @@ -1,5 +1,5 @@ created: 20150630205653005 -modified: 20160617151534171 +modified: 20190115165616599 tags: title: Signing the Contributor License Agreement type: text/vnd.tiddlywiki @@ -9,6 +9,7 @@ Create a GitHub pull request to add your name to `cla-individual.md` or `cla-ent ''step by step'' # Navigate to [[licenses/CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]] or [[licenses/CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]] according to whether you are signing as an individual or representative of an organisation +# Ensure that the "branch" dropdown at the top left is set to `tiddlywiki-com` # Click the "edit" button at the top-right corner (clicking this button will fork the project so you can edit the file) # Add your name at the bottom #* eg: `Jeremy Ruston, @Jermolene, 2011/11/22` diff --git a/editions/tw5.com/tiddlers/howtos/Concatenating text and variables using macro substitution.tid b/editions/tw5.com/tiddlers/howtos/Concatenating text and variables using macro substitution.tid index de4bebc70..9d6ebf028 100644 --- a/editions/tw5.com/tiddlers/howtos/Concatenating text and variables using macro substitution.tid +++ b/editions/tw5.com/tiddlers/howtos/Concatenating text and variables using macro substitution.tid @@ -1,5 +1,5 @@ created: 20160424150551727 -modified: 20170101020235437 +modified: 20190115162340362 tags: Learning title: Concatenating text and variables using macro substitution type: text/vnd.tiddlywiki @@ -21,7 +21,7 @@ But that won't work. If you try this, the link will be interpreted very literall The solution is to use a macro to put the rendered value of `<>` together with the bit of additional text, `-Contact`. -Create a macro either at the top of the tiddler or in a global tiddler (see [[Macros]]) like this: +Create a macro at the top of the tiddler like this: ``` \define linkup(link) [[Additional Info|$link$-Contact]] diff --git a/editions/tw5.com/tiddlers/howtos/Editor toolbar.tid b/editions/tw5.com/tiddlers/howtos/Editor toolbar.tid index c0f4e2a52..54d7bbb62 100644 --- a/editions/tw5.com/tiddlers/howtos/Editor toolbar.tid +++ b/editions/tw5.com/tiddlers/howtos/Editor toolbar.tid @@ -1,21 +1,25 @@ created: 20160817093933820 -modified: 20160817110916813 +modified: 20190118161349442 tags: Features [[Formatting text in TiddlyWiki]] title: Editor toolbar +type: text/vnd.tiddlywiki + +tags: Features [[Formatting text in TiddlyWiki]] +title: Editor toolbar +type: text/vnd.tiddlywiki !! How it Works -The editor toolbar is a toolbar, to help you format text easily. It appear above the text input field in a tiddler when in edit mode. It have a similar appearance to desktop text editors like Microsoft Word or Libre Office Write. +The editor toolbar is a toolbar that helps you format text easily. It appears above the text input field in a tiddler when in edit mode. It has a similar appearance to desktop text editors like Microsoft Word or Libre Office Write. -!! What the Editor toolbar do +!! What the Editor toolbar does When you press the button for a function, it will insert the WikiText in the text field. As an example, if you press the bold button it will insert `'' ''`. If you ''highlight'' a piece of text the markup code will automatically go around the highlighted text. -if you are in another mode, like MarkDown, the toolbar will change to that syntax and insert appropriate code. However It will not change already typed text or markup. +If you are in another mode, like MarkDown, the toolbar will change to that syntax and insert appropriate code. However It will not change previously typed text or markup. -Beside the standard WikiText formatting, the Editor toolbar have the following buttons: +Besides the standard WikiText formatting, the Editor toolbar has the following buttons: <> - diff --git a/editions/tw5.com/tiddlers/system/ContributionBanner.tid b/editions/tw5.com/tiddlers/system/ContributionBanner.tid index 01d8e2a3e..4fe24c7eb 100644 --- a/editions/tw5.com/tiddlers/system/ContributionBanner.tid +++ b/editions/tw5.com/tiddlers/system/ContributionBanner.tid @@ -3,7 +3,7 @@ tags: $:/tags/EditTemplate list-after: $:/core/ui/EditTemplate/title \define makeGitHubLink() -https://github.com/Jermolene/TiddlyWiki5/edit/master/editions/tw5.com/tiddlers/$(githubLink)$ +https://github.com/Jermolene/TiddlyWiki5/edit/tiddlywiki-com/editions/tw5.com/tiddlers/$(githubLink)$ \end \define innerMakeGitHubLink(linkText) <$set name="githubLink" value={{$:/config/OriginalTiddlerPaths##$(draftOfTiddler)$}}> diff --git a/editions/tw5.com/tiddlers/system/Sources.tid b/editions/tw5.com/tiddlers/system/Sources.tid index eef3fa85d..c251f7a4f 100644 --- a/editions/tw5.com/tiddlers/system/Sources.tid +++ b/editions/tw5.com/tiddlers/system/Sources.tid @@ -13,7 +13,7 @@ https://tiddlywiki.com/static/$(title)$.html \end \define github-link-base() -https://github.com/Jermolene/TiddlyWiki5/blob/master/editions/tw5.com/tiddlers/$(title)$ +https://github.com/Jermolene/TiddlyWiki5/blob/tiddlywiki-com/editions/tw5.com/tiddlers/$(title)$ \end \define make-github-link() diff --git a/editions/tw5.com/tiddlers/variables/actionTiddler Variable.tid b/editions/tw5.com/tiddlers/variables/actionTiddler Variable.tid index 1daddf6f6..53e26fa6c 100644 --- a/editions/tw5.com/tiddlers/variables/actionTiddler Variable.tid +++ b/editions/tw5.com/tiddlers/variables/actionTiddler Variable.tid @@ -1,7 +1,10 @@ created: 20170406083917224 -modified: 20170406084026289 +modified: 20190118084621046 tags: Variables [[Core Variables]] title: actionTiddler Variable type: text/vnd.tiddlywiki -Within the ''action'' string of the DroppableWidget, the <<.def actionTiddler>> [[variable|Variables]] contains the title of the tiddler being dropped. +The variable `actionTiddler` is used in subtly different ways by different widgets: + +* Within the ''actions'' string of the DroppableWidget, the <<.def actionTiddler>> [[variable|Variables]] contains the title of the tiddler being dropped. +* Within the ''startactions'' and ''endactions'' string of the DroppableWidget, the <<.def actionTiddler>> [[variable|Variables]] contains a quoted [[Title List]] of all of the titles being dragged. diff --git a/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ password.tid b/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ password.tid index 2731b93cb..ddb01d895 100644 --- a/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ password.tid +++ b/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ password.tid @@ -5,4 +5,4 @@ tags: [[WebServer Parameters]] title: WebServer Parameter: password type: text/vnd.tiddlywiki -The [[web server configuration parameter|WebServer Parameters]] ''password'', is used with its companion [[password|WebServer Parameter: username]] as a shortcut for setting user credentials for [[WebServer Basic Authentication]]. +The [[web server configuration parameter|WebServer Parameters]] ''password'', is used with its companion [[username|WebServer Parameter: username]] as a shortcut for setting user credentials for [[WebServer Basic Authentication]]. diff --git a/editions/tw5.com/tiddlers/widgets/DraggableWidget.tid b/editions/tw5.com/tiddlers/widgets/DraggableWidget.tid index 5ae28567e..b0885bb9a 100644 --- a/editions/tw5.com/tiddlers/widgets/DraggableWidget.tid +++ b/editions/tw5.com/tiddlers/widgets/DraggableWidget.tid @@ -1,6 +1,6 @@ caption: draggable created: 20170406081938627 -modified: 20170406083157871 +modified: 20190118084621046 tags: Widgets title: DraggableWidget type: text/vnd.tiddlywiki @@ -23,6 +23,9 @@ See DragAndDropMechanism for an overview. Either or both of the ''tiddler'' and ''filter'' attributes must be specified in order for there to be a payload to drag. -The ''actionTiddler'' variable is accessible in both //startactions// and //endactions//. It holds the payload tiddler(s) specified through the //tiddler// attribute. +The [[actionTiddler Variable]] is accessible in both //startactions// and //endactions//. It holds the payload tiddler(s) specified through the //tiddler// and //filter// attributes as a [[Title List]] using double square brackets to quote titles that include whitespace. + +<<.tip """Note that the [[actionTiddler Variable]] holds a [[Title List]] quoted with double square brackets. This is unlike the DroppableWidget which uses the same variable to pass a single unquoted title.""">> + The LinkWidget incorporates the functionality of the DraggableWidget via the ''draggable'' attribute. diff --git a/editions/tw5.com/tiddlers/widgets/DroppableWidget.tid b/editions/tw5.com/tiddlers/widgets/DroppableWidget.tid index 10c58e4c0..3b197790a 100644 --- a/editions/tw5.com/tiddlers/widgets/DroppableWidget.tid +++ b/editions/tw5.com/tiddlers/widgets/DroppableWidget.tid @@ -1,6 +1,6 @@ caption: droppable created: 20170406082820317 -modified: 20170406085304387 +modified: 20190118084621046 tags: Widgets title: DroppableWidget type: text/vnd.tiddlywiki @@ -38,6 +38,8 @@ Within the action string, there are two Variables generated by the DroppableWidg If multiple items are dropped then the actions are performed repeatedly, once for each dropped item. +<<.tip """Note that the [[actionTiddler Variable]] holds a single, unquoted title. This is unlike the DraggableWidget which uses the same variable to pass a quoted [[Title List]].""">> + ! Examples This example displays a palette of icons. Dragging a tiddler onto one of the icons assigns that icon to the tiddler. diff --git a/editions/tw5.com/tiddlers/widgets/TextWidget.tid b/editions/tw5.com/tiddlers/widgets/TextWidget.tid index 5e425ed78..9d65050c8 100644 --- a/editions/tw5.com/tiddlers/widgets/TextWidget.tid +++ b/editions/tw5.com/tiddlers/widgets/TextWidget.tid @@ -1,8 +1,9 @@ created: 201401191419 -modified: 201401190837 +modified: 201901150000 tags: Widgets title: TextWidget caption: text +text-test: e=mc^^2^^ ! Introduction @@ -17,22 +18,16 @@ The content of the `<$text>` widget is not used. ! Example -``` -<$vars string="//italic//"> +<$macrocall $name='wikitext-example-without-html' src='<$vars string="//italic//"> * <> * <$text text=<>/> -``` +' /> -Displays as: +<$macrocall $name='wikitext-example-without-html' src=' +The text-test field of this tiddler has a field value: <$text text={{!!text-test}}/> -<<< -<$vars string="//italic//"> - -* <> -* <$text text=<>/> - - -<<< +It displays in its normal WikiText format as: {{!!text-test}} +' /> diff --git a/licenses/cla-individual.md b/licenses/cla-individual.md index c07872182..f9a075206 100644 --- a/licenses/cla-individual.md +++ b/licenses/cla-individual.md @@ -341,3 +341,11 @@ Abraham Samma, @abesamma, 2018/10/31 German Ramírez, @g0erman, 2018/11/14 @00SS, 2018/12/10 + +David Nebauer, @dnebauer, 2019/01/01 + +Moritz Ulrich, @the-kenny, 2019/01/03 + +Johannes Löthberg, @kyrias, 2019/01/07 + +Ben Webber, @benwebber, 2019/01/09 diff --git a/plugins/tiddlywiki/highlight/readme.tid b/plugins/tiddlywiki/highlight/readme.tid index 59001fc85..532749aee 100644 --- a/plugins/tiddlywiki/highlight/readme.tid +++ b/plugins/tiddlywiki/highlight/readme.tid @@ -1,6 +1,6 @@ title: $:/plugins/tiddlywiki/highlight/readme -This plugin provides syntax highlighting of code blocks using v8.8.0 of [[highlight.js|https://github.com/isagalaev/highlight.js]] from Ivan Sagalaev. +This plugin provides syntax highlighting of code blocks using v8.8.0 of [[highlight.js|https://github.com/highlightjs/highlight.js]] from Ivan Sagalaev and others. ! Usage