From abc1d9ef100b774f2b4b4450d8aec1d4d3ad0c35 Mon Sep 17 00:00:00 2001 From: Stefan Froemken Date: Wed, 25 Mar 2020 15:14:00 +0100 Subject: [PATCH] Update Documentation --- Documentation/Administrator/Index.rst | 11 ++-- Documentation/Developer/Index.rst | 15 ++---- Documentation/Index.rst | 69 ++++++++++++------------ Documentation/Introduction/Index.rst | 7 +-- Documentation/Settings.cfg | 78 +++++++++++++++++++++++++++ Documentation/Settings.yml | 29 ---------- Documentation/Targets.rst | 14 ----- 7 files changed, 120 insertions(+), 103 deletions(-) create mode 100644 Documentation/Settings.cfg delete mode 100644 Documentation/Settings.yml delete mode 100644 Documentation/Targets.rst diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst index 8118605..189184e 100644 --- a/Documentation/Administrator/Index.rst +++ b/Documentation/Administrator/Index.rst @@ -1,9 +1,4 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt +.. include:: ../Includes.txt .. _admin-manual: @@ -45,5 +40,5 @@ Yes it is. It uses the comIP() method of GeneralUtility to validate and compare What about "Logout"? ^^^^^^^^^^^^^^^^^^^^ -Ah yeah. That's funny? Users with matched IP addresses are authentificated with EACH request. You can't logout. So, -if you press "Logout" the page reloads, we have a new request and you're logged in again. \ No newline at end of file +Ah yeah. That's funny? Users with matched IP addresses are authenticated with EACH request. You can't logout. So, +if you press "Logout" the page reloads, we have a new request and you're logged in again. diff --git a/Documentation/Developer/Index.rst b/Documentation/Developer/Index.rst index dc17cc3..6b3f075 100644 --- a/Documentation/Developer/Index.rst +++ b/Documentation/Developer/Index.rst @@ -1,9 +1,4 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt +.. include:: ../Includes.txt .. _developer: @@ -20,11 +15,11 @@ Structure All classes are based on namespaces. So you can't use this extension on TYPO3 Versions below 6.0. -We register this service with a priority of 80 and a quality of 80. With these values we are higher than the -services of felogin, openID and saltedpasswords. So, if IP does not match, we give all the other services a try +We register this service with a priority of 70 and a quality of 70. With these values we are higher than the +services of felogin and saltedpasswords. So, if IP does not match, we give the other services a try to login the user. -Example: userA will be logged in to frontend automatically, if he is online with the static IP address from his +Example: user A will be logged in to frontend automatically, if he is online with the static IP address from his company. When userA is online at home the IP address will not match, but the userA has still the possibility to login via felogin or similar. @@ -37,4 +32,4 @@ deactivate jwauth in extension manager, but these users can still browse to your administrator must always have the opportunity to deactivate such a feature directly. It could be that browsing with activated jwauth can slow down your website some milliseconds. That's because users -theirs IP address matches have to process the complete user authentication with each request. \ No newline at end of file +theirs IP address matches have to process the complete user authentication with each request. diff --git a/Documentation/Index.rst b/Documentation/Index.rst index bd0ec8a..356f0b5 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,61 +1,58 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - .. include:: Includes.txt +.. Every manual should have a start label for cross-referencing to +.. start page. Do not remove this! + .. _start: ============================================================= -jwauth +Events2 ============================================================= .. only:: html - :Classification: - jwauth + :Classification: + jwauth - :Version: - |0.1.0| + :Version: + |release| - :Language: - en + :Language: + en - :Description: - Manual covering TYPO3 extension jwauth + :Description: + Manual covering TYPO3 extension jwauth - :Keywords: - authentication,service,ip,login + :Keywords: + authentication, auth, jwauth, ip, ipv4, ipv6 - :Copyright: - 2015 + :Copyright: + 2012-2020 - :Author: - Stefan Froemken + :Author: + Stefan Froemken - :Email: - projects@jweiland.net + :Email: + projects@jweiland.net - :License: - This document is published under the Open Content License - available from http://www.opencontent.org/opl.shtml + :License: + This document is published under the Open Publication License + available from http://www.opencontent.org/openpub/ - :Rendered: - |13.04.2015| + :Rendered: + |today| - The content of this document is related to TYPO3, - a GNU/GPL CMS/Framework available from `www.typo3.org `_. + The content of this document is related to TYPO3, + a GNU/GPL CMS/Framework available from `www.typo3.org `__. - **Table of Contents** + **Table of Contents** .. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: + :maxdepth: 3 + - Introduction/Index - Administrator/Index - Targets + Introduction/Index + Administrator/Index + Developer/Index diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst index 6a83e74..d1e6914 100644 --- a/Documentation/Introduction/Index.rst +++ b/Documentation/Introduction/Index.rst @@ -1,9 +1,4 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt +.. include:: ../Includes.txt .. _introduction: diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg new file mode 100644 index 0000000..d47b213 --- /dev/null +++ b/Documentation/Settings.cfg @@ -0,0 +1,78 @@ +# coding: utf-8 + +# ##### +# +# Settings.cfg - A TYPO3 Documentation Project's Configuration File +# Information about Settings.cfg: +# https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#settings-cfg +# +# About Syntax: +# See https://docs.python.org/2/library/configparser.html +# +# Attention: +# Only " ;" can start an inline comment. +# This is: blank PLUS semicolon! +# +# ##### + +[general] + +; endless list of all of the general simple settings +; you can use in 'conf.py' + +project = jwauth (JW Auth) +version = 2.1.0 +release = 2.1 +t3author = Stefan Froemken +copyright = since 2012 by jweiland.net + +description = Documentation about our extension events2. Use it to manage, list and show various kinds of events. + +[html_theme_options] + +; for theme t3SphinxThemeRtd + +# NOTE: Fill in YOUR values in the following! + +github_branch = master +github_commit_hash = +github_repository = jweiland-net/jwauth +github_revision_msg = +github_sphinx_locale = +# project_contact = documentation@typo3.org +project_contact = projects@jweiland.net +# project_discussions= http://... +project_discussions = +# project_home = +project_home = +# project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/issues +project_issues = https://github.com/jweiland-net/jwauth/issues +# project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual +project_repository = https://github.com/jweiland-net/jwauth +use_opensearch = + + +[intersphinx_mapping] + +; Comment out what you don't use. +; Uncomment only what you actually use in crossreferencing! + +# t3api = https://typo3.org/api/typo3cms/ +# t3cgl = https://docs.typo3.org/typo3cms/CodingGuidelinesReference/ +# t3coreapi = https://docs.typo3.org/typo3cms/CoreApiReference/ +# t3editors = https://docs.typo3.org/typo3cms/EditorsTutorial/ +# t3extbasebook = https://docs.typo3.org/typo3cms/ExtbaseFluidBook/ +# t3fal = https://docs.typo3.org/typo3cms/FileAbstractionLayerReference/ +# t3inside = https://docs.typo3.org/typo3cms/InsideTypo3Reference/ +# t3install = https://docs.typo3.org/typo3cms/InstallationGuide/ +# t3l10n = https://docs.typo3.org/typo3cms/FrontendLocalizationGuide/ +# t3security = https://docs.typo3.org/typo3cms/SecurityGuide/ +# t3services = https://docs.typo3.org/typo3cms/Typo3ServicesReference/ +# t3skinning = https://docs.typo3.org/typo3cms/SkinningReference/ +# t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial/ +# t3tca = https://docs.typo3.org/typo3cms/TCAReference/ +# t3templating = https://docs.typo3.org/typo3cms/TemplatingTutorial/ +# t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/ +# t3tsconfig = https://docs.typo3.org/typo3cms/TSconfigReference/ +t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/ +# t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/ diff --git a/Documentation/Settings.yml b/Documentation/Settings.yml deleted file mode 100644 index c2a3c3b..0000000 --- a/Documentation/Settings.yml +++ /dev/null @@ -1,29 +0,0 @@ -# This is the project specific Settings.yml file. -# Place Sphinx specific build information here. -# Settings given here will replace the settings of 'conf.py'. - -# Below is an example of intersphinx mapping declaration -# Add more mappings depending on what manual you want to link to -# Remove entirely if you don't need cross-linking - ---- -conf.py: - copyright: 2012-2013 - project: Extension Name - version: x.y - release: x.y.z - intersphinx_mapping: - t3tsref: - - http://docs.typo3.org/typo3cms/TyposcriptReference/ - - null - latex_documents: - - - Index - - .tex - - Extension Name - - Your Name - - manual - latex_elements: - papersize: a4paper - pointsize: 10pt - preamble: \usepackage{typo3} -... diff --git a/Documentation/Targets.rst b/Documentation/Targets.rst deleted file mode 100644 index 82bb940..0000000 --- a/Documentation/Targets.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: Includes.txt - - -.. _labels-for-crossreferencing: - -Index: Labels for Cross-referencing -=================================== - -.. ref-targets-list::