From 1cafacfedd41ebd7bbf442a24a81b33cc24b1838 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sun, 1 Jul 2018 12:27:55 +0200 Subject: Docs: rename 'How-to' section to 'Guides' Signed-off-by: VirtualTam --- doc/md/Backup,-restore,-import-and-export.md | 64 --------------------------- doc/md/Various-hacks.md | 33 -------------- doc/md/guides/backup-restore-import-export.md | 64 +++++++++++++++++++++++++++ doc/md/guides/various-hacks.md | 33 ++++++++++++++ index.php | 2 +- mkdocs.yml | 6 +-- 6 files changed, 101 insertions(+), 101 deletions(-) delete mode 100644 doc/md/Backup,-restore,-import-and-export.md delete mode 100644 doc/md/Various-hacks.md create mode 100644 doc/md/guides/backup-restore-import-export.md create mode 100644 doc/md/guides/various-hacks.md diff --git a/doc/md/Backup,-restore,-import-and-export.md b/doc/md/Backup,-restore,-import-and-export.md deleted file mode 100644 index bb790074..00000000 --- a/doc/md/Backup,-restore,-import-and-export.md +++ /dev/null @@ -1,64 +0,0 @@ -## Backup and restore the datastore file - -Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place. - -Example command: -```bash -rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php -``` - -## Export links as... - -To export links as an HTML file, under _Tools > Export_, choose: - -- _Export all_ to export both public and private links -- _Export public_ to export public links only -- _Export private_ to export private links only - -Restore by using the `Import` feature. - -- This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. - -Example command: -```bash -./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all -``` - -## Import links from... - -### Diigo - -If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.) - -### Mister Wong - -See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks. - -### SemanticScuttle - -To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase). - -### Scuttle - -Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). - -However, you can use the third-party [scuttle-to-shaarli](https://github.com/q2apro/scuttle-to-shaarli) -tool to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer. - -### Refind - -You can use the third-party tool [Derefind](https://github.com/ShawnPConroy/Derefind) to convert refind.com bookmark exports to a format that can be imported into Shaarli. - -## Import Shaarli links to Firefox - -- Export your Shaarli links as described above. - - For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)` -- In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`) -- Select `Import and Backup > Import bookmarks in HTML format` - -Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time. - -You may be interested in these Firefox addons to manage links imported from Shaarli - -- [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks -- [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags diff --git a/doc/md/Various-hacks.md b/doc/md/Various-hacks.md deleted file mode 100644 index 0074ae9f..00000000 --- a/doc/md/Various-hacks.md +++ /dev/null @@ -1,33 +0,0 @@ -### Decode datastore content - -To display the array representing the data saved in `data/datastore.php`, use the following snippet: - -```php -$data = "tZNdb9MwFIb... "; -$out = unserialize(gzinflate(base64_decode($data))); -echo "
"; // Pretty printing is love, pretty printing is life
-print_r($out);
-echo "
"; -exit; -``` -This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). - -Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): -``` -php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . -``` - -### Changing the timestamp for a shaare - -- Look for `` in `tpl/editlink.tpl` (line 14) -- Replace `type="hidden"` with `type="text"` from this line -- A new date/time field becomes available in the edit/new link dialog. -- You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. - - -### See also - -- [Add a new custom field to shaares (example patch)](https://gist.github.com/nodiscc/8b0194921f059d7b9ad89a581ecd482c) -- [Download CSS styles for shaarlis listed in an opml file](https://gist.github.com/nodiscc/dede231c92cab22c3ad2cc24d5035012) -- [Copy an existing Shaarli installation over SSH, and serve it locally](https://gist.github.com/nodiscc/ed161c66e5b028b5299b0a3733d01c77) -- [Create multiple Shaarli instances, generate an HTML index of them](https://gist.github.com/nodiscc/52e711cda3bc47717c16065231cf6b20) diff --git a/doc/md/guides/backup-restore-import-export.md b/doc/md/guides/backup-restore-import-export.md new file mode 100644 index 00000000..bb790074 --- /dev/null +++ b/doc/md/guides/backup-restore-import-export.md @@ -0,0 +1,64 @@ +## Backup and restore the datastore file + +Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place. + +Example command: +```bash +rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php +``` + +## Export links as... + +To export links as an HTML file, under _Tools > Export_, choose: + +- _Export all_ to export both public and private links +- _Export public_ to export public links only +- _Export private_ to export private links only + +Restore by using the `Import` feature. + +- This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. + +Example command: +```bash +./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all +``` + +## Import links from... + +### Diigo + +If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.) + +### Mister Wong + +See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks. + +### SemanticScuttle + +To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase). + +### Scuttle + +Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). + +However, you can use the third-party [scuttle-to-shaarli](https://github.com/q2apro/scuttle-to-shaarli) +tool to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer. + +### Refind + +You can use the third-party tool [Derefind](https://github.com/ShawnPConroy/Derefind) to convert refind.com bookmark exports to a format that can be imported into Shaarli. + +## Import Shaarli links to Firefox + +- Export your Shaarli links as described above. + - For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)` +- In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`) +- Select `Import and Backup > Import bookmarks in HTML format` + +Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time. + +You may be interested in these Firefox addons to manage links imported from Shaarli + +- [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks +- [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags diff --git a/doc/md/guides/various-hacks.md b/doc/md/guides/various-hacks.md new file mode 100644 index 00000000..0074ae9f --- /dev/null +++ b/doc/md/guides/various-hacks.md @@ -0,0 +1,33 @@ +### Decode datastore content + +To display the array representing the data saved in `data/datastore.php`, use the following snippet: + +```php +$data = "tZNdb9MwFIb... "; +$out = unserialize(gzinflate(base64_decode($data))); +echo "
"; // Pretty printing is love, pretty printing is life
+print_r($out);
+echo "
"; +exit; +``` +This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). + +Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): +``` +php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . +``` + +### Changing the timestamp for a shaare + +- Look for `` in `tpl/editlink.tpl` (line 14) +- Replace `type="hidden"` with `type="text"` from this line +- A new date/time field becomes available in the edit/new link dialog. +- You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. + + +### See also + +- [Add a new custom field to shaares (example patch)](https://gist.github.com/nodiscc/8b0194921f059d7b9ad89a581ecd482c) +- [Download CSS styles for shaarlis listed in an opml file](https://gist.github.com/nodiscc/dede231c92cab22c3ad2cc24d5035012) +- [Copy an existing Shaarli installation over SSH, and serve it locally](https://gist.github.com/nodiscc/ed161c66e5b028b5299b0a3733d01c77) +- [Create multiple Shaarli instances, generate an HTML index of them](https://gist.github.com/nodiscc/52e711cda3bc47717c16065231cf6b20) diff --git a/index.php b/index.php index 29d67f62..5fc880e6 100644 --- a/index.php +++ b/index.php @@ -1103,7 +1103,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, // Linkdate is kept here to: // - use the same permalink for notes as they're displayed when creating them // - let users hack creation date of their posts - // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare + // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare $linkdate = escape($_POST['lf_linkdate']); if (isset($LINKSDB[$id])) { // Edit diff --git a/mkdocs.yml b/mkdocs.yml index a1226e8f..7f6ce255 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,9 +27,9 @@ pages: - RSS feeds: RSS-feeds.md - REST API: REST-API.md - Community & Related software: Community-&-Related-software.md -- How To: - - Backup, restore, import and export: Backup,-restore,-import-and-export.md - - Various hacks: Various-hacks.md +- Guides: + - Backup, restore, import and export: guides/backup-restore-import-export.md + - Various hacks: guides/various-hacks.md - Development: - Development guidelines: Development-guidelines.md - Continuous integration tools: Continuous-integration-tools.md -- cgit v1.2.3