From 0fbfdce4b662763db57f4e8b5463fdb0292ce29f Mon Sep 17 00:00:00 2001 From: Mario Pietsch Date: Tue, 12 Mar 2024 09:54:09 +0100 Subject: [PATCH 1/5] Add $:/StoryList to gitignore for tiddlywiki-com branch (#8065) --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 0ab5b300f..412759161 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ node_modules/ /test-results/ /playwright-report/ /playwright/.cache/ +$__StoryList.tid From 8481b7d1372a88a76ec474b9ac10234dc0c2b50e Mon Sep 17 00:00:00 2001 From: Mario Pietsch Date: Tue, 12 Mar 2024 09:56:12 +0100 Subject: [PATCH 2/5] Dev edition: change layout to fluid-fixed (#8063) --- .../$__themes_tiddlywiki_vanilla_options_sidebarlayout.tid | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 editions/dev/tiddlers/system/$__themes_tiddlywiki_vanilla_options_sidebarlayout.tid diff --git a/editions/dev/tiddlers/system/$__themes_tiddlywiki_vanilla_options_sidebarlayout.tid b/editions/dev/tiddlers/system/$__themes_tiddlywiki_vanilla_options_sidebarlayout.tid new file mode 100644 index 000000000..2f4dcb4e0 --- /dev/null +++ b/editions/dev/tiddlers/system/$__themes_tiddlywiki_vanilla_options_sidebarlayout.tid @@ -0,0 +1,6 @@ +created: 20240311150859344 +modified: 20240311150859344 +title: $:/themes/tiddlywiki/vanilla/options/sidebarlayout +type: text/vnd.tiddlywiki + +fluid-fixed \ No newline at end of file From 0e7d566df7dc5e03f2a3c0dc630e8434fd5ccacf Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Tue, 12 Mar 2024 17:16:51 +0000 Subject: [PATCH 3/5] Add link to demo of TiddlyWiki as a library in other Node.js apps --- editions/dev/tiddlers/HelloThere.tid | 1 + editions/dev/tiddlers/new/Using TiddlyWiki as a library.tid | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 editions/dev/tiddlers/new/Using TiddlyWiki as a library.tid diff --git a/editions/dev/tiddlers/HelloThere.tid b/editions/dev/tiddlers/HelloThere.tid index e3b8979a8..bae281fb9 100644 --- a/editions/dev/tiddlers/HelloThere.tid +++ b/editions/dev/tiddlers/HelloThere.tid @@ -16,6 +16,7 @@ Welcome to the developer documentation for TiddlyWiki (https://tiddlywiki.com/). ** [[Adding Babel Polyfill to TiddlyWiki]] ** [[TiddlyWiki Drag and Drop Interoperability]] ** [[Javascript Widget Tutorial]] +** [[Using TiddlyWiki as a library in another Node.js application]] * The original developer documentation from https://tiddlywiki.com: ** [[TiddlyWiki for Developers]] ** [[TiddlyWiki Coding Style Guidelines]] diff --git a/editions/dev/tiddlers/new/Using TiddlyWiki as a library.tid b/editions/dev/tiddlers/new/Using TiddlyWiki as a library.tid new file mode 100644 index 000000000..983b7b7fd --- /dev/null +++ b/editions/dev/tiddlers/new/Using TiddlyWiki as a library.tid @@ -0,0 +1,5 @@ +title: Using TiddlyWiki as a library in another Node.js application + +Node.js applications can include TiddlyWiki as a library so that they can use wikitext rendering. + +See the demo at https://github.com/Jermolene/TiddlyWiki5DemoApp \ No newline at end of file From edfd27fa458ba2fafe243c33595ea37a20c9f547 Mon Sep 17 00:00:00 2001 From: Mateusz Wilczek <36714554+mateuszwilczek@users.noreply.github.com> Date: Tue, 12 Mar 2024 21:54:45 +0100 Subject: [PATCH 4/5] Improve filter run prefix docs (#8067) --- .../tiddlers/filters/syntax/Map Filter Run Prefix.tid | 4 ++-- .../tiddlers/filters/syntax/Sort Filter Run Prefix.tid | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/editions/tw5.com/tiddlers/filters/syntax/Map Filter Run Prefix.tid b/editions/tw5.com/tiddlers/filters/syntax/Map Filter Run Prefix.tid index fdce6ab39..c4f8b437a 100644 --- a/editions/tw5.com/tiddlers/filters/syntax/Map Filter Run Prefix.tid +++ b/editions/tw5.com/tiddlers/filters/syntax/Map Filter Run Prefix.tid @@ -1,6 +1,6 @@ created: 20210618133745003 from-version: 5.2.0 -modified: 20230710073315595 +modified: 20240312202834547 rp-input: the filter output of all previous runs so far rp-output: the input titles as modified by the result of this filter run rp-purpose: modify input titles by the result of evaluating this filter run for each item @@ -12,7 +12,7 @@ type: text/vnd.tiddlywiki <$railroad text=""" \start none \end none -( ":map" | - ) +( ":map" (: ":flat" | - ) | - ) [[run|"Filter Run"]] """/> diff --git a/editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid b/editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid index 0197425ad..e17b88356 100644 --- a/editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid +++ b/editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid @@ -1,6 +1,6 @@ created: 20210428083929749 from-version: 5.2.0 -modified: 20230322140722470 +modified: 20240312203002082 rp-input: the filter output of all previous runs so far rp-output: output titles replace the output of previous filter runs rp-purpose: sort the input titles by the result of evaluating this filter run for each item @@ -12,9 +12,9 @@ type: text/vnd.tiddlywiki <$railroad text=""" \start none \end none -( ":sort" ) +( ( ":sort" ) ( : ":string" | ":alphanumeric" | ":number" | ":integer" | ":version" | ":date" ) -( : ":casesensitive" /"required for string and alphanumeric"/ | ":caseinsensitive" /"required for string and alphanumeric"/ | ":reverse" /"optional"/ | - ) +( : ":casesensitive" /"required for string and alphanumeric"/ | ":caseinsensitive" /"required for string and alphanumeric"/ | ":reverse" /"optional"/ | - ) | - ) [[run|"Filter Run"]] """/> From 21a5841aab608ffd1aa1581859152270bafb92dc Mon Sep 17 00:00:00 2001 From: Mateusz Wilczek <36714554+mateuszwilczek@users.noreply.github.com> Date: Wed, 13 Mar 2024 13:17:14 +0100 Subject: [PATCH 5/5] Add links to and instructions about Saq's PR Maker in docs (#8068) --- .../tiddlers/TiddlyWiki Docs PR Maker.tid | 12 ++++++++++ .../Improving TiddlyWiki Documentation.tid | 22 ++++++++++++++++++- .../tiddlers/system/ContributionBanner.tid | 10 ++++++--- editions/tw5.com/tiddlers/system/Sources.tid | 19 ++++++++++++---- 4 files changed, 55 insertions(+), 8 deletions(-) create mode 100644 editions/tw5.com/tiddlers/TiddlyWiki Docs PR Maker.tid diff --git a/editions/tw5.com/tiddlers/TiddlyWiki Docs PR Maker.tid b/editions/tw5.com/tiddlers/TiddlyWiki Docs PR Maker.tid new file mode 100644 index 000000000..dd32a653b --- /dev/null +++ b/editions/tw5.com/tiddlers/TiddlyWiki Docs PR Maker.tid @@ -0,0 +1,12 @@ +created: 20240313100515958 +modified: 20240313103959789 +tags: Editions +title: TiddlyWiki Docs PR Maker + +''~TiddlyWiki Docs PR Maker'' is a special edition of tiddlywiki.com designed to help you contribute to and improve the documentation made by [[@saqimtiaz|https://github.com/saqimtiaz/]]. + +https://saqimtiaz.github.io/tw5-docs-pr-maker/ + +All changes made to the documentation can be very easily submitted to GitHub -- the pull request will be automatically made, hence the "PR Maker" name of the edition. + +You will need to create a free ~GitHub account and sign the [[Contributor License Agreement]] before using the Docs PR Maker. You can find more details about contributing to the documentation [[here|Improving TiddlyWiki Documentation]]. diff --git a/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid b/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid index 3e73d8705..363934f54 100644 --- a/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid +++ b/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid @@ -1,5 +1,5 @@ created: 20140820151051019 -modified: 20190115165616599 +modified: 20240313114828368 tags: Community title: Improving TiddlyWiki Documentation type: text/vnd.tiddlywiki @@ -8,9 +8,29 @@ Anyone can submit improvements to the TiddlyWiki documentation that appears on h <<.warning """If you already know GitHub, note that documentation updates must be directed to the `tiddlywiki-com` branch""">> +! Before you start editing + # Read and observe the [[Documentation Style Guide]] # Create an account on https://github.com if you don't already have one # If you haven't done so already, sign the [[Contributor License Agreement]] as described in [[Signing the Contributor License Agreement]] + +! Editing and submitting your edits + +You can choose to edit the documentation using the [[TiddlyWiki Docs PR Maker]] or directly in ~GitHub. The first method is especially recommended for users not familiar with ~GitHub. + +!! Using [[Docs PR Maker|TiddlyWiki Docs PR Maker]] edition + +# Go to https://saqimtiaz.github.io/tw5-docs-pr-maker/ or click the link displayed in the ribbon underneath the title when editing a tiddler on tiddlywiki.com +# Go through the quick introduction where you will need to provide your ~GitHub username and a ~GitHub access token (you will be guided in creating one) +# Edit or create tiddlers to update the documentation, the wiki will keep track of all changes +# Click the "Submit updates" button and check if all the tiddlers that you edited are included in the submission; if not, drag them into the box +# Provide a concise title and description of your changes (see the rules about titling pull requests in [[contribution guidelines|Contributing]]) +# Submit your changes: +** "Save as draft" will create a //draft// pull request, this is useful if you don't want the changes to be merged //yet//, because you want to work on it later or discuss it first +** "Submit documentation update" will create a pull request, which will be immediately available for review and merging + +!! Using ~GitHub + # On https://tiddlywiki.com, click "edit" on the tiddler you want to improve # You should see a pink banner with the text: //Can you help us improve this documentation? Find out how to edit this tiddler on ~GitHub// # Click on the external link ...''this tiddler on ~GitHub'' diff --git a/editions/tw5.com/tiddlers/system/ContributionBanner.tid b/editions/tw5.com/tiddlers/system/ContributionBanner.tid index 0cd359079..d955f92d3 100644 --- a/editions/tw5.com/tiddlers/system/ContributionBanner.tid +++ b/editions/tw5.com/tiddlers/system/ContributionBanner.tid @@ -1,6 +1,8 @@ -title: $:/ContributionBanner -tags: $:/tags/EditTemplate +created: 20240313115309914 list-after: $:/core/ui/EditTemplate/title +modified: 20240313115810689 +tags: $:/tags/EditTemplate +title: $:/ContributionBanner \define base-github() https://github.com/Jermolene/TiddlyWiki5/edit/tiddlywiki-com/editions/tw5.com/tiddlers/ @@ -10,7 +12,9 @@ https://github.com/Jermolene/TiddlyWiki5/edit/tiddlywiki-com/editions/tw5.com/ti <$list filter="[[$:/config/OriginalTiddlerPaths]getindex]" variable="target" >
{{$:/core/images/star-filled}} Can you help us improve this documentation? [[Find out how|Improving TiddlyWiki Documentation]] to -addprefix] }}} class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer">edit this tiddler on ~GitHub +encodeuricomponent[]addprefix[https://saqimtiaz.github.io/tw5-docs-pr-maker/#]] }}} class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer">edit this tiddler in Docs PR Maker +or +addprefix] }}} class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer">edit it directly on ~GitHub
diff --git a/editions/tw5.com/tiddlers/system/Sources.tid b/editions/tw5.com/tiddlers/system/Sources.tid index d28d9fc05..086df3077 100644 --- a/editions/tw5.com/tiddlers/system/Sources.tid +++ b/editions/tw5.com/tiddlers/system/Sources.tid @@ -1,7 +1,9 @@ -title: $:/editions/tw5.com/TiddlerInfo/Sources -tags: $:/tags/TiddlerInfo caption: Sources code-body: yes +created: 20240313090915565 +modified: 20240313115026563 +tags: $:/tags/TiddlerInfo +title: $:/editions/tw5.com/TiddlerInfo/Sources \function static-link-base() [[https://tiddlywiki.com/static/$(title)$.html]substitute[]] @@ -29,19 +31,28 @@ code-body: yes class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer" - >Direct link to <$text text=<>/> on github.com + >Link to "<$text text=<>/>" on github.com \end +\procedure make-pr-maker-link() +encodeuricomponent[]addprefix[https://saqimtiaz.github.io/tw5-docs-pr-maker/#]] }}} + class="tc-tiddlylink-external" + target="_blank" + rel="noopener noreferrer" +>Link to "<$text text=<>/>" in Docs PR Maker edition +\end + <$list filter="[all[current]!is[system]!is[shadow]]"> A static HTML representation of this tiddler is available at the URL: * <> -Help us to improve the documentation by suggesting changes to this tiddler using the [[TiddlyWiki Docs PR Maker|https://saqimtiaz.github.io/tw5-docs-pr-maker/]] +Help us to [[improve the documentation|Improving TiddlyWiki Documentation]] by suggesting changes to this tiddler using the [[TiddlyWiki Docs PR Maker]] or directly on ~GitHub. +* <> * <>