Wikir : PithHelmetRuleExchange

1. Introduction

The basic idea is to share PithHelmet rule files (.phr) with other users.

There are only a few .phr files floating around right now. However, the GreaseMonkey project (a plugin for FireFox) has a number of scripts that can usually be ported to PithHelmet with minimal difficulty. Unfortunately, Safari doesn't support XPath, which is often used to select bits of the DOM. If one of the scripts relies on XPath, it would need to be extensively rewritten.

If you don't see what you are looking for, ask. If you have a handy rule, share it with others. Each rule should work for one site (so as not to interfere with the Default Site Rule), and may be attached directly to this wiki page by anyone. (Well, you need to create an account on wikir, but that should only take minute.)

2. Installing

Installing is pretty simple, but slightly non-obvious.

1. Download a .phr file from the links here and save the file somewhere handy, like the Desktop.

2. Open the PithHelmet Rule Editor (Command-Shift-E)

3. Drag the .phr file into the list of rules on the left side of the editor window.

4. Click the "Apply" button at the bottom of the window (or just close the editor window) and you are done.

3. Creating A .phr File

Super simple - drag a rule out of the rule editor list to the Desktop - huzzah - a new .phr file.

4. The List

Here are a few links to custom rules (please keep these alphabetical):

Rule (T)ype: F = Filter, C = CSS, J = Javascript, M = Machete, O = Other

Note: (all sites) rules have now been introduced. It's also possible to attach the accompanying filter/script to the Default Site Rule instead of having two similar rule domains.

5. Other Sample Rules

These may require some fiddling to get them to work, so be prepared to spend a little time editing by hand.

sourceforge.net: enable direct download

• http://hublog.hubmed.org/archives/001077.html

various sites: remove PDF delay for journal articles

• http://hublog.hubmed.org/archives/001084.html

using javascript in the transmogrifier:

• javascript_transmogrification.phr

6. Machete

This is definitely more advanced. This is basically an "inline proxy" for a web page. This means that you can use a variety of scripting languages, programmed much like a CGI, to filter web pages or create extensive modifications.

Currently, Machete scripts must:

1. be named .pl, .py or .sh

2. have the execute bit set on them (chmod +x)

You set a machete script in the Advanced tab of a site rule.

Read the MacheteFaq

7. Non-Machete scripts

[perhaps this belongs elsewhere, but it seems to fit here]

7.1. mslaunch.js

The mlaunch.js script is not a Machete script, but it does perform Machete-like actions. It enables Safari users to view the videos on launch.yahoo.com. The script itself is a very simple port of the Greasemonkey script of http://www.pooyak.com/p/pklaunch/. To use the script, save it as mlaunch.js, then:

1. create a PithHelmet Rule named launch.yahoo.com

2. set the Regex URL Match to

• .*[launch|music].yahoo.com

3. specify the filename for the script (mlaunch.js) in the Style tab under "Custom Javascript"

7.2. Filterset.G Importer

Due to the licensing of the Filterset.G ruleset, it cannot be redistributed. This script allows the user to download the ruleset themselves and then import it into PithHelmet. To import a Filterset.G ruleset, do the following:

1. Download the fsg2ph-v2 script. Save it as fsg2ph.

2. Download the F-Script tools from http://www.fscript.org

3. Download the current Filterset.G ruleset from http://www.pierceive.com

4. Start Safari

5. Start F-Script Anywhere and install a workspace in Safari (this lasts until Safari is restarted)

6. In Safari, choose FSA -> New F-Script Workspace. An interactive F-Script interpreter window appears.

7. At the F-Script prompt type: fsg2ph := sys load

This will pop up a dialog box. Navigate to where you saved the fsg2ph archive and select it.

8. At the F-Script prompt type: fsg2ph value:'/path/to/ruleset'

Where /path/to/ruleset should be the absolute path of where you saved the Filterset.G ruleset.

9. If all went well, you should now have a single PithHelmet rule named "Filterset.G Ruleset <RevisionID>" which represents the Filterset.G Ruleset