1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-29 21:09:56 +00:00
Commit Graph

276 Commits

Author SHA1 Message Date
Jeremy Ruston
b95723a022
Fix syncer to handler errors properly (#4373)
* First commit

* Add throttling of saves

Now we refuse to save a tiddler more often than once per second.

* Wait for a timeout before trying again after an error

* Modest optimisations of isDirty() method

* Synchronise system tiddlers and deletions from the server

Fixes two long-standing issues:

* Changes to system tiddlers are not synchronised from the server to the browser
* Deletions of tiddlers on the server are not propagated to browser clients

* Make sure we update the dirty status even if there isn't a task to perform

* Replace save-wiki button with popup sync menu

* Remove the "Server" control panel tab

We don't need it with the enhanced sync dropdown

* Add indentation to the save-wiki button

* Fix spacing in dropdown menu items

* Switch between cloud icons according to dirty status

* Add a menu item to copy syncer logs to the clipboard

* Improve animated icon

* Remove indentation from save-wiki button

@pmario the annoying thing is that using `\trim whitespace` trims significant whitespace too, so it means we have to use <$text text=" "/> when we need a space that won't be trimmed. For the moment, I've removed the indentation but will keep thinking about it.

* Further icon, UI and copy text tweaks

Move the icons and styles from the core into the TiddlyWeb plugin

* Clean up PR diff

* Tweak animation durations

* Break the actions from the syncer dropdown into separate tiddlers

@pmario I think this makes things a bit easier to follow

* Refactor syncadaptor creation and logging

The goal is for the syncadaptor to be able to log to the same logger as the syncer, so that the "copy syncer logs to clipboard" data is more useful.

* Don't transition the dirty indicator container colour, just the SVG's colour

* Only trigger a sync for changes to tiddlers we're interested in

Otherwise it is triggered by the creation of the alert tiddlers used to display errors.

* Restore deleting local tiddlers removed from the server

(I had commented it out for some testing and accidentally commited it).

* Guard against missing adaptor info

* We still need to trigger a timeout when there was no task to process

* Avoid repeatedly polling for changes

Instead we only trigger a timeout call at if there is a pending task (ie a tiddler that has changed but isn't yet old enough to save).

* Lazy loading: include skinny versions of lazily loaded tiddlers in the index.html

* Introduce _is_skinny field for indicating that a tiddler is subject to lazy loading

* Remove savetrail plugin from prerelease

It doesn't yet work with the new syncer

* Make the savetrail plugin work again

* Clear outstanding alerts when synchronisation is restored

* Logger: only remove alerts from the same component

Missed off 9f5c0de07

* Make the saving throttle interval configurable (#4385)

After switching Bob to use the core syncer the throttle interval makes saving feel very sluggish compared to the message queue setup that I had before.
The editing lock that I use to prevent conflicts with multiple users doesn't go away until the save is completed, and with the 1 second delay it means that if you edit a tiddler and save it than you have to wait one second before you can edit it again.

* Tweaks to appearance of alerts

* Exclude temp tiddlers from offline snapshots

Otherwise alerts will persist

* Tweak appearance of status line in dropdown

* Update release note

* Web server: Don't include full path in error messages

Fixes #3724

* In change event handler check for deletions

* Disable the official plugin library when the tiddlyweb plugin is loaded

* Hide error details from browser for /files/ route

See https://github.com/Jermolene/TiddlyWiki5/issues/3724#issuecomment-565702492 -- thanks @pmario

* Revert all the changes to the relationship between the syncer and the syncadaptor

Previously we had some major rearrangements to make it possible for the syncadaptor to route it's logging to the logger used by the syncer. The motivation is so that the "copy logs to clipboard" button is more useful.

On reflection, changing the interface this drastically is undesirable from a backwards compatibility perspective, so I'm going to investigate other ways to achieve the logger sharing

* Make the tiddlyweb adaptor use the syncer's logger

So that both are availavble when copying the syncer logs to the clipboard

* Update release note

* Support setting port=0 to get an OS assigned port

Quite useful

* Update code comment

* UI: Use "Get latest changes from server" instead of "Refresh"

* Add getUpdatedTiddlers() method to syncadaptor API

See https://github.com/Jermolene/TiddlyWiki5/pull/4373#issuecomment-573579495

* Refactor revision handling within the syncer

Thanks @pmario

* Fix typo in tiddlywebadaptor

* Improve presentation of errors

See https://github.com/Jermolene/TiddlyWiki5/pull/4373#issuecomment-573695267

* Add docs for getTiddlerRevision()

* Remove unused error animation

* Update comment for GET /recipes/default/tiddlers/tiddlers.json

* Optimise SVG cloud image

* Add optional list of allowed filters for get all tiddlers route

An attempt to address @Arlen22's concern here:

https://github.com/Jermolene/TiddlyWiki5/pull/4373#pullrequestreview-342146190

* Fix network error alert text translatability

* Fix error code and logging for GET /recipes/default/tiddlers/tiddlers.json

Thanks @Arlen22

* Flip GET /recipes/default/tiddlers/tiddlers.json allowed filter handling to be secure by default

* Validate updates received from getUpdatedTiddlers()

* Add syncer method to force loading of a tiddler from the server

* Remove the release note update to remove the merge conflict

* Fix crash when there's no config section in the tiddlywiki.info file

* Use config tiddler title to check filter query (merge into fix-syncer) (#4478)

* Use config tiddler title to check filter query

* Create config-tiddlers-filter.tid

* Add config switch to enable all filters on GET /recipes/default/tiddlers/tiddlers.json

And update docs

* Fix bug when deleting a tiddler with a shadow

Reported by @kookma at https://github.com/Jermolene/TiddlyWiki5/pull/4373#issuecomment-604027528

Co-authored-by: jed <inmysocks@fastmail.com>
Co-authored-by: Arlen22 <arlenbee@gmail.com>
2020-03-30 15:24:05 +01:00
Jeremy Ruston
5a5c967a39 Add support for $:/tags/Macro/View macros that are only visible within view templates 2020-01-03 10:40:11 +00:00
Jeremy Ruston
6089c4de29 Extend refresh throttling to tiddlers having a "throttle.refresh" field
See discussion here: https://groups.google.com/d/msgid/tiddlywiki/7738644f-b53f-4fb0-b0df-16243fe51795%40googlegroups.com
2019-10-14 10:42:14 +01:00
Jeremy Ruston
9395d75671 Fix sizes of SVG icons in documentation
Fixes #4153
2019-10-13 15:35:36 +01:00
Jeremy Ruston
067e8a9f94 Merge branch 'tiddlywiki-com' 2019-08-09 10:29:46 +01:00
twMat
1a08430a0c Docs: Fix typo in TextReference.tid (#3978)
minor correction - or am I mistaken?
2019-06-12 22:03:01 +01:00
Jeremy Ruston
37bb75f0cf Add support for = prefix for filter runs that doesn't remove duplicates 2019-06-10 17:54:20 +01:00
00SS
90b7961629 Update TiddlerFields.tid (#3733)
#3680 Was getting too complicated for me so opened a new PR
2019-01-27 19:29:13 +00:00
HC
5b14a97e0f Documentation of Using Excise text (#2533)
* Documentation of Using Excise text 

Documentation on the Excise text function. 
I propose that the  Excise text drop down ( the tiddler: $:/language/Buttons/Excise/Caption/Tag) links to this doc. I don't have permission to (or don't know how to) edit that tiddler in github. 

I propose the following text for the drop-down tiddler:

Tag new tiddler with the title of this tiddler (If the title is changed you have to [[save and re-edit|Using Excise]] to use the new title as tag).


see the issue:
https://github.com/Jermolene/TiddlyWiki5/issues/2531

* Update Using Excise.tid

changed headings in response to discussion

* Doc for  editor toolbar buttons (wikitext)

Documentation for buttons special to the editor toolbar (wikitext)

* Update Using Excise.tid

placed it under the new [[Editor toolbar]]

* Update Using Stamp.tid

placed it under the new [[Editor toolbar]] tiddler

* Update WikiText.tid

added reference to [[Editor toolbar]]

* Update Formatting text in TiddlyWiki.tid

added reference to the [[Editor toolbar]]

* Update WikiText.tid

* Update Editor toolbar.tid

* Update Editor toolbar.tid

* Update Editor toolbar.tid

* Update Editor toolbar.tid

typo
2018-11-27 21:12:44 +00:00
BurningTreeC
ce7becd64f KeyboardShortcut docs (#3496)
* add SystemTag $:/tags/KeyboardShortcut

* add Keyboard Shortcut Descriptor

* Update KeyboardShortcuts.tid

* Update KeyboardShortcutDescriptor.tid

* Update and rename SystemTag_$__tags_KeyboardShortcut.tid to SystemTag_ $__tags_KeyboardShortcut.tid

* Create KeyboardShortcutTiddler.tid

* Update KeyboardShortcutTiddler.tid

* Update KeyboardShortcutTiddler.tid

* Update KeyboardShortcuts.tid

* Update KeyboardShortcuts.tid
2018-11-21 11:24:50 +00:00
Jermolene
fe85845c3c Add new "\import" pragma 2018-09-28 16:01:32 +01:00
Jermolene
cfb2d7c9c8 Add support for splash screens during loading
Fixes #3417

Addresses some of the requirements discussed in #2254
2018-09-27 09:47:55 +01:00
Jermolene
806df86434 Move the system tag documentation into individual tiddlers 2018-09-26 18:24:08 +01:00
Jermolene
19f7287a53 Add $:/tags/TiddlerInfoSegment for adding segments to the tiddler info panel 2018-08-30 13:42:51 +01:00
Jermolene
bb9e2de861 Docs improvements 2018-08-08 10:47:10 +01:00
Jermolene
8feb07e429 Add information about "class" field used by the ViewTemplate 2018-05-02 16:02:24 +01:00
twMat
3aaa7357f6 Update TiddlerFields.tid (#3236)
Add "icon", "list-before" and "list-after"
2018-05-02 16:00:16 +01:00
Jermolene
9e03264ebe Add pluggable previews to the import listing 2018-04-03 17:50:57 +01:00
Jermolene
1c6942402e Add support for startup actions 2018-03-23 09:35:39 +00:00
Jermolene
33cdf1550a Docs: DefaultTiddlers tweaks 2018-03-06 16:14:50 +00:00
AlexHough
25fc4aa3ae Docs: change link (#3152) 2018-03-05 11:36:16 +00:00
Jermolene
8a5c357f23 Clarify DictionaryTiddlers definition
FIxes #3142
2018-03-05 11:19:21 +00:00
Jermolene
df7f4fedb2 Docs: Improve system tiddlers docs 2018-01-13 15:39:44 +00:00
Jermolene
29364cbd08 Change http://*.tiddlywiki.com/* to https:// 2017-11-11 11:56:20 +00:00
Jermolene
ce3832e275 Docs tweaks 2017-09-20 11:48:06 +01:00
Jermolene
d966583854 Add new "\whitespace" pragma
This will allow us to simplify some of the more unreadable core
wikitext tiddlers…
2017-07-12 16:46:13 +01:00
Mario Pietsch
e9173b7a71 added several missing tags, visual refactoring, improves readability. (#2865)
* added several missing tags, visual refactoring, improves readability.

* better wording
2017-06-29 17:02:00 +01:00
Jermolene
8802015f1a Docs updates
Starting to document the new drag and drop stuff
2017-03-29 10:19:42 +01:00
gernert
d65fd771e7 Update ColourPalettes.tid (#2806) 2017-03-17 13:54:32 +00:00
jrgetsin
63b3d88604 Typo: Update TiddlyWiki.tid (#2566)
for "bought" put "brought"
looked like a typo to me
2017-02-27 16:38:57 +00:00
gernert
a71e27386f Update SystemTags.tid (#2508)
* Update SystemTags.tid

* Update SystemTags.tid

@Jermolene
Hope I did it correct now ;-)
2017-02-27 16:38:13 +00:00
twMat
a6b538b308 Clarify use of RawMarkup tag (#2768)
Anyone attempting to use this tag will need information about required reload of TW for activation.
2017-02-15 08:56:49 +00:00
Jermolene
56b6781715 Fixes to license visibility
Credits to @cdent - is 2012 right, or did your work there carry on into
2013?

Addresses part of #2378
2017-01-29 21:11:30 +00:00
Jermolene
a2fe101848 Updated text reference docs 2016-12-17 12:25:43 +00:00
Jermolene
4a45e9d2dc Improve text reference documentation 2016-12-16 17:36:11 +00:00
Jermolene
1b41b44684 Improve support for bulk loading tiddlers under Node.js
Fixes #2610
2016-10-15 16:23:17 +01:00
Jermolene
b2c6c24771 Minor fixes for #2473 2016-07-05 18:06:52 +01:00
Myeongjin
80256b4dab Update document in tiddlywiki.com edition
* Add string '.htm' to 'Saving with TiddlyIE'
* Change external links to match locale with wiki language
* Add instructions for use to 'Saving on Android'
* Change string in 'task'
* Change instructions for use in 'Saving on iPad/iPhone'
* Add newline to 'TiddlyDesktop Releases'
* Remove caption from 'Serving TW5 from Android'
* Change link to external in tiddlers which tagged 'Editions'
* Remove string 'index.html' from 'Some of the things you can do with TiddlyWiki'
* Change link 'TiddlyWiki Groups' to 'Forums' in tiddlers which tagged 'Community'
* Remove CamelCase link 'TiddlyWiki' from tiddlers tagged 'Community'
* Change string 'done' to 'Upgrade' in 'UpgradeMechanism'
* Change buttons to images in 'How to export tiddlers'
* Add images about buttons to tiddlers
* Add quotation mark to text 'edit' in 'Signing the Contributor License Agreement'
* Rename 'UsingSVG' to 'Using SVG'
* Change link 'TypedBlockWikiText' to 'Typed Blocks in WikiText' in 'Using SVG'
* Add tiddler 'Using Stamp'
* Add 'rel="noopener noreferrer"' to external links
* Add description about 'rel="noreferrer"' to 'HTML in WikiText'
* Add link of prerelease version about translators edition, and how to translate on Node.js, in 'Translate TiddlyWiki into your language'
* Change string 'dropdown' to 'tab' in 'Installing a plugin from the plugin library'
* Add download button to 'Empty Edition'
2016-07-06 01:10:51 +09:00
maxthomax
a9c4f113a1 More documentation about named properties (#2481)
* Made the link between "names" and "properties" explicit (I only figured it out by reading the TextReference documentation)
* Documented named property manipulation through ActionWidgets.
2016-06-09 22:09:16 +01:00
twMat
77d4b084e6 Update TiddlerFields.tid (#2479)
Include mention of *caption* field.
2016-06-09 20:32:33 +01:00
Myeongjin
5f68f411c8 Replace '_' to space in tw5.com edition (#2417)
* Move tiddler 'thumbnail Macro (Examples)' to directory 'macros/examples'

* Replace '_' to space in tw5.com edition
2016-05-02 08:34:30 +01:00
Jermolene
0151363b74 House style for tw5.com is to use -ise not -ize 2016-04-26 07:42:52 +01:00
nome
1ae428e323 Make tiddler file paths configurable (#2379)
When saving new tiddlers on node.js, allow the user to override the path of the
generated .tid file. This is done by creating a tiddler
$:/config/FileSystemPaths which contains one or more filter expressions, one
per line. These filters are applied in turn to the tiddler to be saved, and
the first output produced is taken as a logical path relative to the wiki's
tiddlers directory. Any occurences of "/" in the logical path are replaced with
the platform's path separator, the extension ".tid" is appended, illegal
characters are replaced by "_" and the path is disambiguated (if necessary) in
order to arrive at the final tiddler file path. If none of the filters matches,
or the configuration tiddler does not exist, fall back to the previous file
naming scheme (i.e. replacing "/" by "_").

This implies we will now, for tiddlers matching the user-specified filters,
create directory trees below the tiddlers directory. In order to avoid
cluttering it with empty directory trees when renaming or removing tiddlers, any
directories that become empty by deleting a tiddler file are removed
(recursively).

Benefits of this configuration option include the ability to organize git
repositories of TiddlyWikis running on node.js, ability to replace characters
that cause trouble with particular operating systems or workflows (e.g. '$' on
unix) and the ability to replicate tiddler "paths" in the filesystem (by
including a filter like "[!has[draft.of]]") without forcing such a (potentially
problematic) change on all users.
2016-04-25 08:36:32 +01:00
Jermolene
5ba7b30891 Update system tags docs 2016-02-15 17:43:54 +00:00
gernert
fa6dc5677d Update SystemTags.tid
Added missing $:/tags/ToolbarButtonStyle
2016-01-18 19:19:13 +01:00
alexhough
fa3ea480fe add "Transclusion and Substitution" to learn more 2016-01-03 17:11:13 +00:00
Jens
6c89b27328 Changed Transclusion from html to TidlerWiki syntax in order to force new tab when following
With the html syntax when you go back after following the link knowledges of open tiddlers is lost.
Not sure if there should also be feature request for TiddlerWiki to store knowledge of open tiddlers in browser history.
2015-11-22 13:53:59 +01:00
Tobias Beer
9f6fea7607 updated to point to new location 2015-10-13 12:23:58 +02:00
Jermolene
268da52f8c Documentation updates
Adding “Story River” to the “Concepts” category, and doing some
clean-up of other entries in the category by moving some concepts to
become sub-concepts in the TOC
2015-09-18 09:19:21 +01:00
Jermolene
803d70225a Allow tiddlywiki.files to load directories recursively 2015-09-15 13:35:54 +01:00
Jermolene
73210a7b8c Refine the way that we support serialised external tiddler files
The old way was sufficiently backwards compatible that it was
impossible to use TiddlyWiki 5.1.9 to build the tw5.com edition.
2015-07-28 19:56:56 +01:00
Jermolene
ecbd97b4b4 Revise support for external tiddler files
Fixes #1884
2015-07-18 11:45:30 +01:00
Jermolene
16ebdff1cc Clarify TextReference documentation
Prompted by this comment:

https://github.com/Jermolene/TiddlyWiki5/pull/1721#issuecomment-10217516
5
2015-05-18 19:07:14 +01:00
gernert
1d4c387113 Update SystemTags.tid
Add missing tags
2015-04-25 20:52:56 +02:00
Jermolene
bf67ea02ac Docs tweaks 2015-03-26 11:15:43 +00:00
Astrid Elocson
f73891c083 Document the tv-* variables 2015-02-28 14:38:00 +00:00
Astrid Elocson
b001c7b558 Macros and styles for tips and warnings 2015-02-26 16:32:00 +00:00
Jermolene
b13d87fdf2 Overhaul the macro and variable documentation #1519 2015-02-24 17:41:16 +01:00
Astrid Elocson
3dd4f943ce Rename to SelectionConstructors.tid 2015-01-29 13:41:11 +00:00
Astrid Elocson
9a7bda28e9 Revise filter terminology: constructors and modifiers 2015-01-29 13:40:18 +00:00
Astrid Elocson
a5d54a0ada Rename AbsoluteOperators.tid 2015-01-29 13:23:24 +00:00
Astrid Elocson
e6d204db0f Adjust documentation following pull #1378 2015-01-27 15:44:55 +00:00
Astrid Elocson
15f05b076c Retarget a couple of links and add trailing linefeeds 2015-01-24 21:53:28 +00:00
Astrid Elocson
aac2a63e05 Overhaul the filter operator documentation: part 2 2015-01-24 21:18:44 +00:00
Astrid Elocson
ade1c40911 Revise terminology around tiddler sets 2015-01-19 19:37:26 +00:00
Astrid Elocson
172c7ef7dd Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00
Astrid Elocson
8fc404bbca Make filter syntax explanations accurate 2015-01-14 21:27:07 +00:00
Astrid Elocson
28b6302a83 Improve filter documentation 2015-01-11 19:09:35 +00:00
Jeremy Ruston
be06cb1019 Merge pull request #1334 from tobibeer/variable-documentation
updates to variable documentation
2015-01-10 15:05:48 +00:00
Tobias Beer
391768ae3f updates to variable documentation 2015-01-07 16:18:36 +01:00
Astrid Elocson
90e43d5f5a Further improvements around filter documentation 2015-01-05 14:06:10 +00:00
Jeremy Ruston
71357a8e39 Merge pull request #1316 from aelocson/filter-syntax
Use railroad diagrams to explain filter syntax
2015-01-04 16:00:17 +00:00
Astrid Elocson
388464190d Use railroad diagrams to explain filter syntax 2015-01-03 20:16:46 +00:00
Jermolene
3f5e46011f Remove inaccurate docs 2015-01-02 17:42:04 +00:00
Jermolene
544ee4668e Typo correction 2014-12-31 09:34:32 +00:00
Jeremy Ruston
8707d51b7d Merge pull request #1293 from aelocson/patch-3
Improvements to wording
2014-12-30 18:42:03 +00:00
Astrid Elocson
79a3beeaa6 Add concept of Tag Tiddlers 2014-12-28 09:55:36 +00:00
Astrid Elocson
4f1d6f71fc Add concept of JSON Tiddlers 2014-12-28 09:54:44 +00:00
Astrid Elocson
9aafed511b Add concept of Dictionary Tiddlers 2014-12-28 09:53:58 +00:00
Astrid Elocson
117d10275f Improvements to wording 2014-12-28 09:51:53 +00:00
Astrid Elocson
e9c6610d74 Improvements to wording 2014-12-28 09:51:13 +00:00
Astrid Elocson
7290be9e47 Improvements to wording 2014-12-28 09:50:19 +00:00
Astrid Elocson
cc2688bf44 Update and rename TiddlerChain.tid to TitleList.tid 2014-12-23 21:55:04 +00:00
Astrid Elocson
304848f258 Add a TiddlerChain tiddler
For the common but unnamed concept of a "string [[of tiddler]] titles" like that.
2014-12-23 15:06:18 +00:00
Astrid Elocson
1b61ad13d2 Clearer wording 2014-12-23 07:33:38 +00:00
Astrid Elocson
efda54465e Create InfoPanel tiddler 2014-12-23 00:31:54 +00:00
Jc-L
313f731f77 Update ExternalImages.tid
Minor typo correction
2014-12-21 19:32:42 +01:00
Jermolene
376b447570 Documentation tweaks
@erwanm I ended up making some fairly extensive tweaks.

One issue is that the (excellent) material you’ve provided on
transclusion with templates covers very much the same ground as the
existing TemplateTiddlers tiddler. The existing text was focused on
transclusion with widgets; I think your material using transclusion
notation is much easier to understand.

I’ve also removed the exercises section. We don’t have exercises
elsewhere in the documentation, so I think we need to make a conscious
decision about whether we’re going to try to add them, and then do so
consistently across the material.

I also made some changes to bring the text into house style for
consistency (which I’ve also tried to start documenting).
2014-12-10 17:08:59 +00:00
Erwan Moreau
63c441d3e8 Create TransclusionAsTemplateUsage.tid 2014-12-09 14:45:40 +00:00
Erwan Moreau
46e6fb1957 Create TransclusionBasicUsage.tid 2014-12-09 14:44:28 +00:00
Erwan Moreau
900738e796 Create TransclusionPrinciple.tid 2014-12-09 14:42:41 +00:00
Tobias Beer
a94da683f0 list core descriptions for ModuleType
changed dead links with descriptions ...these are still missing:

* $:/language/Docs/ModuleTypes/allfilteroperator
* $:/language/Docs/ModuleTypes/info
* $:/language/Docs/ModuleTypes/library
2014-12-02 13:10:25 +01:00
Jermolene
7d46afc7b2 Move docs for 5.1.5 release 2014-11-26 11:22:20 +00:00
Jermolene
27c9e7269e Update "Tiddlers" docs
Suggested by @twMat
2014-11-21 17:06:12 +00:00
Jermolene
4e3f6fc4f8 Tweaks "Tiddlers" docs
Thanks for the prompt @FND - I’ve pushed this version to
http://tiddlywiki.com/#Tiddlers and
http://tiddlywiki.com/static/Tiddlers.html
2014-11-01 11:30:22 +00:00
Jermolene
49dc5694a3 Enhance "includeWikis" to merge build targets
Build targets found in included wikis are merged behind any found in
the wiki itself
2014-10-14 15:14:50 +01:00
Jermolene
c39b5b913c Docs tweak 2014-10-12 16:45:53 +01:00
Eucaly
3acb5de407 update JavaScript Macros reference link to dev document 2014-10-01 18:36:04 +08:00
Jermolene
f81b0a6fa9 Add plugins to TOC on tw5.com 2014-09-22 10:41:34 +01:00
Jermolene
3c58426ff2 Docs updates 2014-09-19 21:56:07 +01:00