From cc569db97368029a9db74e6da1f0b9a6f63257db Mon Sep 17 00:00:00 2001
From: pmario <pmariojo@gmail.com>
Date: Wed, 31 Jan 2024 10:41:35 +0100
Subject: [PATCH] add some docs to the new $:/Info/last-saved ... tiddlers

---
 .../tiddlers/mechanisms/InfoMechanism.tid     | 42 ++++++++++++++++++-
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/editions/tw5.com/tiddlers/mechanisms/InfoMechanism.tid b/editions/tw5.com/tiddlers/mechanisms/InfoMechanism.tid
index 040dd7bd2..08f86d22f 100644
--- a/editions/tw5.com/tiddlers/mechanisms/InfoMechanism.tid
+++ b/editions/tw5.com/tiddlers/mechanisms/InfoMechanism.tid
@@ -1,5 +1,5 @@
 created: 20140720164948099
-modified: 20201124185829706
+modified: 20240130224322884
 tags: Mechanisms
 title: InfoMechanism
 type: text/vnd.tiddlywiki
@@ -13,7 +13,7 @@ System tiddlers in the namespace `$:/info/` are used to expose information about
 ! Information Tiddlers
 
 |!Title |!Description |
-|[[$:/info/startup-timestamp]] |<<.from-version "5.1.23">> Startup timestamp in TiddlyWiki date format |
+|[[$:/info/startup-timestamp]] |<<.from-version "5.1.23">> Startup timestamp in ~TiddlyWiki date format |
 |[[$:/info/browser]] |Running in the browser? ("yes" or "no") |
 |[[$:/info/mobile]] |<<.from-version "5.2.3">> Is running on a mobile device? ("yes" or "no" - eg, ''<<example full>>'') |
 |[[$:/info/browser/language]] |<<.from-version "5.1.20">> Language as reported by browser (note that some browsers report two character codes such as `en` while others report full codes such as `en-GB`) |
@@ -29,3 +29,41 @@ System tiddlers in the namespace `$:/info/` are used to expose information about
 |[[$:/info/url/protocol]] |<<.from-version "5.1.14">> Protocol portion of URL of wiki (eg, ''<<example protocol>>'') |
 |[[$:/info/url/search]] |<<.from-version "5.1.14">> Search portion of URL of wiki (eg, ''<<example search>>'') |
 |[[$:/info/darkmode]] |<<.from-version "5.1.23">> Is dark mode enabled? ("yes" or "no") |
+
+!! Last Saved -- Single File Wiki
+
+The following tiddlers will be "injected" into the HTML file when the wiki is saved. Tagged template tiddlers are used to create the info tiddlers. Those tiddlers will be overwritten with the next automatic or manual save action.
+
+`$:/info/last-saved/*` will  not be created on a server if used with a client-server configuration. They will be created, if a "snapshot" is saved to the disk.
+
+|! Title |! Description |
+|$:/info/last-saved/timestamp |<<.from-version "5.3.4">> This tiddler will be created when a single file wiki is saved. It uses ~TiddlyWiki DateFormat |
+|$:/info/last-saved/date |<<.from-version "5.3.4">> Shows the same last-saved timestamp in human readable form. Eg: "2024-01-30 15:36:04.430 UTC +01:00"<br>using the following format: `[UTC]YYYY-0MM-0DD 0hh:0mm:0ss.0XXX UTC TZD` |
+
+!! Client Server Configuration
+
+<<.warning """If a client server configuration is used, the TW template is used to create the wiki file on the server. So the timestamps saved to the "server-created" info tiddlers are generated by the server. Depending on the server "local time" this timestamp ''can be different'' to the current "user time". Whenever the wiki file is created, the values will be set. `server-created-*` tiddlers will ''not'' be deleted if saved as a single file. The information may have some value""">>
+
+|! Title |! Description |
+|$:/info/server-created-wiki/timestamp |<<.from-version "5.3.4">> This tiddler will be created when a single file wiki is saved. It uses ~TiddlyWiki DateFormat |
+|$:/info/server-created-wiki/date |<<.from-version "5.3.4">> Shows the same last-saved timestamp in human readable form.<br>using the following format: `YYYY-0MM-0DD 0hh:0mm:0ss.0XXX` |
+
+!! Additional information
+
+By default ~TiddlyWiki does not save the full URL information to the file, due to privacy concerns. Eg: `$:/info/last-saved/full/url` can contain private information. Users are free to include the following code into their wiki, if they decide to do so. 
+
+<details><summary>Show code to add the full path to an info tiddler</summary>
+<$codeblock code="""title: inject-full-path
+tags: $:/tags/InfoTiddlerTemplate
+
+<!-- This template will be injected into the html file when the wiki is saved. It is activated by $:/core/templates/store.info.template.html -->
+\whitespace trim
+
+\function timestamp() [<now format:[UTC]YYYY0MM0DD0hh0mm0ss0XXX>]
+
+<% if [{$:/info/browser}match[yes]] %>
+	<$text text=<<join>>/>
+	`{"title": "$:/info/last-saved/full/url",  "created":"`<<timestamp>>`", "modified":"`<<timestamp>>`", "text":"`{{$:/info/url/full}}`"}`
+<% endif %>
+"""/>
+</details>