Skip to content

Commit

Permalink
Add Chromium to the About pages
Browse files Browse the repository at this point in the history
* Combined some resources into animation for visual clarity
* Link in Chrome page to Chromium

Post followup of OpenUserJS#202
  • Loading branch information
Martii committed Nov 22, 2015
1 parent f6d443b commit 13a4397
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 1 deletion.
3 changes: 2 additions & 1 deletion views/includes/documents/Chrome.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Chrome

Chrome is a free web browser developed by Google. Most of its code draws from the open-source Chromium project. Chrome's selling points are security, speed, simplicity and stability. The desktop version runs on Windows, Linux and OS X, and there are mobile versions for Android and iOS.
Chrome is a free web browser developed by Google. Most of its code draws from the open-source [Chromium][] project. Chrome's selling points are security, speed, simplicity and stability. The desktop version runs on Windows, Linux and OS X, and there are mobile versions for Android and iOS.

To run userscripts on Chrome, you normally need a manager extension such as Tampermonkey.

Expand All @@ -15,3 +15,4 @@ To run userscripts on Chrome, you normally need a manager extension such as Tamp
[wikipediaChrome]: http://www.wikipedia.org/wiki/Google_Chrome
[chromeSupport]: https://support.google.com/chrome/
[tampermonkeyForChrome]: Tampermonkey-for-Chrome
[chromium]: Chromium
18 changes: 18 additions & 0 deletions views/includes/documents/Chromium.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Chromium

Chromium is a free open-source web browser. Chromium's selling points are security, speed, simplicity and stability. The desktop version runs on Windows, Linux and OS X, and there are mobile versions for Android and iOS.

To run userscripts on Chromium, you normally need a manager extension such as Tampermonkey.

* [Build Chromium][chromiumBrowser]
* **NOTE**: Getting a prebuilt Chromium package may sometimes be available with a package repository like `apt-get`, `pacman`, `urpmi`, or some other package manager.
* [Chromium on Wikipedia][wikipediaChromium]
* [Chromium support][chromiumSupport]
* [Tampermonkey for Chromium][tampermonkeyForChromium]

[githubFavicon]: https://assets-cdn.github.com/favicon.ico
[oujsFavicon]: https://raw.githubusercontent.com/OpenUserJs/OpenUserJS.org/master/public/images/favicon16.png
[chromiumBrowser]: http://dev.chromium.org/Home
[wikipediaChromium]: http://www.wikipedia.org/wiki/Chromium_%28web_browser%29
[chromiumSupport]: https://code.google.com/p/chromium/issues/list
[tampermonkeyForChromium]: Tampermonkey-for-Chromium
66 changes: 66 additions & 0 deletions views/includes/documents/Tampermonkey-for-Chromium.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
## Tampermonkey for Chromium

![Tampermonkey icon][tampermonkeyIcon]

Tampermonkey is a userscript manager for [Chromium][chromium] and other similar web browsers, written by Jan Biniok. There are also versions for [Opera][opera] and [Android][tampermonkeyForAndroid].

### Installing Tampermonkey

To get userscripts going with the desktop version of Tampermonkey, first you have to install it from the [Chrome Web Store][gooChromeWebStoreTampermonkey]. The version in the store works with recent versions of Chromium *(v22 or newer, which are based on the Blink rendering engine)*. If you have to use an older version of Chromium, you may be able to get a compatible extension from [Tampermonkey.net][tampermonkeyNet].

![Screenshot of Tampermonkey page in Chrome Web Store][tampermonkeyGooChromeWebStoreScreenshot]

From the Tampermonkey page in the Chrome Store, click the blue "ADD TO CHROME" button to install the extension. Chromium will ask you to confirm the extension. Click "Add extension".

Once Tampermonkey has finished installing, you should see a confirmation page from the Tampermonkey website and briefly a pop-up confirming that Tampermonkey has been added to Chromium. This should point to a new Tampermonkey icon at the top of the Chromium window, next to the Omnibox.

### Installing Userscripts

Once Tampermonkey is installed, installing userscripts from [OpenUserJS.org][oujs] is simple. Navigate to the OpenUserJS page for the script, then click the blue "Install" button at the top of the page.

![Screenshot of an OpenUserJS script page][oujsScriptPageScreenshot1]

Tampermonkey will display a screen showing you where the userscript has come from, what websites it can access, its source code, and a warning to only install scripts from sources that you trust. If you do want to install the script, click the "Install" button, otherwise click "Cancel".

![Screenshot of Tampermonkey script installation][tampermonkeyChromeScreenshot3]

Installing userscripts from other sources is a similar process. You just need to find the installation link for the script. This will be a button or link to a file with a name that ends ".user.js"

NB After installing a userscript, you won't normally notice any further changes until you visit a website that it runs on.

### Managing Userscripts

Clicking on the Tampermonkey icon at any time will pop up a menu that shows you what userscripts are running on the website you are looking at. It also lets you check for updated scripts *(it does daily automatic checks by default)*, and open the Tampermonkey Dashboard.

![Screenshot of Tampermonkey Dashboard][tampermonkeyChromeScreenshot4]

In the Dashboard, the "Installed scripts" tab is the main place to manage your userscripts. The numbered circle to the left of each script shows you the order they run in, and whether they are enabled *(green)* or disabled *(red)* - click it to toggle the status. You can also uninstall userscripts *(trash can icon)*, or check for new updates *(click the "last updated" date)*.

### Trouble shooting

If you think a userscript is causing problems, the easiest way to check is to switch off Tampermonkey, reload the web page, and see if the symptoms go away. You can do this by clicking on the Tampermonkey icon then clicking "Enabled"; the tick icon should change to a cross. If it looks like a script problem and you have more than one script running on a web page, you can disable them all in Tampermonkey's dashboard then re-enable them one by one, until you find the culprit. Remember to reload the web page each time - userscripts normally only run when a web page loads.

Sometimes, when you use more than one userscript on the same web page, they need to run in a particular order. You can change the order using the Tampermonkey dashboard. In the "Sort order" column, click on the 'three lines' icon for the script you want to move, move the mouse up or down to change the order, then click again.

### More

* [Get Tampermonkey from the Chrome Web Store][gooChromeWebStoreTampermonkey]
* [Tampermonkey for Opera][tampermonkeyForOpera]
* [Tampermonkey for Android][tampermonkeyForAndroid]
* [Tampermonkey.net][tampermonkeyNet] - documentation, discussion and downloads for other versions of Tampermonkey.

[githubFavicon]: https://assets-cdn.github.com/favicon.ico
[oujsFavicon]: https://raw.githubusercontent.com/OpenUserJs/OpenUserJS.org/master/public/images/favicon16.png
[oujs]: https://openuserjs.org/
[tampermonkeyIcon]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/tampermonkey_icon.png "Tampermonkey"
[chromium]: Chromium
[opera]: Opera
[tampermonkeyForAndroid]: Tampermonkey-for-Android
[gooChromeWebStoreTampermonkey]: https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo
[tampermonkeyNet]: http://tampermonkey.net/
[tampermonkeyGooChromeWebStoreScreenshot]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/tampermonkey_cr.gif "Tampermonkey in the Chrome Web Store"
[oujsScriptPageScreenshot1]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/openuserjs_script.png "Ready to install a script"
[tampermonkeyChromeScreenshot3]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/tampermonkey_cr4.gif "Installing a script"
[tampermonkeyChromeScreenshot4]: https://raw.githubusercontent.com/wiki/OpenUserJS/OpenUserJS.org/images/tampermonkey_cr5.png "Tampermonkey Dashboard"
[tampermonkeyForOpera]: Tampermonkey-for-Opera
[tampermonkeyForAndroid]: Tampermonkey-for-Android
3 changes: 3 additions & 0 deletions views/includes/documents/Userscript-Beginners-HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Find your web browser in the table below, and follow the links to find out the o
Web browser | Installation Method
--- | ---
[Chrome][chrome] | [Tampermonkey][tampermonkeyForChrome]
[Chromium][chromium] | [Tampermonkey][tampermonkeyForChromium]
[Firefox][firefox] | [Greasemonkey][greasemonkeyForFirefox]
[Opera][opera] | [Violentmonkey][violentMonekyForOpera]
[Opera][opera] *(v15 and above only)* | [Tampermonkey][tampermonkeyForOpera]
Expand All @@ -42,9 +43,11 @@ Web browser | Installation Method
[greasemonkeyPortForSeaMonkey]: Greasemonkey-Port-for-SeaMonkey
[tampermonkeyForOpera]: Tampermonkey-for-Opera
[tampermonkeyForChrome]: Tampermonkey-for-Chrome
[tampermonkeyForChromium]: Tampermonkey-for-Chromium
[tampermonkeyForAndroid]: Tampermonkey-for-Android
[violentMonekyForOpera]: Violentmonkey-for-Opera
[chrome]: Chrome
[chromium]: Chromium
[firefox]: Firefox
[opera]: Opera
[seamonkey]: SeaMonkey

0 comments on commit 13a4397

Please sign in to comment.