From 08dcd8ea58c07cd8258567ca14260aa18ba2660f Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 14 May 2016 11:37:28 +0200 Subject: [PATCH 1/1] Doc update Signed-off-by: ArthurHoaro --- doc/3rd-party-libraries.html | 3 +- doc/Backup,-restore,-import-and-export.html | 3 +- doc/Browsing-and-searching.html | 3 +- doc/Coding-guidelines.html | 3 +- doc/Community-&-Related-software.html | 10 ++- doc/Community-&-Related-software.md | 10 ++- ...llation-over-SSH-and-serve-it-locally.html | 3 +- ...te-and-serve-multiple-Shaarlis-(farm).html | 3 +- doc/Datastore-hacks.html | 3 +- doc/Development.html | 3 +- doc/Directory-structure.html | 3 +- doc/Docker.html | 3 +- ...Download-CSS-styles-from-an-OPML-list.html | 3 +- doc/Download.html | 3 +- ...e-patch---add-new-via-field-for-links.html | 3 +- doc/FAQ.html | 3 +- doc/Firefox-share.html | 3 +- doc/GnuPG-signature.html | 3 +- doc/Home.html | 3 +- doc/Plugin-System.html | 4 +- doc/Plugin-System.md | 1 + doc/Plugin-list.html | 87 ------------------- doc/Plugin-list.md | 18 ---- ...tion-&-configuration.html => Plugins.html} | 10 ++- ...allation-&-configuration.md => Plugins.md} | 10 ++- doc/RSS-feeds.html | 3 +- doc/Release-Shaarli.html | 3 +- doc/Security.html | 3 +- doc/Server-configuration.html | 3 +- doc/Server-requirements.html | 3 +- doc/Server-security.html | 3 +- doc/Shaarli-configuration.html | 3 +- doc/Shaarli-installation.html | 3 +- doc/Sharing-button.html | 3 +- doc/Static-analysis.html | 3 +- doc/TODO.html | 3 +- doc/Theming.html | 3 +- doc/Troubleshooting.html | 3 +- doc/Unit-tests.html | 3 +- ...rade-from-original-sebsauvage-Shaarli.html | 3 +- doc/Usage.html | 3 +- doc/_Footer.html | 3 +- doc/_Sidebar.html | 6 +- doc/_Sidebar.md | 3 +- doc/sidebar.html | 3 +- 45 files changed, 70 insertions(+), 194 deletions(-) delete mode 100644 doc/Plugin-list.html delete mode 100644 doc/Plugin-list.md rename doc/{Plugin-installation-&-configuration.html => Plugins.html} (95%) rename doc/{Plugin-installation-&-configuration.md => Plugins.md} (92%) diff --git a/doc/3rd-party-libraries.html b/doc/3rd-party-libraries.html index 0da63f22..f6ff4763 100644 --- a/doc/3rd-party-libraries.html +++ b/doc/3rd-party-libraries.html @@ -23,10 +23,9 @@
  • Server security
  • Shaarli installation
  • Shaarli configuration
    • -
  • Plugin installation & configuration
    • +
  • Plugins
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage

    Third party plugins

      -
    • autosave - periodically saves contents of the Edit link/Save link dialog to your browser's LocalStorage to avoid data loss when typing a long entry.
      • +
    • autosave by @kalvn: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.
      • +
    • Code Coloration by @ArthurHoaro: client side code syntax highlighter.
      • +
    • social by @alexisju: share links to social networks.
      • +
    • emojione by @NerosTie: Add colorful emojis to your Shaarli.
      • +
    • launch - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.

    Themes

    See Theming for the list of community-contributed themes, and an installation guide.

    diff --git a/doc/Community-&-Related-software.md b/doc/Community-&-Related-software.md index 27da45d8..03a3dea9 100644 --- a/doc/Community-&-Related-software.md +++ b/doc/Community-&-Related-software.md @@ -13,11 +13,17 @@ _TODO: contact repos owners to see if they'd like to standardize their work with - [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr)[](.html) - [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history)[](.html) - [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni)[](.html) -- [Shaarli Community](http://shaarferme.etudiant-libre.fr.nf/index.php) - Unknown Shaarli hoster (unsupported, old fork)[](.html) + ### Third party plugins - * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) - periodically saves contents of the _Edit link/Save link_ dialog to your browser's LocalStorage to avoid data loss when typing a long entry.[](.html) + + * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html) + * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html) + * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html) + * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie/emojione): Add colorful emojis to your Shaarli.[](.html) + * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.[](.html) + ### Themes See [Theming](Theming.html) for the list of community-contributed themes, and an installation guide. diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html index 067c6828..edb1555f 100644 --- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html +++ b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html @@ -60,10 +60,9 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
  • Server security
  • Shaarli installation
  • Shaarli configuration
    • -
  • Plugin installation & configuration
    • +
  • Plugins
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
  • Docker
    • -
  • Plugin list
  • Usage
    • Sharing button (bookmarklet)
      • @@ -279,6 +278,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf

      List of placeholders:

      • text: called after the end of the footer text.
        • +
      • endofpage: called at the end of the page.

      text_example

        diff --git a/doc/Plugin-System.md b/doc/Plugin-System.md index 8281e61d..623627dd 100644 --- a/doc/Plugin-System.md +++ b/doc/Plugin-System.md @@ -195,6 +195,7 @@ Items can be displayed in templates by adding an entry in `$data['' List of placeholders: * `text`: called after the end of the footer text. + * `endofpage`: called at the end of the page. ![text_example](http://i.imgur.com/L5S2YEH.png)[](.html) diff --git a/doc/Plugin-list.html b/doc/Plugin-list.html deleted file mode 100644 index 16eca046..00000000 --- a/doc/Plugin-list.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - Shaarli – Plugin list - - - - - - -

        Plugin list

        -

        Community plugins

        -

        These plugins are maintained by the community:

        -
          -
        • Archive.org - add a clickable icon to every link to archive.org.
          • -
        • Addlink in toolbar - add a field to paste new links URL in toolbar.
          • -
        • Markdown - write and display Shaare in Markdown.
          • -
        • Play videos - popup to play all videos displayed in linklist.
          • -
        • QRCode - add a clickable icon generating a QRCode for every link.
          • -
        • ReadItYourself - add a clickable icon for ReadItYourself.
          • -
        • Wallabag - add a clickable icon for Wallabag.
          • -
        -

        Third party plugins

        - - - diff --git a/doc/Plugin-list.md b/doc/Plugin-list.md deleted file mode 100644 index bb4f553b..00000000 --- a/doc/Plugin-list.md +++ /dev/null @@ -1,18 +0,0 @@ -#Plugin list -## Community plugins - -These plugins are maintained by the community: - - * Archive.org - add a clickable icon to every link to archive.org. - * Addlink in toolbar - add a field to paste new links URL in toolbar. - * Markdown - write and display Shaare in Markdown. - * Play videos - popup to play all videos displayed in linklist. - * QRCode - add a clickable icon generating a QRCode for every link. - * ReadItYourself - add a clickable icon for ReadItYourself. - * Wallabag - add a clickable icon for Wallabag. - -## Third party plugins - - * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html) - * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html) - * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html) diff --git a/doc/Plugin-installation-&-configuration.html b/doc/Plugins.html similarity index 95% rename from doc/Plugin-installation-&-configuration.html rename to doc/Plugins.html index 3d2f9704..e7df6aed 100644 --- a/doc/Plugin-installation-&-configuration.html +++ b/doc/Plugins.html @@ -4,7 +4,7 @@ - Shaarli – Plugin installation & configuration + Shaarli – Plugins