Skip to content

Commit

Permalink
Update guide for version 10 (#35)
Browse files Browse the repository at this point in the history 
* Update Settings.cfg

* Update README.rst

* Rename to /Includes.rst.txt

* Fix reST, Settings.cfg and README.rst

* Update frontpage

* Update frontpage

* Update frontpage

* Update README.rst

* Update README.rst

* test

* Add changelog file

* Changed Index.rst from tutorial to guide.

* Renamed to Guide for Editors.

* Added 'draft' message to top of page

* fix url

* semantic line breaks?

* Updates to changelog

* Improve changelog layout

* line

* removed targets from TOC

* Worked on introduction page

* Rename intro to about

* Move about and delete introduction folder

* Add About to TOC

* Updated changelog

* Trying to fix toc

* changelog header

* Fix link to changelog

* Update Login page content

* Rename login to help-inside

* Updated CSH images

* Updated

* Add shadows and captions to images

* image width percentage

* Update Index.rst

* Image scale

* Image border

* More image borders

* Update last image

* Bulleted the CSH

* Update page types

* Work on renaming Pages and Working with Pages

* Toc tree and some edits

* Renaming and reordering of files

* Reverted yesterday's changes

* Promoted pages above content elements in the toc

* Promoted Creating pages to be above Working with pages in the miniTOC

* Working with pages new images etc

* Fix guilable

* guilabels again

* Fix crossrefs

* Fix images

* Child page image

* Added numbered procedure

* Small tweak.

* typo

* Update setting.cfg

* Get my xref to work

* WIP page properties

* fixed

* fix image

* x-ref indexed_search

* x-ref

* fix xref now

* xref now?

* Further work

* Page properties and other work

* Remove targets from TOC

* Moved l10n from next steps to languages page.

* Working on translation

* Updates to changelog and translation page

* Edits to translation page

* More edits to t10n

* Adding multiple pages

* Adding multiple plus new image

* work tweak

* More changes to add multiple pages

* More changes to add multiple pages

* Updated creating pages page

* Fix creating pages page

* Work on visibility page.

* Work on frontend login

* Updates to login page

* Finish FE login page

* Creating new content page

* Edit content

* Update changelog

* fix xref

* fix xref

* RTE

* Working with images

* Fix build errors

* Really fix errors this time

* fix list format

* Small fixes

* Add media page

* fix xref

* Create form

* Create form from scratch

* Fix probs

* Small fixes

* Removed Changelog file

* Changelog file

* Finish Page properties

* fix xref?

* Fix formatting

* x-ref fixing

* One last xref

* Added link to Targets etc on main page

* Add sitemap

* Add index file

* fix name of index

* fix blank line error

* Updated front page to remove the 'draft' notifications

* Fix target link

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update Index.rst

* Update README.rst

* Update README.rst

Co-authored-by: Martin Bless <martin.bless@mbless.de>
Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com>
  • Loading branch information
@flicstar @marble @linawolf
3 people committed Jan 15, 2021
1 parent 6f6f039 commit c53cd3f
Show file tree
Hide file tree
Showing 97 changed files with 1,175 additions and 938 deletions.
53 changes: 53 additions & 0 deletions CHANGELOG.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
=========
CHANGELOG
=========

* **12/12/20** Worked on Creating a contact form.
* **09/12/20** Worked on embedding video.
* **07/12/20** Worked on RTE and adding images.
* **06/12/20** Worked on Working with content page, create content page.
* **30/11/20** Worked on Creating pages page, access control, visibility and frontend login.
* **23/11/20** Worked on Translation page to edit it and update images. Also
modified Next Steps, and removed x-ref from the TOC
* **17/11/20** More work on Page Properties. Ugh, it's bigger than Ben Hur.
Took a break on that and moved the 'Other features' content into the Working
with Pages content. Removed the other features because it was only one
feature and it was about filtering the page tree. Added new folder
'PagePropertiesNonStandard' to house the info for properties for other page
types.
* **16/11/20** Page Properties. Updated the information for v10. Edited. New
screenshots. Still in draft - asked question on Slack.
* **10/11/20** Pages and Working with Pages - Reverted my changes. Decided
against such a drastic structual change. And I want to keep it simple
so that I can backport the work on pages in the page tree. Swapped pages and
content elements in the toc. Edited the Working with Pages page. Created new
images.
* **09/11/20** Pages and Working with Pages - Renamed. I wanted the Pages file
(that houses the TOC) to be called Working with Pages. The Working with
Pages file contained information about the page tree, so I named it Pages
in the Page Tree. Edited these pages. There is cross-over with the Getting
Started and it's hard to know where to draw the line on my work. I think I
will stop here and work on the Getting Started in a subsequent piece of
work.
* **08/11/20** Page Types - edited.
* **04/11/20** Login - edited. Renamed to Help inside TYPO3. Updated in TOC.
Updated the images. Removed the login information since it's already in the
Getting Started tutorial.
* **01/11/20** Introduction - edited. Renamed to 'About'. Moved to root folder
and deleted Introduction folder. Added to TOC.
* **30/10/20** Index.rst - changed from Tutorial to Guide. Updated the
Mainzific URL. Renamed. Added Draft message to top of page.


## Plan
The plan for overhauling this doc is in a Google Sheet:
https://docs.google.com/spreadsheets/d/
1FQjzWSSqP6BL4BsSa3_TpjBQUzB0ZxRbvjnuUZ9CfKk/edit#gid=485539181


## Initial workflow
I'm starting at page 1 and working consecutively.


## Open questions
* Index.rst - what to do about `Previous Key: doc_tut_editors`?
65 changes: 65 additions & 0 deletions Documentation/About.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.. include:: /Includes.rst.txt


.. _introduction:

.. _about:

================
About this guide
================

This guide covers working with content in TYPO3. It includes common tasks an editor might perform, such as working with content elements, editing existing text and images, working with forms, and working with pages.

This guide touches briefly on access restriction concepts, as well as content translation.

.. _prerequisite:

Prerequisite
============

This guides assumes you have read the :ref:`Getting Started Tutorial <t3start:start>` and are familiar with the following general concepts of TYPO3 CMS:

* :ref:`t3start:backend-and-frontend`
* :ref:`t3start:general-backend-structure`
* :ref:`t3start:page-tree`
* :ref:`t3start:page-content`

.. _examples:

Examples
========

The examples in this guide are from a TYPO3 installation based on the `Official Introduction Package
<https://extensions.typo3.org/extension/introduction/>`__.

.. _credits:

Credits
=======

This guide is based on material originally written by Marlies Cohen and Eikaa.

It has since been updated by Susanne Moog, François Suter and Felicity Brand.

Thanks to them all!

.. _feedback:

Feedback
========

If you find a bug in this guide, please use the "Edit on GitHub" button in the top right corner and submit a pull request via GitHub. Alternatively you can file an issue using the bug tracker: https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Editors/issues.

To support the translation to other languages see
`http://wiki.typo3.org/TYPO3_Tutorial_for_Editors
<http://wiki.typo3.org/TYPO3_Tutorial_for_Editors>`_

Maintaining high quality documentation requires time and effort and the TYPO3 Documentation Team always appreciates support. If you want to support us, please contact us as described in the next section.

.. _contact-doc-team:

Contact the Documentation Team
==============================

For general questions about the documentation get in touch with the `Documentation Team <https://typo3.org/community/teams/documentation>`__.
12 changes: 8 additions & 4 deletions Documentation/AccessControl/Index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt


.. _access-control:
Expand All @@ -7,10 +7,14 @@
Access Control
==============

Access control is about visibility of content on your website.

There are many ways to restrict access to pages, content elements
and other information from your TYPO3 CMS installation. This can
be simple time ranges all the way to requesting a formal
authentication. These various options are presented in this chapter.
and other information in your TYPO3 CMS installation. Options can range from
hiding pages in menus, to limiting visibility of content for a set time
period, all the way through to requiring visitors to log in to view content.

These various options are presented in this chapter.


.. toctree::
Expand Down
203 changes: 94 additions & 109 deletions Documentation/AccessControl/Login/Index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt


.. _frontend-login:
Expand All @@ -7,156 +7,141 @@
Frontend login
==============

Going further it is actually possible to require proper
authentication to access parts of the information contained
in your web site.
You can configure content or pages to only be visible to frontend users who
have logged in.


.. _frontend-login-users:

Frontend users
==============

As with the rest of TYPO3 CMS, users are also separated
into frontend and backend users. Backend users are used to
authenticate into the backend and are used to manage your
TYPO3 CMS installation, create pages, input content, etc.
The concept of the TYPO3 :ref:`backend and frontend <t3start:backend-and-frontend>` is explained in the Getting Started Tutorial.

Frontend users live strictly in the frontend and are
used to restrict access to pages, content elements and any
other type of information which relies on the same
mechanism.
You can use the concept of frontend users (website visitors) to create member-only content and restrict access to pages and content elements by requiring a
log in.

Frontend users are always part of frontend groups. Access is
granted to groups, never directly to users. Users and groups
are defined as any other record and stored in any suitable
page in the backend.
Frontend users are always part of frontend groups. Access is granted to
groups, never directly to users. Users and groups are defined like any other
record, and stored in a suitable page in the backend.

Use your new skills to create a new page of type "Folder"
and name it "Web site users".
.. _Create-a-Usergroup:

.. figure:: ../../Images/AccessUserFolder.png
:alt: Creating a folder for storing the users and groups
Create a user group and user
============================

#. Create a new folder in the page tree, and name it "Web site users".

Switch to **WEB > List** view and select your new folder.
Click on the "Create new record" icon at the left of the
docheader. The new record wizard appears.
.. figure:: ../../Images/AccessUserFolder.png
:alt: Creating a folder for storing the users and groups
:class: with-border

.. figure:: ../../Images/AccessNewRecordWizard.png
:alt: Selecting what type of record to create with the new record wizard
#. Navigate to the :guilabel:`Web > List` module, and select your new folder.
#. Click the **+** :guilabel:`Create new record` icon at the top left of the
Docheader. The "New record" wizard displays.

.. figure:: ../../Images/AccessNewRecordWizard.png
:alt: Selecting what type of record to create with the new record wizard
:class: with-border

Click on "Website Usergroup" to create a new frontend group.
#. Click **Website Usergroup** to create a new frontend group.
#. Name it *Private Area*.

.. figure:: ../../Images/AccessNewGroup.png
:alt: Creating a new frontend group
.. figure:: ../../Images/AccessNewGroup.png
:alt: Creating a new frontend group
:class: with-border

#. Save and close the record.
#. Use the "New record" wizard again, but this time create a **Website User**.
#. Type a username, a password and click the "Private Area" group to select it.

Just give it a name, that's enough to get started. Save the record
and close it. Now use the new record wizard again, but click on
"Website User".
.. figure:: ../../Images/AccessNewUser.png
:alt: Creating a new frontend user
:class: with-border

.. figure:: ../../Images/AccessNewUser.png
:alt: Creating a new frontend user


The minimum input required here is a user name, a password and
a selection of at least one group. You can see how our newly
created "Private area" group is available for selection.

You can add personal data to your user if you wish, but it is not
needed. You can save the record and close it.
You can add further information on the **Personal Data** tab if required.

#. Save and close the record.

.. _frontend-login-rights:

Access rights
=============
Assign access rights
====================

Now that we have at least one group, we can start assigning
access restrictions. Let's create a new page called "Members only"
and restrict it to the "Private area" group.

.. figure:: ../../Images/AccessRestrictPage.png
:alt: Restricting access to the page to a given group
Now that we have at least one group, and a user assigned to that group, we can
assign access restrictions. This is done on the **Access** tab of the page properties or content element properties.

.. figure:: ../../Images/AccessRightsItems.png
:alt: Usergroup access rights
:class: with-border

.. note::

Two default groups appear in the list of groups. They are not
strictly groups, in the sense that they are always available
and cannot be edited nor removed.

The "Hide at login" group means that the element is only visible
when the user is not authenticated. The "Show at any login" group
is used for elements which require authentication to access, but
are okay for all groups to see.

Notice how the page icon changes as soon as you save the new
user rights. It's a visual reminder that this page is not
public. If you try to access this page in the frontend,
the TYPO3 error message "Page Not Found" will be shown.


.. _frontend-login-form:

Login box
=========

The next step is to place a login box somewhere so that
visitors can authenticate and view the restricted information.

Let's change our setup with the following step:

#. Remove the access restriction you just placed on the
"Members only" page.

#. Create a "Text" content element, which says something like
"You need to authenticate to access the members area" and choose
the "Hide at login" group for it.

#. Create another "Text" content element with a text saying
"Welcome to the members area" and choose the "Private area"
group as access right.
Two default groups appear in the list of groups. They are always available
and cannot be edited or removed.

* The "Hide at login" group means that the element is only visible
when the user is not authenticated.
* The "Show at any login" group is used for elements that require
authentication to access, but are okay for all groups to see.

#. Navigate to the :guilabel:`Web > Page` module, and create a new page called
"Members only".
#. Add a text content element to the Members Only page, with text similar to
"You need to authenticate to access the members area".
#. On the **Access** tab, select the "Hide at login" group for it.
#. Save and close the record.
#. Add another text content element to the page, with text similar to
"Welcome to the members area".
#. On the **Access** tab, select the "Private area" group for it.
#. Save and close the record.

You should have something like this:

.. figure:: ../../Images/AccessRestrictContent.png
:alt: Placing access restriction on individual content elements
:class: with-border

Try setting the access for an entire page to "Private area". When you save the
page, notice how the icon in the page tree changes. This is a visual reminder
that the page is not public. If you try to access a restricted page in the
frontend, the TYPO3 error message "Page Not Found" will display.

Now let's add a login box to the party. Click on the "Create new content element"
button located between the two existing content elements. In the
new content element wizard, move to the "Form elements" tab
and click on "Login Form".

Give it a header and move to the "Plugin" tab.

.. figure:: ../../Images/AccessLoginForm.png
:alt: Defining a new login form

.. _frontend-login-form:

The Login Form has many options, but the only one which is absolutely
necessary is the "User Storage Page". Use the record browser icon to
call up the page tree and choose the "Web site users" folder.
Add a login form
================

Save and view the page. You should have something like this:
The next step is to place a login box somewhere on the site so that visitors
can log in to view the restricted content.

.. figure:: ../../Images/AccessPageWithLoginBox.png
:alt: The page with the login box
#. On the "Members only" page, click the :guilabel:`+ Content` button between
the two existing content elements.
#. In the new content element wizard, go to the **Form elements** tab and
select "Login Form".
#. Give it a header (for example, *Log in*).
#. Go to the **Plugin** tab. There are several options for the Login Form, but
the only one which is absolutely necessary is the "User Storage Page".
#. Use the :guilabel:`Browse for records` icon to browse the page tree and
select the "Web site users" folder.

.. figure:: ../../Images/AccessLoginForm.png
:alt: Defining a new login form
:class: with-border

Enter the user name and the password you defined earlier for the
new frontend user and you should see the following:
#. Save and close the record.
#. View the page. You should have something like this:

.. figure:: ../../Images/AccessPageWithAuthenticatedUser.png
:alt: The page with the authenticated user
.. figure:: ../../Images/AccessPageWithLoginBox.png
:alt: The page with the login box
:class: with-border

#. Enter the user name and the password you defined earlier for the
frontend user, and you should see the following:

Note how the content element requesting authentication has disappeared,
replaced by the one welcoming the user.
.. figure:: ../../Images/AccessPageWithAuthenticatedUser.png
:alt: The page with the authenticated user
:class: with-border

This is just a quick overview of the login box provided by
TYPO3 CMS. It has a rich feature set described in
:ref:`its own manual <felogin:start>`.
This is just a quick overview of the login form provided by TYPO3 CMS. It has a
rich set of features that are described in the :ref:`Frontend Login <felogin:start>` manual.
Loading

0 comments on commit c53cd3f

Please sign in to comment.