From 952d84448dfd7aeae0afec95b1193b012f565a9f Mon Sep 17 00:00:00 2001
From: Cindy Ruan <80615570+cdruan@users.noreply.github.com>
Date: Sun, 23 May 2021 21:39:50 -0700
Subject: [PATCH] Move the user doc to the tw5.com edition.
---
core/language/en-GB/Snippets/ExtJSReadme.tid | 19 -------------------
...Using the external JavaScript template.tid | 18 ++++++++++++++++--
2 files changed, 16 insertions(+), 21 deletions(-)
delete mode 100644 core/language/en-GB/Snippets/ExtJSReadme.tid
diff --git a/core/language/en-GB/Snippets/ExtJSReadme.tid b/core/language/en-GB/Snippets/ExtJSReadme.tid
deleted file mode 100644
index f2b68f48e..000000000
--- a/core/language/en-GB/Snippets/ExtJSReadme.tid
+++ /dev/null
@@ -1,19 +0,0 @@
-title: $:/language/Snippets/ExtJSReadme
-
-This is an addendum to the ~TiddlyWiki documentation—[[Using the external JavaScript template|https://tiddlywiki.com/#Using%20the%20external%20JavaScript%20template]]:
-
-...
-
-To properly save your snapshot for offline use, it is necessary to set the text of the tiddler $:/config/SaveWikiButton/Template to ~$:/core/save/offline-external-js. You must also save a copy of twcore-TIDDLYWIKI_VERSION.js in the same folder as your HTML file. From your own wiki, open the tiddler [[$:/language/Snippets/GetTiddlyWikiJS]]. It will show you how to acquire ~TiddlyWiki's core ~JavaScript.
-
-The provided edition "server-external-js" contains all the configuration necessary to use the external ~JavaScript template.
-
-!! Upgrading
-
-Before you proceed, backup your wiki first! Upgrading a single-file wiki with the external-js template will be a three-step process:
-
-# Follow the standalone file ~TiddlyWiki [[Upgrading]] process. Your wiki will be converted to a full standalone HTML.
-
-# From the upgraded wiki, open the tiddler [[$:/language/Snippets/GetTiddlyWikiJS]]. Click on the "Export ~TiddlyWiki Core" button to obtain the new release of ~TiddlyWiki's core ~JavaScript.
-
-# Verify that $:/config/SaveWikiButton/Template still contains `$:/core/save/offline-external-js`. Save your wiki again. It is now converted to using the external core.
diff --git a/editions/tw5.com/tiddlers/webserver/Using the external JavaScript template.tid b/editions/tw5.com/tiddlers/webserver/Using the external JavaScript template.tid
index be1e8cddd..0d9000498 100644
--- a/editions/tw5.com/tiddlers/webserver/Using the external JavaScript template.tid
+++ b/editions/tw5.com/tiddlers/webserver/Using the external JavaScript template.tid
@@ -1,5 +1,5 @@
created: 20180905075846391
-modified: 20200814110131083
+modified: 20210523210131083
tags: [[WebServer Guides]]
title: Using the external JavaScript template
type: text/vnd.tiddlywiki
@@ -10,10 +10,24 @@ Setting the [[root-tiddler|WebServer Parameter: root-tiddler]] parameter to `$:/
tiddlywiki editions/tw5.com-server/ --listen host=0.0.0.0 "root-tiddler=$:/core/save/all-external-js"
```
-To ensure that the "save changes" button saves a full, standalone wiki, it is also necessary to set the tiddler $:/config/SaveWikiButton/Template to contain `$:/core/save/all-external-js`.
+To properly save your snapshot for offline use, it is necessary to set the tiddler $:/config/SaveWikiButton/Template to contain `$:/core/save/offline-external-js`. You must also save a copy of `twcore-TIDDLYWIKI_VERSION.js` in the same folder as your HTML file. From your own wiki, open the tiddler [[$:/language/Snippets/GetTiddlyWikiJS]]. It will show you how to acquire ~TiddlyWiki's core ~JavaScript.
The provided edition `server-external-js` contains all the configuration necessary to use the external ~JavaScript template.
+!! Upgrading Your Snapshots
+
+Before you proceed, backup your wiki first! Follow the steps below to upgrade a single-file wiki with the external-js template:
+
+# Proceed with the [[upgrade process for standalone TiddlyWikis|Upgrading]]. Your wiki will be converted to a full standalone HTML.
+
+# Open your upgraded wiki in the browser. If you'd like to revert to using the regular template, restore the original shadow tiddler $:/config/SaveWikiButton/Template by deleting any custom copy and you are done.
+
+# Otherwise, from your wiki, open the tiddler [[$:/language/Snippets/GetTiddlyWikiJS]]. Click on the ''Export ~TiddlyWiki Core'' button to obtain the new release of ~TiddlyWiki's core ~JavaScript.
+
+# Verify that $:/config/SaveWikiButton/Template still contains `$:/core/save/offline-external-js`. Modify if necessary.
+
+# Save your wiki again. Your wiki is now converted to using the external core.
+
!! Background
TiddlyWiki in the single file configuration ordinarily packs everything into a single file: your data, and the ~JavaScript, CSS and HTML comprising TiddlyWiki itself. This lack of dependencies is usually very convenient: it means that it is impossible for the parts of a TiddlyWiki to become separated, and enormously improves the chances of it still functioning in the future.