1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-12-05 00:08:06 +00:00

Improve plugin readmes

Now every plugin has a short, introductory readme tiddler that is shown
in the online plugin library.
This commit is contained in:
Jermolene
2015-03-19 10:53:45 +00:00
parent 2f8837a445
commit f2a7f00870
50 changed files with 232 additions and 86 deletions

View File

@@ -3,5 +3,5 @@
"description": "Google Analytics: website statistics",
"author": "JeremyRuston",
"core-version": ">=5.0.0",
"list": "readme"
"list": "readme usage"
}

View File

@@ -1,15 +1,5 @@
title: $:/plugins/tiddlywiki/googleanalytics/readme
This plugin enables you to use Google Analytics to track access to your online TiddlyWiki document. These instructions assume you are using TiddlySpot to publish your wiki.
This plugin enables you to use Google Analytics to track access to your online TiddlyWiki document.
# Go to the Google Analytics website: http://www.google.com/analytics/
# Click the ''Access Google Analytics'' button and follow instructions to set up your account
# Enter the name of your TiddlySpot domain, for example "mysite.tiddlyspot.com"
# You will be given your own Tracking ID for this domain
# Go to http://tiddlywiki.com -- open the More/System tab and drag the links to these three tiddlers across to a local copy of your site:
#* [[$:/GoogleAnalyticsDomain]]
#* [[$:/GoogleAnalyticsAccount]]
#* [[$:/plugins/tiddlywiki/googleanalytics]]
# Edit the first two of these tiddlers to reflect your Domain and Tracking ID
# Upload the new version to TiddlySpot or other web host
# Return to your Google Analytics page to check that your site is being tracked
[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/googleanalytics]]

View File

@@ -0,0 +1,16 @@
title: $:/plugins/tiddlywiki/googleanalytics/usage
These instructions assume you are using TiddlySpot to publish your wiki.
# Go to the Google Analytics website: http://www.google.com/analytics/
# Click the ''Access Google Analytics'' button and follow instructions to set up your account
# Enter the name of your TiddlySpot domain, for example "mysite.tiddlyspot.com"
# You will be given your own Tracking ID for this domain
# Go to http://tiddlywiki.com -- open the More/System tab and drag the links to these three tiddlers across to a local copy of your site:
#* [[$:/GoogleAnalyticsDomain]]
#* [[$:/GoogleAnalyticsAccount]]
#* [[$:/plugins/tiddlywiki/googleanalytics]]
# Edit the first two of these tiddlers to reflect your Domain and Tracking ID
# Upload the new version to TiddlySpot or other web host
# Return to your Google Analytics page to check that your site is being tracked