first commit

Documentation/AdministratorManual/Index.rst

@@ -0,0 +1,28 @@
+.. include:: ../Includes.txt
+
+
+.. _admin-manual:
+
+Administrator Manual
+====================
+
+Installation
+------------
+
+There are two ways to properly install the extension.
+
+1. Composer installation
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+In case you use Composer to manage dependencies of your TYPO3 project,
+you can just issue the following Composer command in your project root directory.
+
+.. code-block:: bash
+
+	composer require wapplersystems/bookmark-pages
+
+2. Installation with Extension Manager
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Download and install the extension with the extension manager module.
+

Documentation/Changelog/2.0.0.rst

@@ -0,0 +1,39 @@
+.. include:: ../Includes.txt
+
+.. highlight:: none
+
+====================================
+Changelog for release 2.0.0
+====================================
+
+Features
+========
+* [FEATURE] Enable multiple plugin use per page (22.04.2021, f335afc by roman)
+* [FEATURE] Load bookmarks from browsers local storage (16.04.2021, 1c7511d by roman)
+* [FEATURE] Cache main action, load list asynchronous (15.04.2021, d4e04e5 by roman)
+
+Bugfixes
+========
+* [BUGFIX] Correct issue with empty list (22.04.2021, 1f87412 by Roman)
+* [BUGFIX] Fix issue updating links (20.04.2021, 0a6e47e by roman)
+* [BUGFIX] Fix issue with empty accessible bookmarks (20.04.2021, 1b169ab by roman)
+
+Breaking changes
+================
+* [!!!][TASK] Enable local storage per default (27.04.2021, 2e460ca by roman)
+* [!!!][TASK] Remove access restriction (18.04.2021, 28c0248 by roman)
+* [!!!][TASK] Refactor js (16.04.2021, 9a09b96 by roman)
+
+Reference
+=========
+
+.. highlight:: shell
+
+Generated by:
+
+git log 1.2.2..2e460cac --pretty="* %s (%cd, %h by %an)" --date=format:%d.%m.%Y --abbrev-commit --grep
+
+**Note:** The above list contains just commits marked with [FEATURE], [BUGFIX] and [!!!]. Complementary commits are
+available at `Github <https://github.com/buepro/typo3-pizpalue/commits/master)>`__.
+
+

Documentation/Configuration/Index.rst

@@ -0,0 +1,97 @@
+.. include:: ../Includes.txt
+
+
+==============================
+Configuration
+==============================
+
+The plugin output doesn't look very cute after install. It is necessary to adopt it to your needs. Nevertheless it shouldn't be too hard.
+
+.. tip::
+
+   Have a look at the comments in the example template.
+
+
+Make it work
+============
+
+Here are the needed steps described to make the plugin work.
+
+Additional work might be needed to adapt is to your needs. Usually this is limited to template work.
+
+
+1. Include TypoScript
+---------------------
+
+Include the TypoScript in your template record or your site package.
+
+
+
+2. Include Plugin
+-----------------
+
+Include the `Bookmark Pages` plugin as content element. This is just for testing and not usually what you want.
+
+Login and you should see some output. On the introduction package it looks like this:
+
+
+.. figure:: ../Images/screenshot-fe.png
+
+   The login box is not part of this extension.
+
+The plugin might be inserted more than once on a page. In that case mark `Is complementary` under `Plugin Options`
+for all plugins except the first one.
+
+
+Customization
+=============
+
+
+1. TypoScript and Templates
+---------------------------
+
+You may just copy the needed parts to your site package.
+
+The fluid template paths can be configured as usual using TypoScript. Have a look into the TypoScript template
+(look for plugin.tx_wsbookmarkpages.view)
+
+The bookmarks might be stored in the browsers local storage allowing users to bookmark pages without being registered
+on the site. Storing the bookmarks locally as well safes unnecessary server requests. The feature can be enabled
+through the constants editor.
+
+
+2. JavaScript and JQuery
+------------------------
+
+The provided example uses JQuery for ajax requests. JQuery is included by TypoScript. You might want to remove that with:
+
+.. code-block:: typoscript
+
+   page.includeJSFooterlibs.bookmark_pages_jquery >
+
+If you don't use JQuery you have to adapt the JavaScript.
+Have a look into Resources/Public/Scripts/JavaScript/bookmark_pages.js
+
+
+3. Include in your page template
+--------------------------------
+
+The rendering of the bookmarks list might be something you want to include into your page template. This could be done
+in a fluid template like this:
+
+
+.. code-block:: html
+
+   <f:cObject typoscriptObjectPath="tt_content.list.20.bookmarkpages_bookmarks"/>
+
+
+Of course you want a bookmark button on every page. This can be done in fluid like this:
+
+.. code-block:: html
+
+   <div class="bookmark-pages">
+      <p><a class="bookmark-ajax-submit bookmark-this-page" href="javascript:void(0);">Bookmark page in templates</a></p>
+   </div>
+
+You can place the snippet in any template not just the plugin templates.
+

Documentation/Includes.txt

@@ -0,0 +1,14 @@
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in THIS documentation project (= manual).
+
+.. role:: aspect (emphasis)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: typoscript(code)
+
+.. role:: ts(typoscript)
+   :class: typoscript
+
+.. default-role:: code
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,57 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+.. _start:
+
+=============================================================
+Bookmark Pages
+=============================================================
+
+.. only:: html
+
+	:Classification:
+		bookmark_pages
+
+	:Version:
+		|release|
+
+	:Language:
+		en
+
+	:Description:
+		Provides bookmarks functionality of local pages for logged in frontend users
+
+	:Keywords:
+		bookmark page
+
+	:Copyright:
+		2016-2020
+
+	:Author:
+		René Fritz
+
+	:License:
+		This document is published under the Open Publication License
+		available from http://www.opencontent.org/openpub/
+
+	:Rendered:
+		|today|
+
+	The content of this document is related to TYPO3,
+	a GNU/GPL CMS/Framework available from `www.typo3.org <https://www.typo3.org/>`_.
+
+
+.. toctree::
+	:hidden:
+
+    	Sitemap/Index
+    	Introduction/Index
+    	Configuration/Index
+    	AdministratorManual/Index
+    	Support/Index
+    	Links

Documentation/Introduction/Index.rst

@@ -0,0 +1,33 @@
+.. include:: ../Includes.txt
+
+
+Introduction
+============
+
+What does it do?
+----------------
+
+This is a TYPO3 plugin that provides bookmarks functionality of local pages.
+For example this is very helpful for intranet websites.
+
+The plugin can be configured to use the browsers local storage allowing non registered users to use the feature too.
+In case a website user likes to have the bookmarks available on different devices a frontend account might be used.
+After logging in the bookmarks are saved to the server hence might be accessed from within any device.
+
+TypoScript and fluid templates are just examples. Adapt it to your needs.
+
+The extension was created by `René Fritz <https://github.com/colorcube>`__. The ownership has been transferred in
+april 2021.
+
+
+Screenshots
+-----------
+
+
+.. figure:: ../Images/screenshot-styled-fe.png
+
+   The screenshot shows the functionality, the styling is not included.
+
+
+You have a list with bookmarks which can be deleted and you can place a 'bookmark' button anywhere on the page.
+

Documentation/Settings.cfg

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+[general]
+project = bookmark_pages
+release = 2.0.1
+version = 2.0.1
+
+[html_theme_options]
+github_branch        = master
+github_repository    = buepro/typo-bookmark_pages
+project_contact      = rb@buechler.pro
+project_home         = https://github.com/buepro/typo3-bookmark_pages
+project_issues       = https://github.com/buepro/typo3-bookmark_pages/issues
+project_repository   = https://github.com/buepro/typo3-bookmark_pages
+
+[extensions]
+issue = https://github.com/buepro/typo3-bookmark_pages/issues/%s | Issue #

Documentation/Sitemap/Index.rst

@@ -0,0 +1,12 @@
+ 
+:template: sitemap.html
+
+
+.. _Sitemap:
+
+=======
+Sitemap
+=======
+
+.. template 'sitemap.html' will insert the toctree as a sitemap here
+   below normal contents

Documentation/Support/Index.rst

@@ -0,0 +1,28 @@
+.. include:: ../Includes.txt
+
+
+Support and Feedback
+====================
+
+The extension is provided as is. Please understand that I can't give an extensive amount of support time for free.
+
+Any feedback is always appreciated.
+
+So if you have questions or feedback there are several options:
+
+Bug Tracker
+-----------
+
+For bug reports and feature requests: https://github.com/buepro/typo3-bookmark_pages/issues
+
+Commercial support
+------------------
+
+If you need commercial support, get in touch.
+
+Nice mails
+----------
+
+Some nice words fit every time - just drop me some kind words by mail to make me happy :-)
+
+