From ec50c156a4b1c112d40102b9c7fb3e5149f18dcd Mon Sep 17 00:00:00 2001 From: pmario Date: Mon, 17 Jun 2024 11:54:02 +0200 Subject: [PATCH 1/5] Update description for tiddlywiki.info --- tiddlywiki.info | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiddlywiki.info b/tiddlywiki.info index 827c40b654..01db9c889f 100644 --- a/tiddlywiki.info +++ b/tiddlywiki.info @@ -1,5 +1,5 @@ { - "description": "Empty edition", + "description": "TW Contribute", "plugins": [ "tiddlywiki/tiddlyweb", "tiddlywiki/filesystem" From 4ce741fb028f32228c8f01066ac40ec2d1696661 Mon Sep 17 00:00:00 2001 From: pmario Date: Mon, 17 Jun 2024 11:54:21 +0200 Subject: [PATCH 2/5] give tour buttons a small radius --- plugins/tour/styles.tid | 1 + 1 file changed, 1 insertion(+) diff --git a/plugins/tour/styles.tid b/plugins/tour/styles.tid index d726283a83..d36c47f399 100644 --- a/plugins/tour/styles.tid +++ b/plugins/tour/styles.tid @@ -26,6 +26,7 @@ tags: $:/tags/Stylesheet } .tc-tour-panel-navigation .tc-btn-big-green { + border-radius: 0.25em; margin: 0; } From 3fa84a1b0a5483c193b994cab03f89ca3ee4ece7 Mon Sep 17 00:00:00 2001 From: pmario Date: Mon, 17 Jun 2024 11:54:52 +0200 Subject: [PATCH 3/5] improve tour panel --- plugins/tour/tour-panel.tid | 46 +++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 12 deletions(-) diff --git a/plugins/tour/tour-panel.tid b/plugins/tour/tour-panel.tid index b389f73183..62e439d71b 100644 --- a/plugins/tour/tour-panel.tid +++ b/plugins/tour/tour-panel.tid @@ -1,24 +1,46 @@ title: $:/plugins/tiddlywiki/tour/panel tags: $:/tags/PageTemplate +\procedure _tour-prevButton() +<$list filter="[all[shadows+tiddlers]tag[$:/tags/TourStep]before{$:/state/tour/step}count[]compare:number:gt[0]]" variable="ignore"> + <$button class="tc-btn-big-green" style="background-color: red;"> + <$action-setfield $tiddler="$:/state/tour/step" $field="text" $value={{{ [all[shadows+tiddlers]tag[$:/tags/TourStep]allbefore{$:/state/tour/step}filterlast[]] :else[all[shadows+tiddlers]tag[$:/tags/TourStep]first[]] }}}/> + {{$:/plugins/tiddlywiki/tour/actions/initialise-current-tour-step}} + back + + +\end + +\procedure _tour-nextButton() +<$button class="tc-btn-big-green" style="background-color: purple;"> + <$action-setfield $tiddler="$:/state/tour/step" $field="text" $value={{{ [all[shadows+tiddlers]tag[$:/tags/TourStep]allafter{$:/state/tour/step}filterfirst[]] :else[all[shadows+tiddlers]tag[$:/tags/TourStep]last[]] }}}/> + {{$:/plugins/tiddlywiki/tour/actions/initialise-current-tour-step}} + next + +\end + +\procedure _tour-closeButton() +<$button class="tc-btn-big-green"> + <$action-setfield $tiddler="$:/config/ShowTour" $field="text" $value="no"/> + Close Tour + +\end + \procedure tour-buttons() \procedure tv-action-refresh-policy() always
- <$list filter="[all[shadows+tiddlers]tag[$:/tags/TourStep]before{$:/state/tour/step}count[]compare:number:gt[0]]" variable="ignore"> - <$button class="tc-btn-big-green" style="background-color: red;"> - <$action-setfield $tiddler="$:/state/tour/step" $field="text" $value={{{ [all[shadows+tiddlers]tag[$:/tags/TourStep]allbefore{$:/state/tour/step}filterlast[]] :else[all[shadows+tiddlers]tag[$:/tags/TourStep]first[]] }}}/> - {{$:/plugins/tiddlywiki/tour/actions/initialise-current-tour-step}} - back - - - <$button class="tc-btn-big-green" style="background-color: purple;"> - <$action-setfield $tiddler="$:/state/tour/step" $field="text" $value={{{ [all[shadows+tiddlers]tag[$:/tags/TourStep]allafter{$:/state/tour/step}filterfirst[]] :else[all[shadows+tiddlers]tag[$:/tags/TourStep]last[]] }}}/> - {{$:/plugins/tiddlywiki/tour/actions/initialise-current-tour-step}} - next - +<<_tour-prevButton>> <<_tour-nextButton>>
\end +\procedure tour-close() +\procedure tv-action-refresh-policy() always +
+ <<_tour-prevButton>> <<_tour-closeButton>> +
+\end + + \procedure filter-by-condition() [has[condition]subfilter{!!condition}limit[1]] :else[!has[condition]then[true]] \end From 6bc82f4835bad30a8140e6603176256a160ca5af Mon Sep 17 00:00:00 2001 From: pmario Date: Mon, 17 Jun 2024 11:55:15 +0200 Subject: [PATCH 4/5] make access-token-link a config tiddler for code reuse --- plugins/contribute/tour/config/access-token-link.tid | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 plugins/contribute/tour/config/access-token-link.tid diff --git a/plugins/contribute/tour/config/access-token-link.tid b/plugins/contribute/tour/config/access-token-link.tid new file mode 100644 index 0000000000..f48a3ab970 --- /dev/null +++ b/plugins/contribute/tour/config/access-token-link.tid @@ -0,0 +1,3 @@ +title: $:/plugins/sq/contribute/tour/config/access-token-link + +[[Create an access token|https://github.com/settings/tokens/new?scopes=public_repo]] \ No newline at end of file From bed913161e3a32b66e1fd80d37d07f6c025522ea Mon Sep 17 00:00:00 2001 From: pmario Date: Mon, 17 Jun 2024 11:56:11 +0200 Subject: [PATCH 5/5] rename files to make development easier, improve user workflow --- plugins/contribute/Contribute Settings.tid | 2 ++ .../steps/$__contribute-docs_tour_steps_tracking.tid | 9 --------- ...steps_contribute-button.tid => contribute-button.tid} | 6 ++++-- ...docs_tour_steps_access-token.tid => access-token.tid} | 2 +- ...steps_end-of-fullscreen.tid => end-of-fullscreen.tid} | 0 ..._tour_steps_github-account.tid => github-account.tid} | 0 ...r_steps_how-does-it-work.tid => how-does-it-work.tid} | 0 ...docs_tour_steps_requirements.tid => requirements.tid} | 0 ...__contribute-docs_tour_steps_cla.tid => sign-cla.tid} | 0 ...ontribute-docs_tour_steps_welcome.tid => welcome.tid} | 0 plugins/contribute/tour/steps/tracking.tid | 9 +++++++++ 11 files changed, 16 insertions(+), 12 deletions(-) delete mode 100644 plugins/contribute/tour/steps/$__contribute-docs_tour_steps_tracking.tid rename plugins/contribute/tour/steps/{$__contribute-docs_tour_steps_contribute-button.tid => contribute-button.tid} (76%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_access-token.tid => access-token.tid} (89%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_end-of-fullscreen.tid => end-of-fullscreen.tid} (100%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_github-account.tid => github-account.tid} (100%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_how-does-it-work.tid => how-does-it-work.tid} (100%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_requirements.tid => requirements.tid} (100%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_cla.tid => sign-cla.tid} (100%) rename plugins/contribute/tour/steps/fullscreen/{$__contribute-docs_tour_steps_welcome.tid => welcome.tid} (100%) create mode 100644 plugins/contribute/tour/steps/tracking.tid diff --git a/plugins/contribute/Contribute Settings.tid b/plugins/contribute/Contribute Settings.tid index b0201e5d39..e0f2e32cda 100644 --- a/plugins/contribute/Contribute Settings.tid +++ b/plugins/contribute/Contribute Settings.tid @@ -9,5 +9,7 @@ Repository: ~GitHub access token: <$password name="github-docs-pr"/> +{{$:/plugins/sq/contribute/tour/config/access-token-link}} + ~GitHub username (only needed for signing the CLA): <$edit-text tiddler="$:/temp/contribute/gitusername" class="tc-edit-texteditor" tag="input"/> \ No newline at end of file diff --git a/plugins/contribute/tour/steps/$__contribute-docs_tour_steps_tracking.tid b/plugins/contribute/tour/steps/$__contribute-docs_tour_steps_tracking.tid deleted file mode 100644 index 00193de5e7..0000000000 --- a/plugins/contribute/tour/steps/$__contribute-docs_tour_steps_tracking.tid +++ /dev/null @@ -1,9 +0,0 @@ -tags: $:/tags/TourStep -title: $:/plugins/sq/contribute/tour/steps/tracking -type: text/vnd.tiddlywiki - -! Edit and create tiddlers to update the documentation - -The wiki will keep track of all tiddlers that you create or modify so that you can easily submit them once you have finished editing. - -<> \ No newline at end of file diff --git a/plugins/contribute/tour/steps/$__contribute-docs_tour_steps_contribute-button.tid b/plugins/contribute/tour/steps/contribute-button.tid similarity index 76% rename from plugins/contribute/tour/steps/$__contribute-docs_tour_steps_contribute-button.tid rename to plugins/contribute/tour/steps/contribute-button.tid index 768950a424..d50edbd52e 100644 --- a/plugins/contribute/tour/steps/$__contribute-docs_tour_steps_contribute-button.tid +++ b/plugins/contribute/tour/steps/contribute-button.tid @@ -1,10 +1,12 @@ -hint: where is the submission form button? +hint: Show the submission button selector: .submit-docs-banner a tags: $:/tags/TourStep title: $:/plugins/sq/contribute/tour/steps/contribute-button -! Edit and create tiddlers to update the documentation +!! Edit and create tiddlers to update the documentation Once you are ready to submit your work, open the submission form using the button in the bottom right corner. In this form you can review which tiddlers will be submitted, and provide a short description of your changes. + +<> diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_access-token.tid b/plugins/contribute/tour/steps/fullscreen/access-token.tid similarity index 89% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_access-token.tid rename to plugins/contribute/tour/steps/fullscreen/access-token.tid index ee39e2de26..8390716b3c 100644 --- a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_access-token.tid +++ b/plugins/contribute/tour/steps/fullscreen/access-token.tid @@ -11,7 +11,7 @@ condition: [password-exists[github-docs-pr]match[no]] The link below will open the ~GitHub page for creating an access token with the minimum required permissions already selected. Add a note to remind yourself what the access token is for, and create the token and copy it. -[[Create an access token|https://github.com/settings/tokens/new?scopes=public_repo]] +{{$:/plugins/sq/contribute/tour/config/access-token-link}} Please enter below the access token you have created: diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_end-of-fullscreen.tid b/plugins/contribute/tour/steps/fullscreen/end-of-fullscreen.tid similarity index 100% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_end-of-fullscreen.tid rename to plugins/contribute/tour/steps/fullscreen/end-of-fullscreen.tid diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_github-account.tid b/plugins/contribute/tour/steps/fullscreen/github-account.tid similarity index 100% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_github-account.tid rename to plugins/contribute/tour/steps/fullscreen/github-account.tid diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_how-does-it-work.tid b/plugins/contribute/tour/steps/fullscreen/how-does-it-work.tid similarity index 100% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_how-does-it-work.tid rename to plugins/contribute/tour/steps/fullscreen/how-does-it-work.tid diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_requirements.tid b/plugins/contribute/tour/steps/fullscreen/requirements.tid similarity index 100% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_requirements.tid rename to plugins/contribute/tour/steps/fullscreen/requirements.tid diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_cla.tid b/plugins/contribute/tour/steps/fullscreen/sign-cla.tid similarity index 100% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_cla.tid rename to plugins/contribute/tour/steps/fullscreen/sign-cla.tid diff --git a/plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_welcome.tid b/plugins/contribute/tour/steps/fullscreen/welcome.tid similarity index 100% rename from plugins/contribute/tour/steps/fullscreen/$__contribute-docs_tour_steps_welcome.tid rename to plugins/contribute/tour/steps/fullscreen/welcome.tid diff --git a/plugins/contribute/tour/steps/tracking.tid b/plugins/contribute/tour/steps/tracking.tid new file mode 100644 index 0000000000..ca6f85f2ea --- /dev/null +++ b/plugins/contribute/tour/steps/tracking.tid @@ -0,0 +1,9 @@ +tags: $:/tags/TourStep +title: $:/plugins/sq/contribute/tour/steps/tracking +type: text/vnd.tiddlywiki + +!! Edit and create tiddlers to update the documentation + +This wiki will keep track of all tiddlers that you create or modify so that you can easily submit them once you have finished editing. + +<> \ No newline at end of file