Difference between revisions of "Project-GC UserScript"

From Project-GC
Jump to: navigation, search
(→‎Features: Added the features not listed.)
(Corrected headerlevels and added the "further documentation" section. Removed the empty/unused category "Power user tools".)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The [https://project-gc.com/Home/UserScript User Script] sometimes refered to as the '''Web browser extension''' is a script created by [[Project-GC]] that extends the user experience at [[Geocaching.com]] by adding data and functions from Project-GC to the site. The script is built on Greasemonkey<ref>For more info about Greasemonkey, see [https://en.wikipedia.org/wiki/Greasemonkey Wikipedia].</ref> technology. The script is generally most useful for users with a [[paid membership]] since not all functions are available for users without it.
+
<table style="width:100%;">
 +
<tr>
 +
<td style="width:70%; vertical-align:top;">
 +
== Description ==
 +
This tool is a user-enabled script that extends the user experience at the [https://geocaching.com Geocaching.com website], primarily by integrating Project-GC into it. The audience for this script are primarily geocaching power-users, however some of the basic features can make the novice or beginner experience better as well.
  
−
The userscript is open source and anyone is allowed to push updates<ref>Interested users can clone the project at [https://github.com/magma1447/greasemonkey-geocaching-projectgc Github]</ref>.
+
This script was originally written by Jonas "lillfiluren" Högström; and has been maintained and improved upon by various other [https://github.com/magma1447/greasemonkey-geocaching-projectgc/graphs/contributors geocaching community members].
 +
== Prerequisites ==
 +
* While ''not required'' - it is highly recommended that you have a [https://project-gc.com/Home/Membership Project-GC membership].  ''Many features will not be present without a membership.''
 +
* You need to know how to install an extension<ref name="extension">Web browser extensions are also known as add-ons or plug-ins</ref> into your web browser.
 +
* Familiarity with GreaseMonkey<ref name="greasemonkey">For more info about Greasemonkey, see [https://en.wikipedia.org/wiki/Greasemonkey Wikipedia article on Greasemonkey]</ref> or TamperMonkey<ref name="tampermonkey">For more info about TamperMonkey, see [https://en.wikipedia.org/wiki/Tampermonkey Wikipedia article on Tampermonkey]</ref>, or Firemonkey<ref name="firemonkey">For more info about Firemonkey, see [https://addons.mozilla.org/en-US/firefox/addon/firemonkey/ More information about Firemonkey]</ref> managers that enable the this tool and many others based on Userscripts<ref name="userscripts">For more info about Userscripts, see [https://en.wikipedia.org/wiki/Userscript Wikipedia article on Userscripts]</ref>.
  
 +
== Further Documentation ==
 +
Further documentation of the script has been done in the category [[:Category:Project-GC Userscript|Project-GC Userscript]].
 +
</td>
 +
<td style="width:30%; padding-left:25px;">__TOC__ <br><br/>
 +
== Additional Sections ==
 +
* [[Project-GC_Userscript/Development|Development]]
 +
* [[Project-GC_Userscript/Feature_List|Feature List]]
 +
</td>
 +
</tr>
 +
</table>
  
−
==Web browsers==
+
== Installation ==
 +
There are TWO different things you must install:
 +
# A userscript manager web browser extension.
 +
# The script (userscript) itself.
  
−
The script works with both ''Chrome'' and ''Firefox''. It should work well with ''Safari'' and most ''Chromium based-browsers'' as well, this is not yet confirmed. <!-- Switched "Safari Next" to "Chromium-based browsers" since it made more sense in my mind. Not sure about the "this is not yet confirmed"-part since it has been there for very long but I just copypasted it from the main site.-->
+
=== Web browser extension installation ===
  
−
==Installation==
+
Depending on the web browser that you use, follow the directions below to install the extension<ref name="extension" />.  Then proceed to the next section
  
−
To make the script work [https://www.tampermonkey.net/ Tampermonkey] needs to be installed, Firefox users might prefer [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey]. <!--I've used the script for multiple years with Tampermonkey on Firefox so I'm not sure if Greasemonkey needs to be recommended as the nr 1 for Firefox anymore?-->
+
==== Firefox ====
 +
''These directions are for Firefox v104.* and might vary with older or newer versions.''
 +
# From the "Tools" menu, choose "Add-ons and Themes".
 +
# On the left, locate "Extensions" and click it.
 +
# At the top of the window, look for "Find more add-ons" with a search-box next to it. Type in "greasemonkey" (one word) into the box and press return.
 +
# A list of extensions will show up, choose the extension you wish to use (Greasemonkey<ref name="greasemonkey" />, Tampermonkey<ref name="tampermonkey" />, or Firemonkey<ref name="firemonkey" />)
 +
# On the page describing the extension, looked for a <span style="color:blue;">blue</span> "Add to Firefox" button.  Click it.
 +
# A pop-up will appear to re-iterate what the extension will do, click "Add".
  
−
The script it self can be downloaded from [https://greasyfork.org/en/scripts/9713-geocaching-com-project-gc Greasy Fork], once downloaded it is updated automatically.
+
''At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove" button that will appear in place of the "Add" button.''
  
−
==Features==
+
==== Chrome ====
−
All functions of the script can be turned on or off individually. The features of the script are:
+
''These directions are for Google Chrome v104.* and might vary with older or newer versions.''
 +
# Open (launch) Google Chrome.
 +
# Visit the following website: https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo
 +
# Click the <span style="color:blue;">blue</span> "Add to Chrome" button.
 +
# A page describing the extension after it is installed will appear, it is safe to close this tab/window.
  
−
* Add to [[Virtual GPS]] straight from Geocaching.com.
+
''At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove from Chrome" button that will appear in place of the "Add" button.''
−
* Add [[challenge checker]]s to Geocaching.com automatically.
 
−
* Make copy friendly GC-Code and geocache page link.
 
−
* Add link to the Project-GC [[LiveMap|Live map]] from geocache pages.
 
−
* Duplicate latest logs to the top.
 
−
* Add Project-GC location. ([[Region]]s and [[county|counties]])
 
−
* Add a reverse geocoded address below the coordinates of a geocache.
 
−
* Remove the UTM coordinates.
 
−
* Add favorite point data from Project-GC. (For example [[Wilson score]].)
 
−
* Showing weekday of the placed date.
 
−
* Add links to [[Profile stats]] after every geocachers name.
 
−
* Tidy up Geocaching.com a bit. Most focus has been on the geocache page.
 
−
* Collapse download links.
 
−
* Add links to Project-GC [[gallery]] where suitable.
 
−
* Add links to [[MapBookmarklist|map bookmark lists]].
 
−
* Automatically decrypt hints.
 
−
* Add elevation data after geocache coordinates. (Option to use imperial units available.)
 
−
* Remove disclaimer from geocache pages.
 
−
* Parse Exif location from pictures.
 
−
* Add found logs per country according to Project-GC.
 
−
* Open ''Compose log'' entries in ''drafts'' in the same window.
 
−
* Change the font of the personal cache note to monospaced.
 
−
* Adds links to the tabs of the logbook-feature. (For example "show all logs from friends")
 
−
* Add the number of logs from the user above the log button.
 
−
* Hide map from printed cache page.
 
−
* Add icons for cached challenge checker results.
 
−
* Hide log upvote buttons and sorting options.
 
  
−
==Notes==
+
==== Other web browsers ====
 +
Firefox and Chrome are recommended, however depending on the web browser, there may be a Userscript manager available for it.  Tampermonkey<ref name="tampermonkey" /> is the only extension (as of 8/2022) that lists various other browsers that it supports.
 +
 
 +
=== Userscript installation ===
 +
# Visit the [https://greasyfork.org/en/scripts/9713-geocaching-com-project-gc Greasy Fork] website.
 +
# Find and click on the <span style="color:green;">green</span> "Install this script" button.
 +
# A new window will appear, giving more information about the script.  ''It is encourage to always read what the script will do before installing.'' 
 +
# Find the "Install" button and click it.
 +
 
 +
Once the script is installed, you can view the script source code or enable/disable the script.  Once a script is installed, most userscript managers will keep it up-to-date automatically as part of the default settings.  Refer to additional pages regarding the various Userscript managers on their usage.
 +
 
 +
== Translations ==
 +
The UserScript supports translations and is translated in the same way as the rest of [[Project-GC]], via [https://crowdin.com/project/Project-GC Crowdin]. Please note that the translations aren't done in real-time. Once translated at Crowdin they need to be manually fetched into Project-GC and pushed via a new release.
 +
 
 +
Also the UserScript fetches the translations from [[Project-GC]]. It has built-in caching so that it doesn't ask for translations upon every single page load, therefore further delay of new translations will exist.
 +
 
 +
<table style="width:100%;">
 +
<tr>
 +
<td style="width:50%; text-align:left; vertical-align:top; padding-right: 20px;">
 +
 
 +
== Notes ==
 
<references/>
 
<references/>
 +
== Credits ==
 +
* Idea and initial work: Jonas "lillfiluren" Högström.
 +
* Cleanup and actually make things work properly (cross browser compatible) by [https://github.com/Surfoo Surfoo].
 +
* Smashing bugs and working with community: [https://github.com/jewettg Greg Jewett (jewettg)]
 +
* Many other various [https://github.com/magma1447/greasemonkey-geocaching-projectgc/graphs/contributors contributors]. ''Thank you!''
 +
</td>
 +
<td style="width:50%; text-align:left; vertical-align:top; padding-left: 20px; padding-right: 20px;">
 +
== Open Source ==
 +
The UserScript is open source and the source code is available on Github.  Please visit the [https://project-gc.com/w/Project-GC_Userscript/Development Development Section] for more information.
 +
<br/>
 +
=== Open Source Used (Citations)===
 +
<table style="width:100%;  border-spacing: 1px;">
 +
<tr style="background-color: #000; color: #fff;">
 +
<th>Software Title/Name</th>
 +
<th>Author</th>
 +
<th>Version / License</th>
 +
<th>Links</th>
 +
</tr>
 +
<tr style="background-color: #ccc; color: #000;">
 +
<td>exif-js/exif-js</td>
 +
<td>(c)2008 Jacob Seidelin</td>
 +
<td>The MIT License (MIT)<br/>v2.2.0</td>
 +
<td>[https://github.com/exif-js/exif-js GitHub Repo]</td>
 +
</tr>
 +
</table>
 +
=== License ===
 +
Please read [https://github.com/magma1447/greasemonkey-geocaching-projectgc/blob/fbb9b106e26151ea3d93662bbcd4a6fd40d4f234/LICENSE LICENSE] within Repository.
 +
</td></tr></table>
  
−
[[Category:Tools]]
+
[[Category: Project-GC Userscript]]

Latest revision as of 21:35, 26 April 2024

Description

This tool is a user-enabled script that extends the user experience at the Geocaching.com website, primarily by integrating Project-GC into it. The audience for this script are primarily geocaching power-users, however some of the basic features can make the novice or beginner experience better as well.

This script was originally written by Jonas "lillfiluren" Högström; and has been maintained and improved upon by various other geocaching community members.

Prerequisites

  • While not required - it is highly recommended that you have a Project-GC membership. Many features will not be present without a membership.
  • You need to know how to install an extension[1] into your web browser.
  • Familiarity with GreaseMonkey[2] or TamperMonkey[3], or Firemonkey[4] managers that enable the this tool and many others based on Userscripts[5].

Further Documentation

Further documentation of the script has been done in the category Project-GC Userscript.



Additional Sections

Installation

There are TWO different things you must install:

  1. A userscript manager web browser extension.
  2. The script (userscript) itself.

Web browser extension installation

Depending on the web browser that you use, follow the directions below to install the extension[1]. Then proceed to the next section

Firefox

These directions are for Firefox v104.* and might vary with older or newer versions.

  1. From the "Tools" menu, choose "Add-ons and Themes".
  2. On the left, locate "Extensions" and click it.
  3. At the top of the window, look for "Find more add-ons" with a search-box next to it. Type in "greasemonkey" (one word) into the box and press return.
  4. A list of extensions will show up, choose the extension you wish to use (Greasemonkey[2], Tampermonkey[3], or Firemonkey[4])
  5. On the page describing the extension, looked for a blue "Add to Firefox" button. Click it.
  6. A pop-up will appear to re-iterate what the extension will do, click "Add".

At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove" button that will appear in place of the "Add" button.

Chrome

These directions are for Google Chrome v104.* and might vary with older or newer versions.

  1. Open (launch) Google Chrome.
  2. Visit the following website: https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo
  3. Click the blue "Add to Chrome" button.
  4. A page describing the extension after it is installed will appear, it is safe to close this tab/window.

At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove from Chrome" button that will appear in place of the "Add" button.

Other web browsers

Firefox and Chrome are recommended, however depending on the web browser, there may be a Userscript manager available for it. Tampermonkey[3] is the only extension (as of 8/2022) that lists various other browsers that it supports.

Userscript installation

  1. Visit the Greasy Fork website.
  2. Find and click on the green "Install this script" button.
  3. A new window will appear, giving more information about the script. It is encourage to always read what the script will do before installing.
  4. Find the "Install" button and click it.

Once the script is installed, you can view the script source code or enable/disable the script. Once a script is installed, most userscript managers will keep it up-to-date automatically as part of the default settings. Refer to additional pages regarding the various Userscript managers on their usage.

Translations

The UserScript supports translations and is translated in the same way as the rest of Project-GC, via Crowdin. Please note that the translations aren't done in real-time. Once translated at Crowdin they need to be manually fetched into Project-GC and pushed via a new release.

Also the UserScript fetches the translations from Project-GC. It has built-in caching so that it doesn't ask for translations upon every single page load, therefore further delay of new translations will exist.

Notes

  1. ↑ 1.0 1.1 Web browser extensions are also known as add-ons or plug-ins
  2. ↑ 2.0 2.1 For more info about Greasemonkey, see Wikipedia article on Greasemonkey
  3. ↑ 3.0 3.1 3.2 For more info about TamperMonkey, see Wikipedia article on Tampermonkey
  4. ↑ 4.0 4.1 For more info about Firemonkey, see More information about Firemonkey
  5. ↑ For more info about Userscripts, see Wikipedia article on Userscripts

Credits

  • Idea and initial work: Jonas "lillfiluren" Högström.
  • Cleanup and actually make things work properly (cross browser compatible) by Surfoo.
  • Smashing bugs and working with community: Greg Jewett (jewettg)
  • Many other various contributors. Thank you!

Open Source

The UserScript is open source and the source code is available on Github. Please visit the Development Section for more information.

Open Source Used (Citations)

Software Title/Name Author Version / License Links
exif-js/exif-js (c)2008 Jacob Seidelin The MIT License (MIT)
v2.2.0		 GitHub Repo

License

Please read LICENSE within Repository.

Retrieved from "https://project-gc.com/wiki/index.php?title=Project-GC_UserScript&oldid=2773"