101 lines
4.0 KiB
HTML
101 lines
4.0 KiB
HTML
<html><head><title>about gitmap</title></head>
|
|
<body>
|
|
|
|
<h1>about gitmap</h1>
|
|
|
|
<p>gitmap is a simple, small, 100% free/open-source, collaborative map
|
|
editor that runs mostly in a web browser. It integrates community
|
|
FOSS projects and data sources.</p>
|
|
|
|
<b><a href="index.html">run gitmap</a></b>
|
|
|
|
<h1>FAQ</h1>
|
|
|
|
<h2>Why?</h2>
|
|
<p>Because it's fun to browse around a map, and nice to know place
|
|
markers like in a wiki, and nice to find neighbours. This particular
|
|
installation is for locating Red Hat remotees / offices. Other installations
|
|
may store whatever they like.</p>
|
|
|
|
<h2>Who?</h2>
|
|
<p><a href="mailto:fche@redhat.com">fche</a> (gitmap integration scripts),
|
|
<a href="http://www.openstreetmap.org">Open Streetmap</a> (background map),
|
|
<a href="http://www.leafletjs.com">Leaflet</a> (map rendering javascript library + plugins),
|
|
and others.</p>
|
|
|
|
<h2>How to use it?</h2>
|
|
|
|
<p>Use the toolbar icons in top left. From top to bottom, these are:</p>
|
|
|
|
<p>Zoom/pan as per any other map type webapp.</p>
|
|
|
|
<p>To refresh your browser's copy of the markers, click the refresh icon.</p>
|
|
|
|
<p>To see this page, hit the question mark help icon.</p>
|
|
|
|
<p>To search for a marker by unique name substring, click the search
|
|
icon. Type a substring. Click on a hit shown in the list.</p>
|
|
|
|
<p>To add a marker, click the marker icon. Click again where the
|
|
marker should be put. A popup dialog box will ask for a unique
|
|
identifier. Please use your kerberos userid, to allow the roster/mojo
|
|
popup links to work. Use the
|
|
pattern <tt>office-AIRPORT-CITY-NAME</tt> for offices. Or pick whatever
|
|
will be useful to find your marker with the search function.
|
|
|
|
<p>To move a marker, click the edit icon to enter
|
|
<em>edit mode</em>. Drag misplaced markers. Click on "save" right
|
|
beside the edit icon. Be rewarded by a popup containing git command
|
|
output from the back-end. Click on "cancel" if you changed your
|
|
mind.</p>
|
|
|
|
<p>To delete a marker, click the trash icon to enter <em>delete
|
|
mode</em>. (It might be greyed out; you can still click on it.)
|
|
Click on doomed markers. Click on "save" or "cancel".</p>
|
|
|
|
<h2>How does it work?</h2>
|
|
|
|
<p><a href="https://gitlab.cee.redhat.com/fche/gitmap">Check it out.</a></p>
|
|
<p>The front-end consists of very small HTML + JavaScript files that
|
|
load Leaflet and OSM data from the Internet into your browser. The
|
|
front-end also loads marker data from our own servers via HTTP CGI.
|
|
Markers may be created, edited (moved), and deleted; these operations
|
|
also map to individual HTTP CGI calls to the server.</p>
|
|
<p>The back-end consists of bog-standard Apache HTTPD, a
|
|
plain-text-file "database" containing the collected markers, and a few
|
|
tiny CGI python scripts to relay the database to the web application.
|
|
(Calling it a database is an exaggeration - it is literally a
|
|
collection of text files, one per marker, whose contents are protected
|
|
by GIT.)</p>
|
|
|
|
<p>There is really not much to it. No GIS database, no server
|
|
processes, no fancy protocols. It took only about a day to get it
|
|
working, after spending a few days scouting out many
|
|
web-mapping-related software packages/services like postgis, cartodb,
|
|
opengeo, mapbox, openlayers, google, etc. In this case, FOSS does
|
|
the job, and easily.</p>
|
|
|
|
<h2>Where to send patches?</h2>
|
|
|
|
<p>Find gitmap sources
|
|
at <tt>https://gitlab.cee.redhat.com/fche/gitmap.git</tt>.
|
|
One or two third-party javascript libraries are stored there; others
|
|
are served from upstream projects' external CDNs. Feel free to fork /
|
|
experiment / deploy. Send patches to <tt>fche</tt> if desired.</p>
|
|
|
|
<p>Some hacking ideas:
|
|
<ol>
|
|
<li>adding more marker metadata (full name, URLs)</li>
|
|
<li>adding a toggle switch to turn marker clustering on/off</li>
|
|
<li>taking a region-of-interest spec from the URL string (to make it easier to share maps already zoomed into a particular place)</li>
|
|
</ol>
|
|
Patches are welcome!</p>
|
|
|
|
<p>Please note that the version of the gitmap tree
|
|
in <tt>gitlab.cee</tt> contains snapshots of the real live
|
|
personal data RH folks have chosen to share. It is obviously
|
|
confidential.</p>
|
|
|
|
</body>
|
|
</html>
|