add documentation

Documentation/AdministratorManual/Index.rst

@@ -0,0 +1,33 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. 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 colorcube/bookmark-pages
+
+2. Installation with Extension Manager
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Download and install the extension with the extension manager module.
+

Documentation/Configuration/Index.rst

@@ -0,0 +1,96 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. 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::
+
+    Keep in mind that the plugin is silent unless you're logged in.
+
+
+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.
+
+
+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_bookmarkpages.view)
+
+
+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 which is used for the bookmark button.
+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
+
+    <a class="bookmark-ajax-submit bookmark-this-page"
+    data-ajaxuri="{t:uri.ajaxAction(extensionName: 'bookmarkpages', pluginName: 'Bookmarks', controller: 'Bookmarks', action: 'bookmark', contextRecord: 'currentPage')}"
+    >bookmark page</a>
+
+You can place the snippet in any template not just the plugin templates.
+

Documentation/Includes.txt

@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in this documentation project (= manual).
+
+
+.. ==================================================
+.. DEFINE SOME TEXT ROLES
+.. --------------------------------------------------
+
+.. role::   typoscript(code)
+
+.. role::   ts(typoscript)
+   :class:  typoscript
+
+.. role::   php(code)
+
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,61 @@
+.. ==================================================
+.. 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:
+		fun
+
+	:Copyright:
+		2016-2018
+
+	:Author:
+		René Fritz
+
+	:Email:
+		r.fritz@colorcube.de
+
+	: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 <http://www.typo3.org/>`_.
+
+
+	**Table of Contents**
+
+.. toctree::
+	:maxdepth: 5
+
+    	Introduction/Index
+    	Configuration/Index
+    	AdministratorManual/Index
+    	Support/Index
+    	Links

Documentation/Introduction/Index.rst

@@ -0,0 +1,33 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+Introduction
+============
+
+What does it do?
+----------------
+
+This is a TYPO3 plugin that provides bookmarks functionality of local pages for logged in frontend users.
+For example this is very helpful for intranet websites.
+
+TypoScript and fluid templates are just examples. Adapt it to your needs.
+
+In the example templates there's nothing shown if the user is not logged in.
+
+
+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/Links.rst

@@ -0,0 +1,19 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+.. _links:
+
+Links
+-----
+
+
+:Git Repository:
+    	https://github.com/colorcube/bookmark_pages
+
+:Bug Tracker:
+	https://github.com/colorcube/bookmark_pages/issues

Documentation/Settings.yml

@@ -0,0 +1,21 @@
+# This is the project specific Settings.yml file.
+# Place Sphinx specific build information here.
+# Settings given here will replace the settings of 'conf.py'.
+
+---
+conf.py:
+  copyright: 2016-2018
+  project: Bookmark Pages
+  version: 1.0.0
+  release: 1.0.0
+  latex_documents:
+  - - Index
+    - bookmark_pages.tex
+    - Bookmark Pages
+    - René Fritz
+    - manual
+  latex_elements:
+    papersize: a4paper
+    pointsize: 10pt
+    preamble: \usepackage{typo3}
+...

Documentation/Support/Index.rst

@@ -0,0 +1,38 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. 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/colorcube/bookmark_pages/issues
+
+Sponsoring
+----------
+
+If you need a feature which is not yet implemented, feel free to contact me anytime!
+
+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 :-)
+
+