diff --git a/editions/prerelease/tiddlywiki.info b/editions/prerelease/tiddlywiki.info index 5b85f6fd5..8aef38bf5 100644 --- a/editions/prerelease/tiddlywiki.info +++ b/editions/prerelease/tiddlywiki.info @@ -4,7 +4,8 @@ "tiddlywiki/googleanalytics", "tiddlywiki/nodewebkitsaver", "tiddlywiki/github-fork-ribbon", - "tiddlywiki/browser-sniff" + "tiddlywiki/browser-sniff", + "tiddlywiki/help" ], "themes": [ "tiddlywiki/vanilla", diff --git a/editions/tw5.com/tiddlywiki.info b/editions/tw5.com/tiddlywiki.info index 1a7ef42c7..effb564fc 100644 --- a/editions/tw5.com/tiddlywiki.info +++ b/editions/tw5.com/tiddlywiki.info @@ -5,7 +5,8 @@ "tiddlywiki/nodewebkitsaver", "tiddlywiki/github-fork-ribbon", "tiddlywiki/browser-sniff", - "tiddlywiki/railroad" + "tiddlywiki/railroad", + "tiddlywiki/help" ], "themes": [ "tiddlywiki/vanilla", diff --git a/plugins/tiddlywiki/help/HelpPanel.tid b/plugins/tiddlywiki/help/HelpPanel.tid new file mode 100644 index 000000000..046c11a05 --- /dev/null +++ b/plugins/tiddlywiki/help/HelpPanel.tid @@ -0,0 +1,12 @@ +title: $:/plugins/tiddlywiki/help/HelpPanel +tags: $:/tags/PageTemplate + +<$reveal type="match" state="$:/config/ShowHelp" text="yes"> +
+
+<$button set="$:/config/ShowHelp" setTo="no" class="tc-btn-invisible">{{$:/core/images/close-button}} ''Help'' +
+<> +
+ + diff --git a/plugins/tiddlywiki/help/config/CurrentVideo.tid b/plugins/tiddlywiki/help/config/CurrentVideo.tid new file mode 100644 index 000000000..9e4a1e495 --- /dev/null +++ b/plugins/tiddlywiki/help/config/CurrentVideo.tid @@ -0,0 +1,3 @@ +title: $:/config/Help/CurrentVideo + +$:/plugins/tiddlywiki/help/Videos/Introduction \ No newline at end of file diff --git a/plugins/tiddlywiki/help/config/ShowHelp.tid b/plugins/tiddlywiki/help/config/ShowHelp.tid new file mode 100644 index 000000000..031c10f61 --- /dev/null +++ b/plugins/tiddlywiki/help/config/ShowHelp.tid @@ -0,0 +1,3 @@ +title: $:/config/ShowHelp + +no \ No newline at end of file diff --git a/plugins/tiddlywiki/help/help.tid b/plugins/tiddlywiki/help/help.tid new file mode 100644 index 000000000..2cdc12649 --- /dev/null +++ b/plugins/tiddlywiki/help/help.tid @@ -0,0 +1,28 @@ +title: $:/plugins/help/Buttons/help +tags: $:/tags/PageControls +caption: {{$:/core/images/help}} {{$:/language/Buttons/Help/Caption}} +description: {{$:/language/Buttons/Help/Hint}} + +\define help-inner() +<$reveal type="match" state="$:/config/ShowHelp" text="yes"> +<$button set="$:/config/ShowHelp" setTo="no" tooltip={{$:/language/Buttons/Help/Hint}} aria-label={{$:/language/Buttons/Help/Caption}} class="""$(tv-config-toolbar-class)$ tc-selected"""> +<$list filter="[prefix[yes]]"> +{{$:/core/images/help}} + +<$list filter="[prefix[yes]]"> +<$text text={{$:/language/Buttons/Help/Caption}}/> + + + +<$reveal type="nomatch" state="$:/config/ShowHelp" text="yes"> +<$button set="$:/config/ShowHelp" setTo="yes" tooltip={{$:/language/Buttons/Help/Hint}} aria-label={{$:/language/Buttons/Help/Caption}} class=<>> +<$list filter="[prefix[yes]]"> +{{$:/core/images/help}} + +<$list filter="[prefix[yes]]"> +<$text text={{$:/language/Buttons/Help/Caption}}/> + + + +\end +<> diff --git a/plugins/tiddlywiki/help/plugin.info b/plugins/tiddlywiki/help/plugin.info new file mode 100644 index 000000000..74a4d5e86 --- /dev/null +++ b/plugins/tiddlywiki/help/plugin.info @@ -0,0 +1,7 @@ +{ + "title": "$:/plugins/tiddlywiki/help", + "description": "Floating help window for TiddlyWiki", + "author": "JeremyRuston", + "core-version": ">=5.0.0", + "list": "readme" +} diff --git a/plugins/tiddlywiki/help/readme.tid b/plugins/tiddlywiki/help/readme.tid new file mode 100644 index 000000000..c4d64b9a8 --- /dev/null +++ b/plugins/tiddlywiki/help/readme.tid @@ -0,0 +1,3 @@ +title: $:/plugins/tiddlywiki/help/readme + +This plugin provides an overlay help panel at the bottom right of the window. diff --git a/plugins/tiddlywiki/help/styles.tid b/plugins/tiddlywiki/help/styles.tid new file mode 100644 index 000000000..9d8ee74c7 --- /dev/null +++ b/plugins/tiddlywiki/help/styles.tid @@ -0,0 +1,65 @@ +title: $:/plugins/tiddlywiki/help/styles +tags: [[$:/tags/Stylesheet]] + +\rules only filteredtranscludeinline transcludeinline macrodef macrocallinline + +.tc-help-panel { + position: fixed; + top: 2.5em; + bottom: 0; + right: 0; + width: 310px; + overflow: scroll; + -webkit-overflow-scrolling: touch; + <> + border: 1px solid <>; + background: <>; + padding: 1em; + margin: 0.5em; +} + +dl.tc-help-cheatsheet { + overflow: hidden; +} + +dl.tc-help-cheatsheet .red { + color: red; +} + +.tc-help-cheatsheet > dt { + display: block; + float: left; + clear: left; + margin: 2% 1em 0 0; + padding; + font-weight: normal; + width: 45%; +} + +.tc-help-cheatsheet > dt > pre { + margin: 0; +} + +.tc-help-cheatsheet > dd { + display: block; + float: left; + width: 45%; + margin: 1em 0 0 0; + padding: 0; +} + +.tc-help-cheatsheet > dd > p, +.tc-help-cheatsheet > dd > h1, +.tc-help-cheatsheet > dd > pre, +.tc-help-cheatsheet > dd > ul, +.tc-help-cheatsheet > dd > ol, +.tc-help-cheatsheet > dd > dl, +.tc-help-cheatsheet > dd > table, +.tc-help-cheatsheet > dd > blockquote, +.tc-help-cheatsheet > dd > blockquote >p { + margin: 0; +} + +.tc-help-cheatsheet .tc-image { + width: 16px; +} diff --git a/plugins/tiddlywiki/help/tabs/Cheatsheet.tid b/plugins/tiddlywiki/help/tabs/Cheatsheet.tid new file mode 100644 index 000000000..db0960d0c --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/Cheatsheet.tid @@ -0,0 +1,776 @@ +title: $:/plugins/tiddlywiki/help/HelpPanel/Cheatsheet +tags: $:/tags/HelpPanel +caption: Cheatsheet + +
+
+ +``` +''bold'' +``` +
+
''bold''
+ +
+ +``` +//italics// +``` +
+
//italics//
+ +
+ +``` +''//bold italics//'' +``` +
+
''//bold italics//''
+ +
+ +``` +__underline__ +``` +
+
__underline__
+ +
+ +``` +~~strikethrough~~ +``` +
+
~~strikethrough~~
+ +
+ +``` +super^^script^^ +``` +
+
super^^script^^
+ +
+ +``` +sub,,script,, +``` +
+
sub,,script,,
+ +
+ +``` +foo -- bar +foo --- bar +``` +
+
foo -- bar (En dash)
foo --- bar (Em dash)
+ +
+ +``` +!Heading 1 +!!Heading 2 +!!!Heading 3 +``` +
+
+ +!Heading 1 +!!Heading 2 +!!!Heading 3 +
+ +
+ +``` +--- +horizontal rules +
+``` +
+
+ +--- +horizontal rules +
+
+ +
`code`
+
`code` ...via backticks
+ +
``with `backticks` ``
+
``with `backticks` ``
+ +
+
```
+monospaced
+codeblock
+```
+
+ +
+ +``` +monospaced +codeblock +``` +
+ +
+ +``` +""" +force +hard +linebreaks +like +this... +""" +``` +
+ + +
+ +""" +force +hard +linebreaks +like +this... +""" +
+ +
+ +``` +...since +new paragraphs +need two linebreaks + +in tw5 +``` +
+ +
+ +...since +new paragraphs +need two linebreaks + +in tw5 +
+ + +
+ +``` +> block +>> quotes +>>> are easy +``` +
+ +
+ +> block +>> quotes +>>> are
easy +
+ + +
+ +``` +<<< +real +easy +<<< +``` +
+ +
+ +<<< +real +easy +<<< +
+ + +
+ +``` +* unordered +** list +``` +
+ +
+ +* unordered +** list +
+ +
+ +``` +# ordered +## list +``` +
+ +
+ +# ordered +## list +
+ +
+ +``` +;definition +:term +``` +
+ +
+ +;definition +:term +
+ +
+ +``` +# mixed +#* lists +#;you +#:know +#>like so +``` +
+ +
+ +# mixed +#* lists +#;you +#:know +#>like so +
+ +
+ +``` +!.h1-class.red CSS +#.li-class.red classes +*.li-class.red can be +;.dt-class.red assigned +:.dd-class.red like +>.blockquote-class.red this +``` +
+ +
+ +!.h1-class.red CSS +#.li-class.red classes +*.li-class.red can be +;.dt-class.red assigned +:.dd-class.red like +>.blockquote-class.red this +
+ + +
+ +``` +[[The Tiddler]] +[[pretty title|The Tiddler]] +``` +
+
+ +[[The Tiddler]]
+[[pretty title|The Tiddler]] +
+ +
+ +``` +CamelCase +~SuppressedCamelCase +``` +
+
+ +CamelCase
+~SuppressedWikiLink +
+ +
+ +``` +http://tiddlywiki.com +[[pretty|http://pretty.com]] +~http://not.alink.com +``` +
+
+ +http://tiddlywiki.com
+[[google|http://google.com]]
+~http://not.alink.com +
+ +
+ +``` +file://///windows/network
+file:///c:/Windows/foo
+file:///linux/local
+``` +
+
+ +file://///windows/network
+file:///c:/Windows/foo
+file:///linux/local
+`file:///` only via local tw! +
+ +
+ +``` +[ext[forced.link.com]] +[ext[tw|tiddlywiki.com]] +[ext[foo|file:///c:/foo]] +[ext[relative/path]] +``` +
+
+ +[ext[forced.link.com]]
+[ext[tw|tiddlywiki.com]]
+[ext[foo|file:///c:/foo]]
+[ext[relative/path]] +
+ +
+ +``` +[img[example.jpg]] +[img[tooltip|example.jpg]] +[img width=16 [example.jpg]] +[img class="tc-image" [example.jpg]] +``` +
+ +
+ +[img[http://www.tiddlywiki.com/favicon.ico]]
+[img[tooltip|http://www.tiddlywiki.com/favicon.ico]]
+[img width=16 [http://www.tiddlywiki.com/favicon.ico]]
+[img class="tc-image" [http://www.tiddlywiki.com/favicon.ico]] +
+ +
+ +``` +[img[http://www.tiddlywiki.com/favicon.ico]] +[img[path/image.jpg]] +``` +
+ +
+ +[img[http://www.tiddlywiki.com/favicon.ico]] +
+ +
+ +``` +[img width={{!!mywidth}} class=<> [example.jpg]] + +{{example.jpg}} +``` +
+ +
+ +params via +[[transclusion|http://tiddlywiki.com/#Transclusion%20in%20WikiText]] or +[[macro|http://tiddlywiki.com/#Macros%20in%20WikiText]]


+ +embed via transclusion +
+ + +
+ +``` +@@.myStyleClass.red +;term +:definition +@@ +``` +
+ +
+ +@@.myStyleClass.red +;term +:definition +@@ +
+ +
+ +``` +@@color:red; +;css styles +:apply directly like this +@@ + +@@color:red; or this @@ +``` +
+ +
+ +@@color:red; +;css styles +:apply directly like this +@@ + +@@color:red; or this @@ +
+ +
+ +``` +@@.tc-tiddler-frame +@@width:200px;height:50px; +or combine both +@@ +``` +
+ +
+ +@@.tc-tiddler-frame +@@width:200px;height:50px; +or combine both +@@ +
+ +
+ +``` +@@.purple Am I purple?@@ + + +``` +
+
+@@.purple Am I purple?@@ + + +
+ +
+ +``` +| !Header | !Header | Mhhh ?!? | +|^NE |^ N |^ NW| +|W | ✦ | E| +|,SW |, S |, SE| +|merge|left|<| +|and|now| vertical | +|>| right|~| +``` +
+
+ +| !Header | !Header | Mhhh ?!? | +|^NW |^ @@padding:0 7px 14px 7px;display:block; N@@ |^ NE| +|W | ✦ | @@padding:7px 0;display:block; E@@| +|,SW |, @@padding:14px 7px 0 7px;display:block; S@@ |, SE| +|merge|left|<| +|and|now| vertical | +|>| right|~| +
+ + +
+ +``` +
+HTML tags work like that. + +
+``` +
+ +
+ +
+HTML tags work like that. + +
+
+ +
+ +``` +link +>>bold +``` +
+ +
+ +link +>>bold + +set attributes via transclusion or macro +
+ + +
+ +``` +
inspect me!
+``` +
+ +
+ +
inspect me!
+
+ + +
+ +``` +*nest
+ +;via +:html +
+``` +
+ +
+ +*nest
+ +;via +:html +
+
+ + +
+ +``` +{{Foo}} +{{Foo||Bar}} +{{||Foo}} +{{Foo!!bar}} +{{!!bar}} +{{Foo##index}} +{{##index}} +{{{ [tag[Foo]] }}} +{{{ [tag[Foo]] ||Bar}}} +``` +
+ +
+ +» [[transcludes|http://tiddlywiki.com/#Transclusion%20in%20WikiText]] tiddler `Foo`
+» `Foo` with template `Bar`
+» template `Foo` for `CurrentTiddler`
+» field `bar` of `Foo`
+» field `bar` of `CurrentTiddler`
+» `index` of datatiddler `Foo`
+» `index` of `CurrentTiddler` (=data)
+» list of tiddlers tagged `Foo`
+» same using template `Bar` +
+ + +
+ +``` +\define run(foo:'bar') [[$foo$]] + +<> +``` +
+
+ +» defines macro `run`
+» with parameter `foo`
+» whose value defaults to `bar`
+» outputs a link to value of param:
+  [[foo bar]] +
+ +
+ +``` +\define test() +I am $(x)$. +\end + +<$set name="x" value="y +of z"> +<> + +``` +
+ +
+ +» defines macro test which
+» outputs value of variable x

+ +» sets variable x to: "y
+  of z" //(multiline allowed)//
+» runs macro test which outputs:
+  "I am y of z." +
+ +
+ +``` +\define test(x, y, z:'0') +$x$ $y$ $z$ +\end + +<$macrocall +$name="test" +x=<> +y={{!!title}}/> +``` +
+ +
+ +» defines macro test
+» outputs 3 params

+ +» calls test via macrocall widget
+» using macro version as param x
+» and transclusion as param y

+ +» outputs:
+  <> Markup 0 +
+ + + +
+ +``` +$$$text/unknown +plain text, not //formatted// +$$$ +``` +
+
+ +$$$text/unknown +plain text, not //formatted// +$$$ + +
+These are [[Typed Blocks|http://tiddlywiki.com/#Typed%20Blocks%20in%20WikiText]] +
+ + +
+ +``` +$$$image/svg+xml + + + +$$$ +``` +
+
+ +$$$image/svg+xml + + + +$$$ +
+ +
+ +``` +$$$.svg + + + +$$$ +``` +
+
+ +$$$.svg + + + +$$$ +
+ +
+ +``` +$$$text/vnd.tiddlywiki>text/html +This is ''some'' wikitext +$$$ +``` +
+
+ +$$$text/vnd.tiddlywiki>text/html +This is ''some'' wikitext +$$$ +
+ +
+ +``` +$$$text/vnd.tiddlywiki>text/plain +This is ''some'' wikitext +$$$ +``` +
+
+ +$$$text/vnd.tiddlywiki>text/plain +This is ''some'' wikitext +$$$ +
+ + +
diff --git a/plugins/tiddlywiki/help/tabs/Support.tid b/plugins/tiddlywiki/help/tabs/Support.tid new file mode 100644 index 000000000..3a5e955d7 --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/Support.tid @@ -0,0 +1,13 @@ +title: $:/plugins/tiddlywiki/help/HelpPanel/Support +tags: $:/tags/HelpPanel +caption: Support + +~TiddlyWiki is an open source project with a vibrant community of users and developers. We're always happy to help new users get the most from ~TiddlyWiki. + +Join the ~TiddlyWiki mailing list: + +http://groups.google.com/group/TiddlyWiki + +Post bug reports to the ~TiddlyWiki ~GitHub repository: + +https://github.com/Jermolene/TiddlyWiki5 diff --git a/plugins/tiddlywiki/help/tabs/Videos.tid b/plugins/tiddlywiki/help/tabs/Videos.tid new file mode 100644 index 000000000..9744a5cc7 --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/Videos.tid @@ -0,0 +1,24 @@ +title: $:/plugins/tiddlywiki/help/HelpPanel/Videos +tags: $:/tags/HelpPanel +caption: Videos + +\define show-video-inner(embed) + +\end + +\define show-video(title) +<$macrocall $name="show-video-inner" embed={{$title$!!embed}}/> +

{{$title$!!text}}

+\end + +
+ +Choose video: <$select tiddler="$:/config/Help/CurrentVideo"> +<$list filter="[all[shadows+tiddlers]tag[$:/tags/HelpPanel/Videos]]"> + + + + +<$macrocall $name="show-video" title={{$:/config/Help/CurrentVideo}}>> + +
diff --git a/plugins/tiddlywiki/help/tabs/videos/FirefoxAndroid.tid b/plugins/tiddlywiki/help/tabs/videos/FirefoxAndroid.tid new file mode 100644 index 000000000..cd0e2d9ab --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/videos/FirefoxAndroid.tid @@ -0,0 +1,6 @@ +title: $:/plugins/tiddlywiki/help/Videos/FirefoxAndroid +tags: $:/tags/HelpPanel/Videos +caption: Firefox for Android +embed: iikkv9orGGI + +How to get started with using TiddlyWiki as a standalone HTML file with the TiddlyFox add-on for Firefox for Android. diff --git a/plugins/tiddlywiki/help/tabs/videos/GettingStarted.tid b/plugins/tiddlywiki/help/tabs/videos/GettingStarted.tid new file mode 100644 index 000000000..f44d449be --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/videos/GettingStarted.tid @@ -0,0 +1,6 @@ +title: $:/plugins/tiddlywiki/help/Videos/GettingStarted +tags: $:/tags/HelpPanel/Videos +caption: GettingStarted +embed: 1g66s7UbyuU + +How to get started with using TiddlyWiki as a standalone HTML file. diff --git a/plugins/tiddlywiki/help/tabs/videos/Introduction.tid b/plugins/tiddlywiki/help/tabs/videos/Introduction.tid new file mode 100644 index 000000000..671f34926 --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/videos/Introduction.tid @@ -0,0 +1,6 @@ +title: $:/plugins/tiddlywiki/help/Videos/Introduction +tags: $:/tags/HelpPanel/Videos +caption: Introduction +embed: KtCUr83XgyE + +An introduction to the concepts of TiddlyWiki. diff --git a/plugins/tiddlywiki/help/tabs/videos/TiddlyDesktop.tid b/plugins/tiddlywiki/help/tabs/videos/TiddlyDesktop.tid new file mode 100644 index 000000000..8b07970d1 --- /dev/null +++ b/plugins/tiddlywiki/help/tabs/videos/TiddlyDesktop.tid @@ -0,0 +1,6 @@ +title: $:/plugins/tiddlywiki/help/Videos/TiddlyDesktop +tags: $:/tags/HelpPanel/Videos +caption: TiddlyDesktop +embed: i3Bggkm7paA + +Using TiddlyDesktop, the custom desktop TiddlyWiki application for Windows, OS X and Linux.