1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-10-31 23:26:18 +00:00
Commit Graph

2404 Commits

Author SHA1 Message Date
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
Mario Pietsch
42f7c03824 tm-open-external-window plus documentation. (#2721)
* first try - tm-open-external-window plus documentation.

* render examples and make help link a global variable
2018-11-27 18:43:25 +00:00
twMat
9232279a79 Update EditBitmapWidget doc to reflect update in code (#2725) 2018-11-27 18:11:21 +00:00
Tobias Beer
ee8821a5b4 Improvde days Operator docs for parameter (#3041)
in response to @rubaboo's [comment](https://github.com/Jermolene/TiddlyWiki5/pull/2972#issuecomment-331284559)
2018-11-27 17:57:13 +00:00
Tobias Beer
e0126b2f77 Tweak layout of HelloThere calls to action (#3046)
should only be at most 4 images per row, centered

the visuals of seeing 6 in the first row and 2 in the second is rather displeasing
2018-11-27 17:56:19 +00:00
Jermolene
1700eb4ba7 Docs update 2018-11-25 10:37:33 +00:00
twMat
536ab10790 Update docs for $:/tags/SideBarSegment (#3579)
The possibility to rearrange stuff "inside" tag pills is not obvious so makes sense to mention.
2018-11-25 10:36:15 +00:00
Jermolene
078df9c157 Remove "TiddlyFox Apocalypse" from HelloThere thumbnails 2018-11-24 15:52:49 +00:00
Bimba Laszlo
d55a498fca Docs: Clarify TextWidget with example (#3564) 2018-11-21 11:26:00 +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
Jeremy Ruston
09330968cc
New "else" prefix for filters (#3558)
* Experimental "else" prefix for filters

See #3557

* Docs updates for "else" filter runs
2018-11-20 13:29:44 +00:00
Jermolene
8832409666 Docs typo 2018-11-20 11:29:36 +00:00
Bimba Laszlo
6d67dc8eb8 Clarify drag-n-drop behaviour again (#3434)
* Clarify drag-n-drop behaviour again

Just found the real reason of drag-n-drop issue mentioned in
b89e8d1635.

* Trying to formulate correctly
2018-11-20 10:06:12 +00:00
Bimba Laszlo
f4ca295086 Docs: Remove broken is operator example (#3556)
In 737e9ae4cb the multiple suboperator
functionality was banned, but an example is remained in the docs.
2018-11-19 21:01:56 +00:00
BurningTreeC
eea034c32d Docs: add state* documentation to button and reveal widgets (#3553)
* docs: add state* attributes to reveal widget

* docs: add state* attributes to button widget
2018-11-19 17:59:04 +00:00
BurningTreeC
33ba69e852 Modals: Display in source-window (#3539)
* Make modals display in source Window

this makes modals display within the window where they got opened, with the parameter `rootwindow` that, if `yes` or `true`, shows the modal always in the root TW window (`<$action-sendmessage $message="tm-modal" $param="mymodal" rootwindow="yes|true"/>`)

* pass the full event to $tw.modal.display

we need the event there to find `srcDocument` and `srcWindow`

* pass event in options object

* update modal.js to use options.event

* add docs for rootwindow tm-modal attribute
2018-11-18 20:57:04 +00:00
Jeremy Ruston
33dd367a65
Introduce new subfilter operator (#3508) 2018-11-16 11:27:19 +00:00
Jermolene
db3f41db29 Docs typo fix for #3540 2018-11-15 21:44:05 +00:00
G0erman
d317bdf3da Documentation language (#3540)
* Improve documentation install language on node.js

* Singing the CLA
2018-11-15 21:43:01 +00:00
Jermolene
8ae62c90df Improve links to demo editions
Now make them relative to the location of index.html
2018-11-13 08:55:13 +00:00
Jermolene
277bc92f92 Add a dynaview demo edition 2018-11-13 08:54:50 +00:00
Bimba Laszlo
196992167f Add link to "code style and auto format settings" repo (#3527)
https://github.com/Jermolene/TiddlyWiki5/pull/3511#issuecomment-436405293
2018-11-08 11:29:31 +00:00
BurningTreeC
9f8a74c6d9 add new-tiddler new-journal new-image keyboard shortcuts (#3512)
* add new-tiddler action tiddler

* use new-tiddler action-tiddler

* use new-tiddler action-tiddler correctly

* use new-journal action-tiddler

* create new-journal action-tiddler

* use new-image action-tiddler

* add new-image action-tiddler

* create new-image type config

users may prefer png over jpeg for example

* add new-tiddler keyboard shortcut

* add keyboard shortcut configs

* add keyboard shortcuts ShortcutInfo

* add new-journal Keyboard shortcut

* add new-image keyboard shortcut

* Create Hidden Setting NewImageType.tid
2018-11-07 12:59:21 +00:00
Marxsal
16eb5e1e32 Doc: Updated info re free WebDAV hosting (#3017) 2018-11-06 15:35:58 +00:00
Marxsal
abda6dd078 Docs: How to customize TiddlyDesktop (#3018)
Adapted from Jeremy's post https://groups.google.com/d/msg/tiddlywiki/KXdrZyr9MZ4/pFPcZtu5DAAJ
2018-11-06 15:35:31 +00:00
Marxsal
729c1e1030 Add lt, gt, lteq, and gteq to text attribute description. (#3470) 2018-11-06 15:34:21 +00:00
Marxsal
88c47d9df4 Documentation resource - Dave Gifford's Toolmap (#3478)
* Documentation resource - Dave Gifford's Toolmap

* Updated description line
2018-11-06 15:33:54 +00:00
Marxsal
899fe7608b Doc - url fix for Timimi documentation (#3479) 2018-11-06 15:33:28 +00:00
Marxsal
7cd1c48643 Doc - additional notes re list widget behavior (#3480) 2018-11-06 15:33:00 +00:00
Jeremy Ruston
6dcdc2049a
Enhance search operator (#3502)
* Enhance search operator

* Add support for searching all fields

and also searching all fields except nominated fields.

* Docs tweaks

Thanks @pmario

* Error message improvements

* Improve error message formatting
2018-10-30 17:39:18 +00:00
Jermolene
a75434a347 Docs: fix date format example 2018-10-29 09:18:55 +00:00
Jermolene
9c849eb10a WebServer - change /login-basic route to /login/basic
To avoid clashing with tiddlers called "login-basic" :)

We also need to revise the rout for /status for the same reason, but there are backward compatibility issues there
2018-10-13 17:22:21 +01:00
Jermolene
240bd7bec4 Docs typo 2018-10-03 21:42:34 +01:00
Jermolene
eeb453d471 Docs update 2018-10-02 14:54:46 +01:00
Jermolene
f0c6a09ea7 Docs update 2018-10-02 14:19:06 +01:00
Jermolene
c208c55a22 Finish web server API docs 2018-10-02 14:16:58 +01:00
Jermolene
f162f4bc7b Typos missed from a9dd8c2 2018-09-28 18:18:07 +01:00
Jermolene
a9dd8c2f52 Use the new import pragma
Good for the core to show best practice
2018-09-28 16:25:54 +01:00
Jermolene
d5da7fd57c Docs updates 2018-09-28 16:02:04 +01:00
Jermolene
7022a98d5a Update splash screen example so that the macros work 2018-09-28 16:01:50 +01:00
Jermolene
fe85845c3c Add new "\import" pragma 2018-09-28 16:01:32 +01:00
Jermolene
f61a61c060 Improvements to splash screen documentation 2018-09-27 11:51:44 +01:00
Jermolene
86f2de0dda Fix typo in example splash screen
Missed off cfb2d7c
2018-09-27 10:11:54 +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
b776f9fe90 Remove version history of TiddlyDesktop
It's hard to keep the listing up to date (see https://github.com/Jermolene/TiddlyDesktop/issues/161), and so it's better to just point users at GitHub
2018-09-24 09:26:40 +01:00
Jermolene
f9eed0dc87 Docs about using the web server with external JS 2018-09-05 09:10:42 +01:00
Jeremy Ruston
3d10a35fb7
Add support for externalising TW's JavaScript (#3423)
* Explore externalising TiddlyWiki's JS core into a separate file

* Fix missing newline after copyright notice

* Add an error alert if tiddlywiki.js can't be loaded
2018-09-05 08:44:27 +01:00
Jermolene
8321d2e6fc Docs: webserver and read-only mode 2018-09-05 08:38:47 +01:00
Marxsal
d7b8c1c298 Community doc for Timimi extension (#3415) 2018-08-31 09:59:11 +01:00
Jermolene
19f7287a53 Add $:/tags/TiddlerInfoSegment for adding segments to the tiddler info panel 2018-08-30 13:42:51 +01:00
TechLifeWeb
5756f30edd Docs: Update TW5 Tribal Knowledge.tid (#3327)
This link has been long dead because DropBox changed their policy on public folders. I've moved the file and started making updates to it again.
2018-08-20 18:11:46 +01:00
Jermolene
ee28f66b0a Docs: tweaks to 'Macro Definitions in WikiText' 2018-08-20 17:55:32 +01:00
twMat
9a2e2cd385 Docs: Update Macro Definitions in WikiText.tid (#3381)
* Update Macro Definitions in WikiText.tid

*The table is intended as an overview.
*The "Parameters as Variables" example is more clean cut than previously.

Please note that the text lacks an example of  direct `<<variable>>` invocation (because I'm not even sure I categorize or name this properly). Also my changes may contain factual errors or faulty lingo - please check!

* Update Macro Definitions in WikiText.tid
2018-08-20 17:50:23 +01:00
Jermolene
11529ab399 Docs: clarify docs for "each" filter operator 2018-08-20 15:31:57 +01:00
Jens
0c965175aa Docs: Add description of suffix: value (#3393) 2018-08-19 18:37:37 +01:00
Jens
e92eb6a945 Docs: fix regexp default field (#3394) 2018-08-19 18:37:14 +01:00
twMat
dce564c238 Update doc on HTML Block vs Inline mode (#3395) 2018-08-19 18:24:23 +01:00
Arlen22
68b063ab24 Rename TiddlyWiki in the Sky to TiddlyWiki Cloud (#3398) 2018-08-19 18:23:27 +01:00
Jermolene
8a38685de9 Optionally adjust scroll targets to allow for a top menu bar
Fixes #3396
2018-08-16 12:07:50 +01:00
Jermolene
763f8afaf2 Add "contains" filter operator for searching list fields 2018-08-15 13:50:07 +01:00
Jermolene
3140ff9e49 Extent tm-full-screen message to support forcing the status
Now one can force "enter" or "exit", instead of just toggling the current status
2018-08-14 22:53:53 +01:00
Bimba Laszlo
b89e8d1635 Clarify the drag-n-drop behaviour (#3387)
* Clarify the drag-n-drop behaviour

In my case I misunderstood it: I thought that I need to select the text and
drag the selection, because drag-n-drop did not work by default.

* Fix grammar
2018-08-10 21:29:13 +01:00
Jermolene
bb9e2de861 Docs improvements 2018-08-08 10:47:10 +01:00
Jermolene
0285eb600e Clarify date format docs
Fixes #3369
2018-07-30 21:19:59 +01:00
Evan Balster
be58de8409 Add range operator and documentation (#3346) 2018-07-19 21:42:09 +01:00
twMat
e554561f95 [doc] Update CountWidget.tid (#3348)
* [doc] Update CountWidget.tid

* Update CountWidget.tid
2018-07-19 17:59:24 +01:00
twMat
57d6215fda [doc update] Custom_styles_by_data-tags.tid (#3355)
A few minor improvements that I propose are merged directly.

But, @pmario , we also need a clarifying example showing how to target a tiddler using *multiple* tags. So, under the examples there ought to be something like this:... BUT I fail to get this to work (syntax?):

```
[data-tags*="[[How to apply custom styles]] example-test"] {
  outline: 2px solid green;
}
```

Further, the text states that

`Important: Tiddler tags are not sorted, so the order in the rendered output may be different!`

...but I'm not sure what this means. Does it mean:

```
Important: A tiddlers tags are displayed alphabetically but rendered styles may come out in a different order. As per standard CSS behaviour, styles rendered later override styles rendered earlier.
```
2018-07-19 17:58:58 +01:00
twMat
fcccc85994 [doc] minor tweak to TranscludeWidget.tid (#3356) 2018-07-19 17:58:04 +01:00
snlhnk
c05c0d3df6 Module-ize server routes, add static file support and other enhancements(#2679)
* Module-ize server routes and add static file support (#2510)

* Refactor server routes to modules

New module type: serverroute

Caveats: Loading order is not deterministic but this would only matter
if two route modules attempted to use the same path regexp (that would
be silly).

* Add static assets plugin

This plugin allows the node server to fetch static assets in the /assets
directory. I felt that this was a feature that goes above the core
functionality. That is why I added it as a plugin. with the modular
route extensions this was a breeze.

* Add serverroute description to ModuleTypes

* Coding standards tweaks

* Fix filename typo

* Move support for attachments from a plugin into the core

* Missing "else"

* Refactor server handling

* Introduce a new named parameter scheme for commands
* Move the SimpleServer class into it's own module
* Deprecate the --server command because of the unwieldy syntax
* Add a new --listen command using the new syntax

For example:

tiddlywiki mywiki --listen host:0.0.0.0 port:8090

* Add check for unknown parameters

* Add support for multiple basic authentication credentials in a CSV file

Beware: Passwords are stored in plain text. If that's a problem, use an authenticating proxy and the trusted header authentication approach.

* Refactor module locations

* Rename "serverroute" module type to "route"

* Remove support for verifying optional named command parameters

The idea was to be able to flag unknown parameter names, but requiring a command to pre-specify all the parameter names makes it harder for (say) the listen command to be extensible so that plugins can add new optional parameters that they handle. (This is particularly in the context of work in progress to encapsulate authenticators into their own modules).

* Refactor the two authenticators into separate modules and add support for authorization

* Correct mistaken path.join vs. path.resolve

See https://stackoverflow.com/a/39836259

* Docs for the named command parameters

I'd be grateful if anyone with sufficient Windows experience could confirm that the note about double quotes in "NamedCommandParameters" is correct.

* Be consistent about lower case parameter names

* Do the right thing when we have a username but no password

With a username parameter but no password parameter we'll attribute edits to that username, but not require authentication.

* Remove obsolete code

* Add support for requiring authentication without restricting the username

* Refactor authorization checks

* Return read_only status in /status response

* Fix two code typos

* Add basic support for detecting readonly status and avoiding write errors

We now have syncadaptors returning  readonly status and avoid attempting to write to the server if it's going to fail

* Add readonly-styles

We hide editing-related buttons in read only mode

I've made this part of the tiddlyweb plugin but I think a case could be made for putting it into the core.

* Add custom request header as CSRF mitigation

By default we require the header X-Requested-With to be set to TiddlyWiki. Can be overriden by setting csrfdisable to "yes"

See https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet#Protecting_REST_Services:_Use_of_Custom_Request_Headers

* Add support for HTTPS

* First pass at a route for serving rendered tiddlers

cc @Drakor

* Tweaks to the single tiddler static view

Adding a simple sidebar

* Switch to "dash" separated parameter names

* Typo

* Docs: Update ServerCommand and ListenCommand

* First pass at docs for the new web server stuff

Writing the docs is turning out to be quite an undertaking, much harder than writing the code!

* Get rid of extraneous paragraphs in static renderings

* Rejig anonymous user handling

Now we can support wikis that are read-only for anonymous access, but allow a user to login for read/write access.

* More docs

Slowly getting there...

* Static tiddler rendering: Fix HTML content in page title

* Docs updates

* Fix server command parameter names

Missed off 30ce7ea

* Docs: Missing quotes

* Avoid inadvertent dependency on Node.js > v9.6.0

The listenOptions parameter of the plain HTTP version of CreateServer was only introduced in v9.6.0

cc @Drakor @pmario

* Typo
2018-07-18 16:54:43 +01:00
Jermolene
19b54fe905 Docs for the new tm-edit-text-operation save-selection action 2018-06-30 08:35:10 +01:00
Jermolene
2e51f08bef Add support for rebasing headings at render time
Fixes #3330
2018-06-10 15:54:23 +01:00
Jermolene
17e73befde Docs: Update IIS setup instructions
Reference to the wiki folder was incorrect
2018-06-01 10:30:46 +01:00
Jermolene
89f99151b3 Correction to the IIS installation instructions 2018-05-30 18:25:30 +01:00
Jermolene
33e636cbe7 Docs: Add popupmechanism link to Button widget docs
Fixes #3284
2018-05-16 16:23:57 +01:00
twMat
1436196758 Update search.tid (#3279)
minor correction
2018-05-15 15:44:03 +01:00
Jermolene
4fd980debe Docs: TiddlySpot and Ruby saver tweaks 2018-05-14 15:01:38 +01:00
Marxsal
38b24906c1 Docs: Saving via a minimal Ruby server (#3277)
* Saving via a minimal Ruby server

* Small grammatical mistake fix.
2018-05-14 14:56:00 +01:00
Jermolene
f355f07ff9 Preparing for release of v5.1.17 2018-05-12 11:46:06 +01:00
Jermolene
6e2b4ebf3e Remove print-tiddler-window button for v5.1.17
We'll reconsider it for v5.1.18
2018-05-12 11:20:43 +01:00
Jermolene
c5511854ab Reinstate TiddlySpot docs
Fixes #3269
2018-05-11 21:11:51 +01:00
Jermolene
85648590e5 Fix release date of v5.1.16 2018-05-10 15:54:59 +01:00
Jermolene
944010c3bf Release note update 2018-05-10 15:30:46 +01:00
Jermolene
737e9ae4cb Revert multiple suboperator functionality from the "is" operator
See the discussion here: https://github.com/Jermolene/TiddlyWiki5/pull/3240#issuecomment-388035466
2018-05-10 13:15:49 +01:00
Jermolene
523060e823 Add new "print tiddler" button for the view toolbar
It works by opening the tiddler in a new window and then triggering the browser print dialogue.
2018-05-10 11:33:23 +01:00
Matt Lauber
0ab9ec1ad3 Refactored the is operator for simplicity and efficiency. (#3240)
* Refactored the is operator for simplicity and efficiency.

* Improve `is` filter documentation.

* Update is.js

* extracted `subops.length` to `num_of_subops`
* renamed `subop` to `operator` for clarity/differentiation from `subops`
* refactored to avoid using a `Set` object.

* Update is.js
2018-05-09 18:07:08 +01:00
Daniel Rodríguez Rivero
715cb1d1bc Docs: Update RenderCommand.tid (#3263)
Adds a link that opens the advanced search with a filter to list all the template tiddlers.
2018-05-09 18:05:58 +01:00
Tobias Beer
a2606781b7 Docs: Add "Named vs unnamed parameters" section (#3022)
to clarify the risks of using unnamed parameters, esp. w/ states, see #1252
2018-05-09 18:01:03 +01:00
Jermolene
d4b4c3c936 New Release Banner for v5.1.17 2018-05-05 10:11:51 +01:00
twMat
38baa70bc6 Update Sharing your tiddlers with others.tid (#3254)
Just a little polishing up.
Ideally the icons should be styled to not be so big.
2018-05-04 10:48:11 +01:00
twMat
8464101430 [doc] Update RangeWidget.tid (#3251)
very minor correction
2018-05-03 17:49:52 +01:00
Jermolene
55453d463a Update release note 2018-05-02 17:09:24 +01:00
Jermolene
ac26c8829d Update release note 2018-05-02 16:04:43 +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
aab408109f Prepare for v5.1.17 2018-05-02 15:28:17 +01:00
Jermolene
d84a03c2d7 Preparing for v5.1.16 2018-04-25 18:33:53 +01:00
Jermolene
d77a3795b7 Update new release banner 2018-04-25 15:33:13 +01:00
Jermolene
3e707f6a51 Docs: add RangeWidget examples 2018-04-25 14:29:26 +01:00
Mario Pietsch
19085a1277 Add data attributes to ViewTemplate (#3209)
* change 3 set-widgets to 1 var-widget call. Add data-tags and userClass.

* add new documentation and change the existing one accordingly.
2018-04-24 22:08:20 +01:00