Skip to content

Commit

Permalink
Merge branch 'tiddlywiki-com'
Browse files Browse the repository at this point in the history
  • Loading branch information
Jermolene committed Jul 24, 2024
2 parents b8ed59f + 2aec572 commit 0c9d61d
Show file tree
Hide file tree
Showing 12 changed files with 125 additions and 62 deletions.
2 changes: 1 addition & 1 deletion bin/ci-pre-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ npm --force install tiddlywiki || exit 1

# Pull existing GitHub pages content

git clone --depth=1 --branch=master "https://github.com/Jermolene/jermolene.github.io.git" output
git clone --depth=1 --branch=master "https://github.com/TiddlyWiki/tiddlywiki.com-gh-pages.git" output
2 changes: 1 addition & 1 deletion bin/ci-push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ git config --global user.email "[email protected]"
git config --global user.name "GitHub Actions"
git add -A .
git commit --message "GitHub build: $GITHUB_RUN_NUMBER of $TW5_BUILD_BRANCH ($(date +'%F %T %Z'))"
git remote add deploy "https://$GH_TOKEN@github.com/Jermolene/jermolene.github.io.git" &>/dev/null
git remote add deploy "https://$GH_TOKEN@github.com/TiddlyWiki/tiddlywiki.com-gh-pages.git" &>/dev/null
git push deploy master &>/dev/null
cd ..
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Nonetheless, you may find techniques that are useful for your own scripts.

! Hosting

https://tiddlywiki.com is served by [[GitHub Pages|https://pages.github.com]] from the repository https://github.com/Jermolene/jermolene.github.io
https://tiddlywiki.com is served by [[GitHub Pages|https://pages.github.com]] from the repository https://github.com/TiddlyWiki/tiddlywiki.com-gh-pages

The scripts live in the repository https://github.com/Jermolene/build.jermolene.github.io

Expand All @@ -15,7 +15,7 @@ The scripts live in the repository https://github.com/Jermolene/build.jermolene.
These scripts require the following directories to be siblings:

* `build.jermolene.github.io` - a local copy of https://github.com/Jermolene/build.jermolene.github.io
* `jermolene.github.io` - a local copy of the repo https://github.com/Jermolene/jermolene.github.io
* `jermolene.github.io` - a local copy of the repo https://github.com/TiddlyWiki/tiddlywiki.com-gh-pages
* `TiddlyWiki5` - a local copy of the repo https://github.com/Jermolene/TiddlyWiki5

The scripts are designed to be executed with the current directory being the `TiddlyWiki5` directory.
Expand Down
6 changes: 3 additions & 3 deletions editions/tw5.com/tiddlers/about/Archive.tid
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20231005205623086
modified: 20240628132622052
modified: 20240723172222378
tags: About
title: TiddlyWiki Archive

Expand All @@ -8,10 +8,10 @@ title: TiddlyWiki Archive
5.1.10 5.1.11 5.1.12 5.1.13 5.1.14 5.1.15 5.1.16 5.1.17 5.1.18 5.1.19
5.1.20 5.1.21 5.1.22 5.1.23
5.2.0 5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.2.7
5.3.0 5.3.1 5.3.2 5.3.3 5.3.4
5.3.0 5.3.1 5.3.2 5.3.3 5.3.4 5.3.5
\end

Older versions of TiddlyWiki are available in the [[archive|https://github.com/Jermolene/jermolene.github.io/tree/master/archive]]:
Older versions of TiddlyWiki are available in the [[archive|https://github.com/TiddlyWiki/tiddlywiki.com-gh-pages/tree/master/archive]]:

<table>
<tbody>
Expand Down
2 changes: 1 addition & 1 deletion editions/tw5.com/tiddlers/definitions/GitHub.tid
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ GitHub is a hosting service for distributed projects that use git as their versi

The code and documentation of TiddlyWiki is hosted on ~GitHub at:

https://github.com/Jermolene/TiddlyWiki5
https://github.com/TiddlyWiki/TiddlyWiki5

~GitHub also offer a free web hosting service called [[GitHub Pages|https://pages.github.com/]] that can be used directly from the single file configuration. See [[Saving to a Git service]].

Expand Down
5 changes: 3 additions & 2 deletions editions/tw5.com/tiddlers/releasenotes/Release 5.3.5.tid
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
caption: 5.3.5
created: 20240710115948992
modified: 20240710115948992
description: Bugfix release for v5.3.4
modified: 20240723172616735
released: 20240710153600000
tags: ReleaseNotes
title: Release 5.3.5
type: text/vnd.tiddlywiki
description: Under development

//[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.3.4...v5.3.5]]//

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
created: 20240721163229297
description: Reveal widget for accordion or slider functionality
modified: 20240721172211283
tags: $:/tags/wiki-test-spec
title: TestCases/RevealWidget/AccordionSlider
type: text/vnd.tiddlywiki-multiple

title: Narrative

Two distinct buttons toggle the state of the tiddler value. Two reveal widgets. The first displays the button to show the content. The second displays both the content and the button to hide the content.
+
title: Output

<$reveal type="nomatch" state="$:/state/SampleReveal2" text="show">

<$button set="$:/state/SampleReveal2" setTo="show">Show me</$button>

</$reveal>
<$reveal type="match" state="$:/state/SampleReveal2" text="show">

<$button set="$:/state/SampleReveal2" setTo="hide">Hide me</$button>

! This is the revealed content
And this is some text

</$reveal>
+
title: ExpectedResult

<div class=" tc-reveal"><p><button class="">Show me</button></p></div><div class=" tc-reveal" hidden="true"></div>
27 changes: 27 additions & 0 deletions editions/tw5.com/tiddlers/testcases/RevealWidget/Popup.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
created: 20240721163229297
description: Reveal widget for popup content
modified: 20240721172211283
tags: $:/tags/wiki-test-spec
title: TestCases/RevealWidget/Popup
type: text/vnd.tiddlywiki-multiple

title: Narrative

When the button is clicked, the tiddler specified by the popup attribute is filled with the click coordinates. The reveal widget uses these coordinates to position the popup content.
+
title: Output

<$button popup="$:/SamplePopupState">Pop me up!</$button>

<$reveal type="popup" state="$:/SamplePopupState">
<div class="tc-drop-down">

! This is the popup
And this is some text

</div>
</$reveal>
+
title: ExpectedResult

<p><button aria-expanded="false" class="">Pop me up!</button></p><p><span class=" tc-reveal" hidden="true"></span></p>
27 changes: 27 additions & 0 deletions editions/tw5.com/tiddlers/testcases/RevealWidget/SimpleReveal.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
created: 20240721163229297
description: Simple content reveal
modified: 20240721172211283
tags: $:/tags/wiki-test-spec
title: TestCases/RevealWidget/SimpleReveal
type: text/vnd.tiddlywiki-multiple

title: Narrative

Two distinct buttons toggle the state of the tiddler value. The reveal widget displays its content for one of the two states.
+
title: Output

<$button set="$:/state/SampleReveal1" setTo="show">Show me</$button>
<$button set="$:/state/SampleReveal1" setTo="hide">Hide me</$button>

<$reveal type="match" state="$:/state/SampleReveal1" text="show">

! This is the revealed content
And this is some text

</$reveal>
+
title: ExpectedResult

<p><button class="">Show me</button>
<button class="">Hide me</button></p><div class=" tc-reveal" hidden="true"></div>
23 changes: 23 additions & 0 deletions editions/tw5.com/tiddlers/testcases/RevealWidget/TextReference.tid
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
created: 20240721163229297
description: Reveal widget text references
modified: 20240721174826529
tags: $:/tags/wiki-test-spec
title: TestCases/RevealWidget/TextReference
type: text/vnd.tiddlywiki-multiple

title: Narrative

The state attribute of the reveal widget can use the text reference syntax to refer to a specific field. In this example if the field ``jeremy`` contains the text ``tiddlywiki``, then the reveal widget's content will be displayed.
+
title: Output
jeremy: tiddlywiki

<$reveal type="match" state="!!jeremy" text="tiddlywiki">
~TiddlyWiki!
</$reveal>
+
title: ExpectedResult

<p><span class=" tc-reveal">
TiddlyWiki!
</span></p>
57 changes: 5 additions & 52 deletions editions/tw5.com/tiddlers/widgets/RevealWidget.tid
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
caption: reveal
created: 20131024141900000
jeremy: tiddlywiki
modified: 20230803052644851
modified: 20240721175716320
tags: Widgets
title: RevealWidget
type: text/vnd.tiddlywiki
Expand Down Expand Up @@ -47,57 +47,10 @@ This is useful for edge-cases where titles may contain characters that are used

! Examples

!! Simple content reveal
<<testcase TestCases/RevealWidget/SimpleReveal>>

Here's a simple example of showing and hiding content with buttons:
<<testcase TestCases/RevealWidget/AccordionSlider>>

<<wikitext-example-without-html '<$button set="$:/state/SampleReveal1" setTo="show">Show me</$button>
<$button set="$:/state/SampleReveal1" setTo="hide">Hide me</$button>
<<testcase TestCases/RevealWidget/Popup>>

<$reveal type="match" state="$:/state/SampleReveal1" text="show">

! This is the revealed content
And this is some text

</$reveal>'>>

!! Accordion or Slider

An "accordion" or "slider" is a button that can be used to toggle the display of associated content.

<<wikitext-example-without-html '<$reveal type="nomatch" state="$:/state/SampleReveal2" text="show">

<$button set="$:/state/SampleReveal2" setTo="show">Show me</$button>

</$reveal>
<$reveal type="match" state="$:/state/SampleReveal2" text="show">

<$button set="$:/state/SampleReveal2" setTo="hide">Hide me</$button>

! This is the revealed content
And this is some text

</$reveal>'>>

!! Popup

Here is a simple example of a popup built with the RevealWidget:

<<wikitext-example-without-html '<$button popup="$:/SamplePopupState">Pop me up!</$button>

<$reveal type="popup" state="$:/SamplePopupState">
<div class="tc-drop-down">

! This is the popup
And this is some text

</div>
</$reveal>'>>

!! How to use text references with field content

Here is a simple example how to use text references with field content to control the RevealWidget. If the field ``jeremy`` is populated with text ``tiddlywiki``, a message will be displayed.

<<wikitext-example-without-html '<$reveal type="match" state="!!jeremy" text="tiddlywiki">
~TiddlyWiki!
</$reveal>'>>
<<testcase TestCases/RevealWidget/TextReference>>
2 changes: 2 additions & 0 deletions licenses/cla-individual.md
Original file line number Diff line number Diff line change
Expand Up @@ -581,3 +581,5 @@ Andrei Rybak, @rybak, 2024/06/09
@andrewgoz, 2024/07/10

Michael McDermott, @michaeljmcd, 2024-07-09

@webplusai, 2024/07/23

0 comments on commit 0c9d61d

Please sign in to comment.