-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/buggyj/savetiddlers
- Loading branch information
Showing
1 changed file
with
17 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,31 @@ | ||
| # savetiddlers | ||
| # savetiddlers - Browser plugin to save tiddlywikis | ||
|
|
||
| ## Warning! This extension must be the only tiddlywiki filesaving extension installed. Uninstall any other tiddlywiki filesaver *before* installing this extension. | ||
|
|
||
|
|
||
| ## Aim | ||
| 1. To enable tiddlywikis to be saved like a file, i.e. the new (modified) version overwrites the old version. | ||
| 2. To provide automatic backups. | ||
| ## Getting started (firefox from v57) | ||
| 1. Click this link to start installing. | ||
| https://github.com/buggyj/savetiddlers/releases/download/0.6/save_tiddlers-0.6-an.fx.xpi | ||
| 2. **Create a subdir called tiddlywikilocations** in the folder firefox uses for downloads (you can see and change this location in firefoxes prefrences). | ||
| 3. Download a tiddlywiki from http://tiddlywiki.com/, and **place in that subdir**, or copy your tiddlywikis there. | ||
|
|
||
| ## Scope and limitations | ||
| 1. This is a browser extension designed to work with chrome and other chromium based browsers, and the new firefox browser (v57 and latter). | ||
| 2. Due to browser restrictions tiddlywikis must be located below a subdir of the 'Download' directory. This directory is called 'tiddlywikilocations'. | ||
| 3. A test file needs to be downloaded (and then delete) to find the location of the download directory as there is no api for reading the download directory location, and this is seen by the user. | ||
| ## Options | ||
| There are options to create once a day backs, with the date appended to the tiddlywiki's file name. And the option to replace 'tiddlywikilocations' with another directory name of your choice, and to change the name of the back directory. | ||
|
|
||
| ## Getting started (chrome) | ||
| 1. Install by downloading (goto the release https://github.com/buggyj/savetiddlers/releases and download by click the 'source code' zip link) and unzipping (e.g. in a directory called savetiddlers). Then in chrome navigate to chrome://extensions/ and click 'load unpacked extension' and go the bsaver/extension/ directory to select the extension (it's the directory containing the 'manifest.json' file). | ||
| 2. **Create a subdir called tiddlywikilocations** in the Dowload dir. | ||
| 3. Download a tiddlywiki from http://tiddlywiki.com/, and **place in that subdir**. | ||
| 2. **Create a subdir called tiddlywikilocations** in the Download dir. | ||
| 3. Download a tiddlywiki from http://tiddlywiki.com/, and **place in that subdir**, or copy your tiddlywikis there. | ||
|
|
||
| The name of the subdir for backups (relative position to the current TW) can be set from the option page. | ||
| Note that chome with ask you to disable the 'developer mode' extensions each time you start the browser (but not with linux), as the extension was not loaded from the Chrome Web Store. | ||
|
|
||
| ## Getting started (firefox from v56) | ||
| 0. Uninstall tiddlyfox thru the addons page (if it is installed). | ||
| 1. Click this link to start installing. | ||
| https://github.com/buggyj/savetiddlers/releases/download/0.6/save_tiddlers-0.6-an.fx.xpi | ||
| **Create a subdir called tiddlywikilocations** in the Dowload dir. | ||
| 3. Download a tiddlywiki from http://tiddlywiki.com/, and **place in that subdir**. | ||
| ## Aim | ||
| 1. to replace (as far as possible) the now defunct tiddlyfox extension, and provide backups. | ||
|
|
||
| ## Scope and limitations | ||
| 1. This is a browser extension designed to work with chrome and other chromium based browsers, and the new firefox browser (v57 and latter). | ||
| 2. Due to browser restrictions tiddlywikis must be located below a subdir of the browser's download directory . The default directory is called 'tiddlywikilocations'. | ||
| 3. A test file needs to be downloaded (and then delete) to find the location of the download directory as there is no api for reading the download directory location. | ||
|
|
||
| ## Gotchas | ||
| In chome there is the event 'onDeterminingFilename' which extensions can watch for and override the target DownloadItem.filename (some extensions move downloads into different folders by file type) which would break things. | ||
| onDeterminingFilename has not been implemented in firefox. | ||
|
|
||
| The Download directory must not be beneath a directory called tiddlywikilocations. | ||
|
|
||
| These are tested for within the extension and if found, control is passed to the file chooser. | ||
|
|
||
| # |