History

Updated Scraper Reference (markdown)

Thibaut Courouble committed 12 years ago

Commit 6de2a2f1 parent a0040291 file · +4 −0Browse files

Unified · Split

Scraper-Reference.md+4−0
@@ -65,6 +65,10 @@ Configuration is done via class attributes and divided into three main categorie · 64 unmodified lines
65* `root_path` [String] **(inherited)** 65* `root_path` [String] **(inherited)**
66 The path from the `base_url` of the root URL.66 The path from the `base_url` of the root URL.
67 67
68* `initial_paths` [Array] **(inherited)**
69 A list of paths (from the `base_url`) to add to the initial queue. Useful for scraping isolated documents.
70 Defaults to `[]`. _(Note: the `root_path` is added to the array at runtime.)_
71
68* `dir` [String] **(required, `FileScraper` only)** 72* `dir` [String] **(required, `FileScraper` only)**
69 The absolute path where the files are located on the local filesystem. 73 The absolute path where the files are located on the local filesystem.
70 _Note: `FileScraper` works exactly like `UrlScraper` (manipulating the same kind of URLs) except that it substitutes `base_url` with `dir` in order to read files instead of making HTTP requests._74 _Note: `FileScraper` works exactly like `UrlScraper` (manipulating the same kind of URLs) except that it substitutes `base_url` with `dir` in order to read files instead of making HTTP requests._