mirror of
https://github.com/werkraum-media/abtest.git
synced 2024-11-14 17:56:11 +01:00
Documentation added
This commit is contained in:
parent
f1e6c42252
commit
9a9a7eee2b
13 changed files with 344 additions and 0 deletions
16
Documentation/AdministratorManual/BestPractice/Index.rst
Normal file
16
Documentation/AdministratorManual/BestPractice/Index.rst
Normal file
|
@ -0,0 +1,16 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
Best practice
|
||||
-------------
|
||||
|
||||
.. only:: html
|
||||
|
||||
This chapter describes some best practice concepts
|
||||
|
||||
TODO
|
23
Documentation/AdministratorManual/Index.rst
Normal file
23
Documentation/AdministratorManual/Index.rst
Normal file
|
@ -0,0 +1,23 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../Includes.txt
|
||||
|
||||
|
||||
.. _admin-manual:
|
||||
|
||||
For administrators
|
||||
==================
|
||||
|
||||
.. only:: html
|
||||
|
||||
This chapter describes how to manage the extension from a superuser point of view.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
|
||||
Installation/Index
|
||||
BestPractice/Index
|
42
Documentation/AdministratorManual/Installation/Index.rst
Normal file
42
Documentation/AdministratorManual/Installation/Index.rst
Normal file
|
@ -0,0 +1,42 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
.. _installation:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
.. important::
|
||||
|
||||
The extension needs to be installed as any other extension of TYPO3 CMS:
|
||||
|
||||
#. Switch to the module “Extension Manager”.
|
||||
|
||||
#. Get the extension
|
||||
|
||||
#. **Get it from the Extension Manager:** Press the “Retrieve/Update”
|
||||
button and search for the extension key *abtest2* and import the
|
||||
extension from the repository.
|
||||
|
||||
#. **Get it from typo3.org:** You can always get current version from
|
||||
`http://typo3.org/extensions/repository/view/abtest2/current/
|
||||
<http://typo3.org/extensions/repository/view/abtest2/current/>`_ by
|
||||
downloading the zip version. Upload
|
||||
the file afterwards in the Extension Manager.
|
||||
|
||||
#. **Use composer**: Use `composer require svewap/abtest2`.
|
||||
|
||||
#. The Extension Manager offers some basic configuration which is
|
||||
explained :ref:`here <extensionManager>`.
|
||||
|
||||
Latest version from git
|
||||
-----------------------
|
||||
You can get the latest version from git by using the git command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/svewap/abtest2.git
|
Before Width: | Height: | Size: 131 KiB After Width: | Height: | Size: 131 KiB |
BIN
Documentation/Images/page_settings.png
Normal file
BIN
Documentation/Images/page_settings.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 29 KiB |
29
Documentation/Includes.txt
Normal file
29
Documentation/Includes.txt
Normal file
|
@ -0,0 +1,29 @@
|
|||
.. ==================================================
|
||||
.. 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
|
||||
|
||||
.. |img-demo| image:: /Images/demo.gif
|
||||
.. :border: 0
|
||||
.. :align: left
|
||||
|
||||
.. |img-page-settings| image:: /Images/page_settings.png
|
||||
.. :border: 0
|
||||
.. :align: left
|
54
Documentation/Index.rst
Normal file
54
Documentation/Index.rst
Normal file
|
@ -0,0 +1,54 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: Includes.txt
|
||||
|
||||
|
||||
.. _start:
|
||||
|
||||
=============================================================
|
||||
TYPO3 extension for A/B tests
|
||||
=============================================================
|
||||
|
||||
.. only:: html
|
||||
|
||||
:Classification:
|
||||
abtest2
|
||||
|
||||
:Version:
|
||||
|release|
|
||||
|
||||
:Language:
|
||||
en
|
||||
|
||||
:Keywords:
|
||||
abtest
|
||||
|
||||
:Copyright:
|
||||
2017
|
||||
|
||||
:Author:
|
||||
Sven Wappler
|
||||
|
||||
:License:
|
||||
This document is published under the Open Content License
|
||||
available from http://www.opencontent.org/opl.shtml
|
||||
|
||||
: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: 3
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
Introduction/Index
|
||||
AdministratorManual/Index
|
23
Documentation/Introduction/About/Index.rst
Normal file
23
Documentation/Introduction/About/Index.rst
Normal file
|
@ -0,0 +1,23 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
.. _about:
|
||||
|
||||
What does it do?
|
||||
================
|
||||
|
||||
This extension supports TYPO3 administrators in performing A/B tests. This is useful when a site owner want to measure whether a new version improves or reduces user interaction compared to the current version.
|
||||
|
||||
|
||||
**Features of the extension**
|
||||
|
||||
- Caching of each page version
|
||||
- A real 50/50% chance. That means: No selection by random, because of the unreliable random method. So the versions are always taken alternately.
|
||||
- Complete different content with same page id. So only one URL for two versions. The displayed version is determined by the cookie value.
|
||||
|
||||
|
||||
|img-demo|
|
21
Documentation/Introduction/Index.rst
Normal file
21
Documentation/Introduction/Index.rst
Normal file
|
@ -0,0 +1,21 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. _introduction:
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
.. only:: html
|
||||
|
||||
This chapter gives you a basic introduction about the TYPO3 CMS extension "*news*".
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
|
||||
About/Index
|
||||
Support/Index
|
||||
Thanks/Index
|
26
Documentation/Introduction/Support/Index.rst
Normal file
26
Documentation/Introduction/Support/Index.rst
Normal file
|
@ -0,0 +1,26 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
.. _support:
|
||||
|
||||
Need Support?
|
||||
=============
|
||||
There are various ways to get support for this extension!
|
||||
|
||||
Stackoverflow
|
||||
-------------
|
||||
Please use https://stackoverflow.com to get best support. Tags you should use are `typo3` and `abtest2`.
|
||||
|
||||
Sponsoring
|
||||
----------
|
||||
If you need a feature which is not yet implemented, feel free to contact me anytime!
|
||||
|
||||
Private/Personal support
|
||||
------------------------
|
||||
If you need private or personal support, ask one of the developers for it.
|
||||
|
||||
**Be aware that this support might not be free!**
|
32
Documentation/Introduction/Thanks/Index.rst
Normal file
32
Documentation/Introduction/Thanks/Index.rst
Normal file
|
@ -0,0 +1,32 @@
|
|||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
.. _thanks:
|
||||
|
||||
Say thanks!
|
||||
===========
|
||||
This extension and manual has been created in hours, mostly by a single person.
|
||||
It is actively maintained to fit all supported TYPO3 versions, user interface concepts and best practice approaches.
|
||||
|
||||
If this extension helps you in anyway to achieve your requirements, please think about giving something back.
|
||||
Or you want to sponsor a feature to extend something that's already there? Then find some ideas to make me happy below - I'm looking forward to get in contact with you!
|
||||
|
||||
Nice mails
|
||||
^^^^^^^^^^
|
||||
Some nice words fit every time - just drop me some kind words by mail to make me happy :-)
|
||||
|
||||
Talk about it
|
||||
^^^^^^^^^^^^^
|
||||
If you like what I've built, then share it wherever it fits. Maybe this will help to spread the word and find others that can profit from it, too.
|
||||
|
||||
Let's have a tee
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
If you're in the region of Aachen, just let me know. I'm always looking forward to meeting new and known faces and to exchange on several topics.
|
||||
|
||||
Money
|
||||
^^^^^
|
||||
If you have too much of it and want to share parts of your money with me, just let me know and we'll find a way to organize that :-)
|
48
Documentation/Settings.cfg
Normal file
48
Documentation/Settings.cfg
Normal file
|
@ -0,0 +1,48 @@
|
|||
[html_theme_options]
|
||||
project_contact =
|
||||
use_opensearch =
|
||||
project_home =
|
||||
project_issues =
|
||||
github_revision_msg =
|
||||
github_branch =
|
||||
github_repository =
|
||||
project_repository =
|
||||
project_discussions =
|
||||
github_sphinx_locale =
|
||||
github_commit_hash =
|
||||
|
||||
[intersphinx_mapping]
|
||||
t3tsref = http://docs.typo3.org/typo3cms/TyposcriptReference/
|
||||
t3editors = http://docs.typo3.org/typo3cms/EditorsTutorial/
|
||||
t3start = http://docs.typo3.org/typo3cms/GettingStartedTutorial/
|
||||
|
||||
[latex_elements]
|
||||
papersize = a4paper
|
||||
preamble = \usepackage{typo3}
|
||||
pointsize = 10pt
|
||||
|
||||
[general]
|
||||
project = abtest2
|
||||
release = 1.0.0
|
||||
version = 1.0
|
||||
copyright = 2017
|
||||
|
||||
[notify]
|
||||
about_new_build = no
|
||||
# have one or more receivers notified
|
||||
# about_new_build = email-1 [, email2, ...]
|
||||
|
||||
|
||||
# About Settings.cfg
|
||||
|
||||
# normal:
|
||||
# https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/TemplatesForCopying/ExampleFiles/Settings-minimal.cfg
|
||||
|
||||
# extensive:
|
||||
# https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/TemplatesForCopying/ExampleFiles/Settings-extensive.cfg
|
||||
|
||||
# Example files:
|
||||
# https://github.com/marble/typo3-docs-typo3-org-resources/tree/master/TemplatesForCopying/ExampleFiles
|
||||
|
||||
# More:
|
||||
# http://mbless.de/blog/2015/10/24/a-new-task-for-an-old-server.html#ini-files
|
30
Documentation/Settings.yml
Normal file
30
Documentation/Settings.yml
Normal file
|
@ -0,0 +1,30 @@
|
|||
# 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: 2017
|
||||
project: abtest2
|
||||
version: 1.0
|
||||
release: 1.0.0
|
||||
latex_documents:
|
||||
- - Index
|
||||
html_theme_options:
|
||||
github_repository: svewap/abtest2
|
||||
github_branch: master
|
||||
latex_elements:
|
||||
papersize: a4paper
|
||||
pointsize: 10pt
|
||||
preamble: \usepackage{typo3}
|
||||
intersphinx_mapping:
|
||||
t3tsref:
|
||||
- http://docs.typo3.org/typo3cms/TyposcriptReference/
|
||||
- null
|
||||
t3start:
|
||||
- http://docs.typo3.org/typo3cms/GettingStartedTutorial/
|
||||
- null
|
||||
t3editors:
|
||||
- http://docs.typo3.org/typo3cms/EditorsTutorial/
|
||||
- null
|
||||
...
|
Loading…
Reference in a new issue