diff options
Diffstat (limited to 'inc/3rdparty/site_config/standard/README.md')
| -rwxr-xr-x | inc/3rdparty/site_config/standard/README.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/inc/3rdparty/site_config/standard/README.md b/inc/3rdparty/site_config/standard/README.md index 9040ba85..ab5b12d9 100755 --- a/inc/3rdparty/site_config/standard/README.md +++ b/inc/3rdparty/site_config/standard/README.md | |||
| @@ -1,12 +1,14 @@ | |||
| 1 | Full-Text RSS site config files | 1 | Full-Text RSS site config files |
| 2 | ================ | 2 | ================ |
| 3 | 3 | ||
| 4 | [Full-Text RSS](http://fivefilters.org/content-only/), our article extraction tool, makes use of site-specific extraction rules to improve results. Each time a URL is processed, it checks to see if there are extraction rules for the site being processed. If there are no site patterns, it tries to detect the content block automatically. | 4 | [Full-Text RSS](http://fivefilters.org/content-only/), our article extraction tool, makes use of site-specific extraction rules to improve results. Each time a URL is processed, it checks to see if there are extraction rules for the site being processed. If there are no rules are found, it tries to detect the content block automatically. |
| 5 | 5 | ||
| 6 | This repository contains the site config files we use in Full-Text RSS. | 6 | This repository contains the site-specific extraction rules we rely on in Full-Text RSS. |
| 7 | 7 | ||
| 8 | ### Contributing changes | 8 | ### Contributing changes |
| 9 | 9 | ||
| 10 | We run automated tests on these files to detect issues. If you'd like to help keep these up to date, please look at the [test results](http://siteconfig.fivefilters.org/test/) and see which files you'd like to contribute fixes for. | ||
| 11 | |||
| 10 | We chose GitHub for this set of files because they offer one feature which we hope will make contributing changes easier: [file editing](https://github.com/blog/844-forking-with-the-edit-button) through the web interface. | 12 | We chose GitHub for this set of files because they offer one feature which we hope will make contributing changes easier: [file editing](https://github.com/blog/844-forking-with-the-edit-button) through the web interface. |
| 11 | 13 | ||
| 12 | You can now make changes to any of our site config files and request that your changes be pulled into the main set we maintain. This is what GitHub calls the Fork and Pull model: | 14 | You can now make changes to any of our site config files and request that your changes be pulled into the main set we maintain. This is what GitHub calls the Fork and Pull model: |
| @@ -31,7 +33,7 @@ Marco, Instapaper's creator, graciously opened up the database of contributions | |||
| 31 | 33 | ||
| 32 | > And, recognizing that your efforts could be useful to a wide range of other tools and services, I'll make the list of all of these site-specific configurations available to the public, free, with no strings attached. | 34 | > And, recognizing that your efforts could be useful to a wide range of other tools and services, I'll make the list of all of these site-specific configurations available to the public, free, with no strings attached. |
| 33 | 35 | ||
| 34 | Most of the extraction rules in our set are borrowed from Instapaper. You can see the list maintained by Instapaper at [instapaper.com/bodytext/](http://instapaper.com/bodytext/) (login required). | 36 | Most of the extraction rules in our set are borrowed from Instapaper. You can see the list maintained by Instapaper at [instapaper.com/bodytext/](http://instapaper.com/bodytext/) (no longer available since Instapaper was sold). |
| 35 | 37 | ||
| 36 | ### Testing site config files | 38 | ### Testing site config files |
| 37 | 39 | ||