mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-01-12 10:20:26 +00:00
Docs and demo improvements
This commit is contained in:
parent
ec03775c65
commit
88a500aa44
@ -1,27 +0,0 @@
|
||||
title: $:/plugins/tiddlywiki/geospatial/demo/data
|
||||
caption: Demo Data
|
||||
tags: $:/tags/GeospatialDemo
|
||||
|
||||
! Geo Markers
|
||||
|
||||
<ul>
|
||||
<$list filter="[all[shadows+tiddlers]tag[$:/tags/GeoMarker]sort[caption]]">
|
||||
<li>
|
||||
<$link>
|
||||
<$view field="caption"><$view field="title"/></$view>
|
||||
</$link>
|
||||
</li>
|
||||
</$list>
|
||||
</ul>
|
||||
|
||||
! Geo Layers
|
||||
|
||||
<ul>
|
||||
<$list filter="[all[shadows+tiddlers]tag[$:/tags/GeoLayer]sort[caption]]">
|
||||
<li>
|
||||
<$link>
|
||||
<$view field="caption"><$view field="title"/></$view>
|
||||
</$link>
|
||||
</li>
|
||||
</$list>
|
||||
</ul>
|
@ -90,14 +90,10 @@ https://api.flickr.com/services/rest/
|
||||
|
||||
! Retrieve Geotagged Flickr Photos
|
||||
|
||||
Flickr API Key: <$password name="flickr-api-key"/>
|
||||
|
||||
Flickr album ID: <$edit-text tiddler="$:/config/flickr-album" tag="input"/>
|
||||
|
||||
<$button>
|
||||
<$macrocall $name="flickr-get-album-items"/>
|
||||
Get Flickr album
|
||||
</$button>
|
||||
</$button> album ID: <$edit-text tiddler="$:/config/flickr-album" tag="input"/>
|
||||
|
||||
<$button>
|
||||
<$macrocall $name="flickr-get-interesting-items"/>
|
||||
|
20
plugins/tiddlywiki/geospatial/demo/layers.tid
Normal file
20
plugins/tiddlywiki/geospatial/demo/layers.tid
Normal file
@ -0,0 +1,20 @@
|
||||
title: $:/plugins/tiddlywiki/geospatial/demo/layers
|
||||
caption: ~GeoLayers
|
||||
tags: $:/tags/GeospatialDemo
|
||||
|
||||
This is a list of all the tiddlers containing ~GeoJSON layers in this wiki (identified by the tag <<tag "$:/tags/GeoLayer">>). A ~GeoJSON layer identifies a region of the surface of the earth via a series of polygons defined as lines between consecutive points specified via latitude and longitude (and optional elevation). ~GeoJSON layers may also contain associated metadata in JSON format.
|
||||
|
||||
You can create new layers by:
|
||||
|
||||
* Visit the tiddler for a ~GeoJSON marker and use the button to calculate travel time
|
||||
* Importing a ~GeoJSON layer
|
||||
|
||||
<ul>
|
||||
<$list filter="[all[shadows+tiddlers]tag[$:/tags/GeoLayer]sort[caption]]">
|
||||
<li>
|
||||
<$link>
|
||||
<$view field="caption"><$view field="title"/></$view>
|
||||
</$link>
|
||||
</li>
|
||||
</$list>
|
||||
</ul>
|
@ -1,8 +1,8 @@
|
||||
title: $:/plugins/tiddlywiki/geospatial/demo/maps
|
||||
caption: Maps
|
||||
title: $:/plugins/tiddlywiki/geospatial/demo/map
|
||||
caption: Map
|
||||
tags: $:/tags/GeospatialDemo
|
||||
|
||||
! Map with Layers and Markers
|
||||
! Map Showing All Layers and Markers
|
||||
|
||||
<$geomap
|
||||
markers="[all[tiddlers+shadows]tag[$:/tags/GeoMarker]]"
|
21
plugins/tiddlywiki/geospatial/demo/markers.tid
Normal file
21
plugins/tiddlywiki/geospatial/demo/markers.tid
Normal file
@ -0,0 +1,21 @@
|
||||
title: $:/plugins/tiddlywiki/geospatial/demo/markers
|
||||
caption: ~GeoMarkers
|
||||
tags: $:/tags/GeospatialDemo
|
||||
|
||||
This is a list of all the tiddlers containing ~GeoJSON markers in this wiki (identified by the tag <<tag "$:/tags/GeoMarker">>). A ~GeoJSON marker identifies a location via latitude and longitude (and optional elevation) and may also contain associated metadata in JSON format.
|
||||
|
||||
You can create new markers by:
|
||||
|
||||
* Importing geotagged photographs from Flickr
|
||||
* Importing a ~GeoJSON marker
|
||||
|
||||
<ul>
|
||||
<$list filter="[all[shadows+tiddlers]tag[$:/tags/GeoMarker]sort[caption]]">
|
||||
<li>
|
||||
<$link>
|
||||
<$view field="caption"><$view field="title"/></$view>
|
||||
</$link>
|
||||
</li>
|
||||
</$list>
|
||||
</ul>
|
||||
|
@ -2,4 +2,9 @@ title: $:/plugins/tiddlywiki/geospatial/demos
|
||||
|
||||
! Demos
|
||||
|
||||
<<tabs tabsList:"[all[tiddlers+shadows]tag[$:/tags/GeospatialDemo]]" default:"$:/plugins/tiddlywiki/geospatial/demo/data">>
|
||||
* Visit the ~GeoLayers and ~GeoMarkers tabs to see the data loaded into this wiki
|
||||
* Click on a link to a layer or marker to open the corresponding tiddler that includes a map
|
||||
* Use the Flickr tab to retrieve geotagged photographs from Flickr
|
||||
* Visit a ~GeoMarker tiddler and use the "Call ~TravelTime" button to calculate an isochrone from that location using the ~TravelTime API
|
||||
|
||||
<<tabs tabsList:"[all[tiddlers+shadows]tag[$:/tags/GeospatialDemo]]" default:"$:/plugins/tiddlywiki/geospatial/demo/map">>
|
||||
|
9
plugins/tiddlywiki/geospatial/license.tid
Normal file
9
plugins/tiddlywiki/geospatial/license.tid
Normal file
@ -0,0 +1,9 @@
|
||||
title: $:/plugins/tiddlywiki/geospatial/license
|
||||
|
||||
This plugin is part of TiddlyWiki 5 and is licensed with TiddlyWiki's 3-clause BSD open source license.
|
||||
|
||||
It incorporates the following third-party libraries with their own licenses:
|
||||
|
||||
* [[Leaflet.js|https://leafletjs.com/]] license -- $:/plugins/tiddlywiki/geospatial/leaflet.js/LICENSE
|
||||
* [[Turf.js|https://turfjs.org/]] license -- $:/plugins/tiddlywiki/geospatial/turf.js/LICENSE
|
||||
* [[OpenLocationCode|https://github.com/google/open-location-code]] license -- $:/plugins/tiddlywiki/geospatial/openlocationcode/LICENSE
|
@ -2,5 +2,5 @@
|
||||
"title": "$:/plugins/tiddlywiki/geospatial",
|
||||
"name": "Geospatial Utilities",
|
||||
"description": "Geospatial utilities",
|
||||
"list": "readme demos settings license"
|
||||
"list": "readme settings demos license"
|
||||
}
|
||||
|
@ -2,9 +2,11 @@ title: $:/plugins/tiddlywiki/geospatial/readme
|
||||
|
||||
! Introduction
|
||||
|
||||
This is an early alpha build of the new Geospatial Plugin for TiddlyWiki. The goal is to develop new primitives for the TiddlyWiki platform that enable non-developers to build sophisticated interactive geospatial applications.
|
||||
This is an early alpha build of the new Geospatial Plugin for TiddlyWiki.
|
||||
|
||||
At this point, the Geospatial Plugin is largely a technical proof of concept of foundational capabilities:
|
||||
The goal is to develop new primitives for the TiddlyWiki platform that enable non-developers to build sophisticated interactive geospatial applications.
|
||||
|
||||
At this point, the Geospatial Plugin is largely a proof of concept of foundational capabilities:
|
||||
|
||||
* Integrating the open source [[Leaflet.js|https://leafletjs.com/]] library to display interactive maps
|
||||
* Integrating the open source [[Turf.js|https://turfjs.org/]] library to perform geospatial calculations with [[GeoJSON|https://en.wikipedia.org/wiki/GeoJSON]] objects
|
||||
@ -12,8 +14,13 @@ At this point, the Geospatial Plugin is largely a technical proof of concept of
|
||||
* Integrating the free API from [[Flickr|https://www.flickr.com/services/api/]] for retrieving geotagged photographs
|
||||
* Integrating Google's open source [[OpenLocationCode|https://github.com/google/open-location-code]] library for converting to and from Open Location Codes (also known as [[PlusCodes|https://maps.google.com/pluscodes/]])
|
||||
|
||||
!! Limitations
|
||||
|
||||
The API keys needed to access external services must be manually configured by the end user. The keys are stored in the browser and so only need to be set up once.
|
||||
|
||||
! Getting Started
|
||||
|
||||
!! Prerequisites
|
||||
|
||||
This demo requires that the API keys needed to access external services be obtained by the end user and manually configured. These keys are stored in the browser and so only need to be set up once. See the ''Settings'' tab for details.
|
||||
|
||||
!! Demos
|
||||
|
||||
Visit the ''Demos'' tab above to explore the demos.
|
||||
|
||||
|
@ -6,10 +6,25 @@ caption: Geospatial Plugin
|
||||
|
||||
! Geospatial Plugin Settings
|
||||
|
||||
Register for a free account at https://traveltime.com/ and copy and paste the secrets below:
|
||||
This demo runs entirely in the browser, with no backend server component. A consequence of this design is that the API keys required to access external services must be obtained by the end user. These keys are stored in the browser and so only need to be set up once.
|
||||
|
||||
!! ~TravelTime API key
|
||||
|
||||
# Register for a free account at https://traveltime.com/
|
||||
# Visit https://account.traveltime.com/dashboard
|
||||
# Copy and paste the values labelled "Application ID" and "Secret Keys" into the boxes below
|
||||
|
||||
~TravelTime Application ID: <$password name="traveltime-application-id"/>
|
||||
|
||||
~TravelTime Secret Key: <$password name="traveltime-secret-key"/>
|
||||
|
||||
!! Flickr API Key
|
||||
|
||||
# Register for a free account at https://flickr.com/
|
||||
# Visit https://www.flickr.com/services/apps/create/apply and complete the procedure for the appropriate key
|
||||
#* The
|
||||
# Copy and paste the value labelled "API Key" into the box below
|
||||
|
||||
Flickr API Key: <$password name="flickr-api-key"/>
|
||||
|
||||
</div>
|
||||
|
Loading…
Reference in New Issue
Block a user