TiddlyWiki5/editions/tw5.com/tiddlers/mechanisms/InfoMechanism.tid

created: 20140720164948099
modified: 20201124185829706
tags: Mechanisms
title: InfoMechanism
type: text/vnd.tiddlywiki

\define example(name)
<$transclude tiddler="""$:/info/url/$name$""" mode="inline"/>
\end

System tiddlers in the namespace `$:/info/` are used to expose information about the system (including the current browser) so that WikiText applications can adapt themselves to available features.

! Information Tiddlers

|!Title |!Description |
|[[$:/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`) |
|[[$:/info/browser/screen/width]] |Screen width in pixels |
|[[$:/info/browser/screen/height]] |Screen height in pixels |
|[[$:/info/node]] |Running under [[Node.js]]? ("yes" or "no") |
|[[$:/info/url/full]] |<<.from-version "5.1.14">> Full URL of wiki (eg, ''<<example full>>'') |
|[[$:/info/url/host]] |<<.from-version "5.1.14">> Host portion of URL of wiki (eg, ''<<example host>>'') |
|[[$:/info/url/hostname]] |<<.from-version "5.1.14">> Hostname portion of URL of wiki (eg, ''<<example hostname>>'') |
|[[$:/info/url/origin]] |<<.from-version "5.1.14">> Origin portion of URL of wiki (eg, ''<<example origin>>'') |
|[[$:/info/url/pathname]] |<<.from-version "5.1.14">> Pathname portion of URL of wiki (eg, ''<<example pathname>>'') |
|[[$:/info/url/port]] |<<.from-version "5.1.14">> Port portion of URL of wiki (eg, ''<<example port>>'') |
|[[$:/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") |
Introduce info mechanism We expose browser information as shadow tiddlers so that wiki applications can adapt to available features. 2014-07-20 17:07:30 +00:00			`created: 20140720164948099`
Add support for $:/info/darkmode (and for dynamic info tiddlers) 2020-11-24 19:01:33 +00:00			`modified: 20201124185829706`
Add mechanisms to the reference docs 2014-09-11 19:12:25 +00:00			`tags: Mechanisms`
Introduce info mechanism We expose browser information as shadow tiddlers so that wiki applications can adapt to available features. 2014-07-20 17:07:30 +00:00			`title: InfoMechanism`
			`type: text/vnd.tiddlywiki`

Expose document location via `$:/info/url/*` info tiddlers 2016-10-18 08:12:55 +00:00			`\define example(name)`
			`<$transclude tiddler="""$:/info/url/$name$""" mode="inline"/>`
			`\end`

Introduce info mechanism We expose browser information as shadow tiddlers so that wiki applications can adapt to available features. 2014-07-20 17:07:30 +00:00			System tiddlers in the namespace `$:/info/` are used to expose information about the system (including the current browser) so that WikiText applications can adapt themselves to available features.

			`! Information Tiddlers`

			`\|!Title \|!Description \|`
InfoMechanism: Add $:/info/startup-timestamp 2020-05-06 10:05:54 +00:00			`\|[[$:/info/startup-timestamp]] \|<<.from-version "5.1.23">> Startup timestamp in TiddlyWiki date format \|`
Introduce info mechanism We expose browser information as shadow tiddlers so that wiki applications can adapt to available features. 2014-07-20 17:07:30 +00:00			`\|[[$:/info/browser]] \|Running in the browser? ("yes" or "no") \|`
Docs missed off #6675 2022-07-12 15:51:38 +00:00			`\|[[$:/info/mobile]] \|<<.from-version "5.2.3">> Is running on a mobile device? ("yes" or "no" - eg, ''<<example full>>'') \|`
Add $:/info/browser/language to the info mechanism 2019-03-07 18:42:49 +00:00			\|[[$:/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`) \|
Add screen width/height to platform information exposed at startup 2018-03-23 09:13:45 +00:00			`\|[[$:/info/browser/screen/width]] \|Screen width in pixels \|`
			`\|[[$:/info/browser/screen/height]] \|Screen height in pixels \|`
Sort out info mechanism docs Some of it belongs in the browser-sniff plugin Also add a `$:/info/node` info tiddler. 2014-07-22 14:16:18 +00:00			`\|[[$:/info/node]] \|Running under [[Node.js]]? ("yes" or "no") \|`
Expose document location via `$:/info/url/*` info tiddlers 2016-10-18 08:12:55 +00:00			`\|[[$:/info/url/full]] \|<<.from-version "5.1.14">> Full URL of wiki (eg, ''<<example full>>'') \|`
			`\|[[$:/info/url/host]] \|<<.from-version "5.1.14">> Host portion of URL of wiki (eg, ''<<example host>>'') \|`
			`\|[[$:/info/url/hostname]] \|<<.from-version "5.1.14">> Hostname portion of URL of wiki (eg, ''<<example hostname>>'') \|`
			`\|[[$:/info/url/origin]] \|<<.from-version "5.1.14">> Origin portion of URL of wiki (eg, ''<<example origin>>'') \|`
			`\|[[$:/info/url/pathname]] \|<<.from-version "5.1.14">> Pathname portion of URL of wiki (eg, ''<<example pathname>>'') \|`
			`\|[[$:/info/url/port]] \|<<.from-version "5.1.14">> Port portion of URL of wiki (eg, ''<<example port>>'') \|`
			`\|[[$:/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>>'') \|`
Add support for $:/info/darkmode (and for dynamic info tiddlers) 2020-11-24 19:01:33 +00:00			`\|[[$:/info/darkmode]] \|<<.from-version "5.1.23">> Is dark mode enabled? ("yes" or "no") \|`