Difference between revisions of "Project-GC UserScript"
m (update links and open source section) |
(Corrected headerlevels and added the "further documentation" section. Removed the empty/unused category "Power user tools".) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<tr> | <tr> | ||
<td style="width:70%; vertical-align:top;"> | <td style="width:70%; vertical-align:top;"> | ||
| − | = Description = | + | == 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. | 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. | ||
| − | 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 | + | 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 = | + | == 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.'' | * 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. | * 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 | + | * 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> | ||
<td style="width:30%; padding-left:25px;">__TOC__ <br><br/> | <td style="width:30%; padding-left:25px;">__TOC__ <br><br/> | ||
== Additional Sections == | == Additional Sections == | ||
| − | * [ | + | * [[Project-GC_Userscript/Development|Development]] |
| − | * [ | + | * [[Project-GC_Userscript/Feature_List|Feature List]] |
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | = Installation = | + | == Installation == |
There are TWO different things you must install: | There are TWO different things you must install: | ||
# A userscript manager web browser extension. | # A userscript manager web browser extension. | ||
# The script (userscript) itself. | # The script (userscript) itself. | ||
| − | == Web browser extension installation == | + | === Web browser extension 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 | 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 | ||
| − | === Firefox === | + | ==== Firefox ==== |
''These directions are for Firefox v104.* and might vary with older or newer versions.'' | ''These directions are for Firefox v104.* and might vary with older or newer versions.'' | ||
# From the "Tools" menu, choose "Add-ons and Themes". | # From the "Tools" menu, choose "Add-ons and Themes". | ||
| Line 39: | Line 42: | ||
''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.'' | ''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 === | + | ==== Chrome ==== |
''These directions are for Google Chrome v104.* and might vary with older or newer versions.'' | ''These directions are for Google Chrome v104.* and might vary with older or newer versions.'' | ||
# Open (launch) Google Chrome. | # Open (launch) Google Chrome. | ||
| Line 48: | Line 51: | ||
''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.'' | ''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 === | + | ==== 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. | 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 == | + | === Userscript installation === |
# Visit the [https://greasyfork.org/en/scripts/9713-geocaching-com-project-gc Greasy Fork] website. | # 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. | # Find and click on the <span style="color:green;">green</span> "Install this script" button. | ||
| Line 59: | Line 62: | ||
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. | 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 is | + | 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 = | + | == 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: | + | [[Category: Project-GC Userscript]] |
Latest revision as of 21:35, 26 April 2024
DescriptionThis 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
Further DocumentationFurther documentation of the script has been done in the category Project-GC Userscript. |
ContentsAdditional Sections |
Installation
There are TWO different things you must install:
- A userscript manager web browser extension.
- 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.
- 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[2], Tampermonkey[3], or Firemonkey[4])
- On the page describing the extension, looked for a blue "Add to Firefox" button. Click it.
- 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.
- Open (launch) Google Chrome.
- Visit the following website: https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo
- Click the blue "Add to Chrome" button.
- 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
- Visit the Greasy Fork website.
- Find and click on the green "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 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
Credits
|
Open SourceThe UserScript is open source and the source code is available on Github. Please visit the Development Section for more information.
Open Source Used (Citations)
LicensePlease read LICENSE within Repository. |
