1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-18 11:29:55 +00:00
Commit Graph

258 Commits

Author SHA1 Message Date
BurningTreeC
b18c85b85c Add How-To documentation for keyboard shortcuts (#3588)
* add link to "How to"  keyboard shortcuts + styles

* add "How to create keyboard shortcuts"

* Update How to create keyboard shortcuts.tid

* Update How to create keyboard shortcuts.tid

* Update How to create keyboard shortcuts.tid
2018-11-29 09:49:48 +00:00
Marxsal
fe52d5462f Document tweaks to TOC for newcomers (#3518) 2018-11-29 09:46:41 +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
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
Jermolene
f61a61c060 Improvements to splash screen documentation 2018-09-27 11:51:44 +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
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
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
Marxsal
eae573b9dd Doc: How to hide author's name (#3162)
* Doc: How to hide author's name

* Rename tiddler. Add additional fields to hide.

* Small tweaks

* Removed creator field leftover from testing.

* New instructions for hiding author

* New instructions for hiding author #2
2018-03-14 18:10:56 +00:00
Marxsal
0a1152b83a Simple methods to write protect tiddlers (#3163) 2018-03-10 14:47:47 +00:00
Marxsal
c65ca8060c Doc: Include text field in Custom Journal Button (#3012) 2017-11-15 16:35:54 +00:00
Jermolene
54b1e284fa Docs updates
Missing .tid extensions were causing those tiddlers to be mis-read.
2017-11-14 12:46:21 +00:00
Jermolene
304eb99d41 Docs updates 2017-11-14 12:31:35 +00:00
Jermolene
021b5e072b Updated GettingStarted material about saving changes 2017-11-13 14:00:01 +00:00
Jermolene
29364cbd08 Change http://*.tiddlywiki.com/* to https:// 2017-11-11 11:56:20 +00:00
Thomas Herlea
6091b12eb0 Corrected "currentVariable" to "currentTiddler". (#2859) 2017-06-29 17:04:13 +01:00
Jermolene
5b3bb1974c Move coding docs to the /dev wiki 2017-03-19 13:53:21 +00:00
gernert
9a67a90a30 Update Using Stylesheets.tid (#2786) 2017-02-27 15:54:15 +00:00
Jermolene
6282fe43af Docs capitalisation consistency
Thanks @twMat
2017-02-05 13:34:37 +00:00
twMat
e20682dcfd Update title to "How to Add a New Tab to the Sidebar" (#2754)
Only title modified, from lowercase to uppercase letters.
2017-02-04 18:06:17 +00:00
Jermolene
0e37e0cd78 Fix typo 2017-01-13 08:17:31 -07:00
Marxsal
b152d0a727 Doc: How to concatenate text and variables (#2676)
* How to concatenate text and variables

* Adding warnings around anti-example code
2017-01-09 12:39:50 +00:00
Marxsal
18280249f4 Doc: How to turn off camel case (#2687)
* Doc: How to turn off camel case

* Changed title. Added tag.
2017-01-03 18:07:48 +00:00
Marxsal
a37137d426 DOC: How to embed PDFs and other documents (#2678)
* How to embed PDFs and other documents

* Adding notes about external linking and other details
2016-12-31 13:21:32 +00:00
Marxsal
5b5b25dd16 Docs: Add how-tos on putting list into table format (#2672)
* Document method(s) to format the output of a list in tabular format.

* Added  2nd CSS method for formatting as Table

* Three methods of putting lists into table form.

* Removed "probably" comment
2016-12-30 17:45:44 +00:00
Bram Chen
352d7d664c Chinese translation updates (#2666)
Typo
2016-12-19 12:22:39 +00:00
Marxsal
7d1e3f4c35 Add docs for making a custom New Journal button (#2664)
Includes change to 'Creating journal tiddlers' to link up to new Instructional tiddler.
2016-12-19 11:27:50 +00:00
Tobias Beer
15c7d24eaa Allows adding a new tag name by typing enter (#2592)
* allows to add a new tagname hitting enter

see: https://groups.google.com/forum/#!topic/tiddlywiki/wqQ8jPYG-X4

* revert changes to vanilla/base

* added "Special Keys" to KeyboardShortcuts

* added info to Creating and editing tiddlers

did not add current version of <<.from-version "5.1.14">>  because it
would interrupt the flow. When changed from a noisy "New in 5.1.14" to
"(new in 5.1.14)" we might add the version info here

* revert setText & added inline styles to vanilla base

* remove fieldmangler

* commit initial edittemplate tags to merge master

* ok, now really revert to initial edittemplate tags

* move add tag via enter into tag-picker macro(s)
2016-12-18 20:43:26 +00:00
Marxsal
52d32fe3fd Howto1 (#2659)
* Create One weird trick to change the sort order of sub-branches in a TOC macro

* Update and rename One weird trick to change the sort order of sub-branches in a TOC macro to How to change the sort order of sub-branches in a TOC macro

* Added .tid to file name

* Delete How to change the sort order of ...

The correct version is the one with the .tid file extension
2016-12-16 17:47:08 +00:00
Marxsal
2319c9269e Create How to widen tiddlers (aka story river) (#2651) 2016-12-16 17:40:05 +00:00
Devin Weaver
aaf884b70a Add this.document to ES2016 documentation (#2314)
In the sample example for using ES2016 it used the
`$tw.utils.domMaker()`. I just found out that if this code is executed
by Node.js instead of in the browser that it doesn't work because
`window.document` doesn't exist. The expectation is that widgets pass in
the fake `this.document`.

I updated the example to reflect this.
2016-07-11 13:46:22 +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
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
387198d9d9 Add instructions for adding a table of contents tab to the sidebar 2016-04-24 16:15:11 +01:00
Paulus
dcffd93a28 Update docs for GitHub ribbon plugin (#2384)
* Outdated source of Corner ribbon plugin

No sources provided for  [[$:/plugins/tiddlywiki/github-fork-ribbon]].
Edition aims to its current source in the plugin library and updates the plugin name

* CamelCase link override for visual clarity

* typo corrected
2016-04-22 16:06:19 +01:00
Jeremy Ruston
2adf09129d Introduce text editor toolbar (#2315)
Tada!
2016-04-22 08:36:29 +01:00
Jeremy Ruston
a19b4eeeed Merge pull request #2219 from sukima/feature/babel-plugins
Using ES2016 for Writing Plugins HowTo Documentation
2016-02-11 09:36:35 +00:00
Devin Weaver
f79856a6d7 Add Adding Babel Polyfill to TiddlyWiki
Having the ability to write your plugins with ES2015 syntax is nice but
it is missing a large part of the ES2015 spec. Since not all browsers
support this a polyfill is offered.

So far it is IE10 which holds the need for the polyfill. This tiddler
offers a simple how to on adding the babel-polyfill to your TiddlyWiki.

NOTE: This how to would be obsolete if a proper ES2015 polyfill was part
of the official plugins offered in core. (Want a pull request?)
2016-01-12 12:51:30 -05:00
Devin Weaver
d7c4c87c8c Add Using ES2016 for Writing Plugins
I found using Babel for creating plugins was very helpful. I wanted to
share how I integrated ES2015 into my TiddlyWiki development tool bag.
2016-01-12 12:51:30 -05:00
Devin Weaver
8bf867560c Add Editing Tiddlers with Vim
We have one for Emacs so we need one for Vim. Besides, Vim has never
done me wrong.
2016-01-11 21:45:23 -05:00
Marxsal
79972fe57f Applying recomendations
Giving better descriptive names to sub-headings
2015-10-06 10:36:19 -07:00
Marxsal
5163b541cf A primer on how to export tiddlers
Showing how to export individual, selection, or all tiddlers.
2015-10-06 09:11:21 -07:00
Jermolene
6b3dd1bb63 Release note and docs updates 2015-10-05 09:53:18 +01:00
Jermolene
8e12d4cb70 Correct typo 2015-06-23 10:49:58 +01:00
Devin Weaver
8bcf38b0ae Add ability to auto generate Dropbox URL
I felt the conversion from the Dropbox share URL to the "secret" URL was
complicated enough to have the tiddler do it for the user. And so I
wrote a widget to do that. The user enters in the shared URL given by
Dropbox and the widget outputs the secret URL that they can copy / paste
with.

See if it is worth having on the TW5.com site.
2015-06-14 19:17:17 -04:00
Marxsal
d18ad1e853 Update: How to Apply Custom Styles
The former instructions didn't explain how class names with special characters could be used in stylesheets. This adds explanation about escaping the % symbol.
2015-06-08 11:11:24 -07:00
Jermolene
cf0671f97f Docs folder adjustments 2015-05-22 09:05:25 +01:00
Jermolene
6942efa628 Add styling for <kbd> elements 2015-05-14 10:16:33 +01:00
Jermolene
98a8df0ace Improve SVG curved text docs 2015-05-05 07:38:00 +01:00
Jermolene
28421038e4 Tweak SVG example for dark palettes 2015-04-28 09:11:11 +01:00
Jermolene
8dca128725 Docs updates 2015-04-13 07:51:01 +01:00
Hong-Yi Dai
2140ae2b51 Fix a typo 2015-04-04 07:48:32 +08:00
Jermolene
b13d87fdf2 Overhaul the macro and variable documentation #1519 2015-02-24 17:41:16 +01:00
Astrid Elocson
e6d204db0f Adjust documentation following pull #1378 2015-01-27 15:44:55 +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
1905093411 Change TiddlerChain to TitleList 2014-12-23 21:57:18 +00:00
Astrid Elocson
25e447f69e Rephrase route through tabs
Provisionally, rather than using any sort of arrow symbol. We need to standardise a notation for referring to hierarchical UI, but that will come with the documentation style guide.
2014-12-23 21:46:20 +00:00
Astrid Elocson
7ca37739aa Simplify style of arrow in tab hierarchy
This is something that
2014-12-23 17:32:45 +00:00
Astrid Elocson
8e47a20069 Improvements to wording 2014-12-23 14:59:16 +00:00
Astrid Elocson
3ca2a113e3 add missing word 2014-12-22 10:18:00 +00:00
Astrid Elocson
9c0611582f fix typo 2014-12-22 10:17:08 +00:00
Astrid Elocson
c66d9339ab spelling mistake 2014-12-22 10:16:13 +00:00
Jeremy Ruston
3b9677c052 Merge pull request #1263 from aelocson/patch-1
Fix punctuation
2014-12-22 09:18:55 +00:00
Astrid Elocson
5f9f0764bd Normalise names of tabs, etc to bold 2014-12-21 18:52:57 +00:00
Astrid Elocson
176a372314 Fix punctuation 2014-12-21 18:49:24 +00:00
Jeremy Ruston
c5bb95dbfb Merge pull request #1243 from Spangenhelm/patch-1
Proposing to change to a more appropriate tag / category
2014-12-19 14:48:44 +00:00
Jermolene
5fa8a1e08a Docs tweaks 2014-12-19 14:48:12 +00:00
Jeremy Ruston
c8e2c2ceb9 Merge pull request #1240 from tobibeer/patch-3
Update Using Stylesheets.tid
2014-12-19 14:40:31 +00:00
Florent V.
93660bdea8 Little typo corrections 2014-12-17 14:57:37 +01:00
Florent V.
abebff78ba Proposing to change to a more appropriate tag / category
From "Feature" To "Customise TiddlyWiki"
2014-12-17 14:50:30 +01:00
Tobias Beer
bc447410fe Update Using Stylesheets.tid
added documentation for html in StyleSheets

https://groups.google.com/d/msg/tiddlywiki/Qx0y7btud5M/Ch6hMnh0ud0J

simplified the specificity section, some rewording
2014-12-16 08:33:21 +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
Jermolene
fa43f45e18 FIx typo
Thanks again @BramChen!
2014-12-08 13:09:31 +00:00
Jermolene
f1001fc236 Clean up static sites docs
Thanks @BramChen
2014-12-08 12:11:32 +00:00
Jim Lehmer
4aa8fc6d1d Altered command order for generating static sites in how-to because rendertiddlers wipes out the output directory so it needs to come first, not last. 2014-12-07 15:08:51 -06:00
malgam
7657a6960b Fix type "importer" should be "exporter" 2014-11-28 08:41:14 +10:00
Jermolene
6b15a01f9c Added docs for custom export formats 2014-11-24 17:42:31 +00:00
Jermolene
1015196817 Proper sentence case for tiddler title 2014-11-24 16:24:36 +00:00
Jermolene
61718d6023 Docs tweaks 2014-11-23 18:26:48 +00:00
Jeremy Ruston
242a753bbe Merge pull request #1091 from Marxsal/patch-3
Doc: How to Add A Menu to the Sidebar
2014-11-23 18:19:54 +00:00
Jermolene
c4c51feee2 Clean up github contribution banner
Sorry @xcazin I think you may need to do some clearing up after this
2014-11-23 17:54:11 +00:00
Jermolene
ac5c6d1d73 Docs tweak 2014-11-23 13:37:45 +00:00
Jermolene
86329835c9 Add instructions for contribution ribbon 2014-11-23 10:06:09 +00:00
Marxsal
4aa140b16c Doc: How to Add A Menu to the Sidebar
This item is tagged so as to appear under Customise TiddlyWiki.
2014-11-17 09:11:36 -08:00
Andrey Yankin
79c77966df missing backtick 2014-11-01 22:47:47 +03:00
Devin Weaver
176ad5adde Add direct link to github ribbon plugin
The former documentation referenced a plugin but left no easy way to
link to it. Also, the misleading text claiming a title also confused me.
I had to do some creative greping the git files to hunt it down.

Adding a TiddlyWiki link around the plugin links to the actual tiddler
that a reader could easily copy. This also deprecated the need for the
misleading title.
2014-10-31 21:24:21 -04:00
Jermolene
80e67f5028 Docs tweaks 2014-10-24 18:02:34 +01:00
Yaka
47b99d635a some doc updates 2014-10-21 11:07:49 +00:00
Jermolene
561aaa925b Filename typo 2014-10-20 18:06:08 +01:00
Jermolene
cf12bcd58a Docs updates 2014-10-20 16:12:24 +01:00
Jermolene
244b3256a9 Docs on putting last modification date in banner 2014-10-20 12:24:28 +01:00
Jermolene
b8ac80fd1a Docs tweaks 2014-10-20 12:09:02 +01:00
Jeremy Ruston
1914b3d8e1 Merge pull request #932 from Marxsal/patch-1
Create How to apply custom style classes by tag
2014-10-19 18:07:28 +01:00
Jermolene
21a791cdcd Docs updates 2014-10-17 16:29:27 +01:00
Jermolene
2d25c40227 Remove backslashes from example commands 2014-10-13 09:59:34 +01:00
Jermolene
6ec87efb5a Remove references to $TW5_BUILD_OUTPUT 2014-10-13 09:56:52 +01:00