Skip to content

Commit

Permalink
[TASK] Adjust and improve documentation
Browse files Browse the repository at this point in the history
Resolves: EXTBLOG-151
Releases: master, 9.1, 9.0

Squashed commit of the following:

commit ecececf9c49cdb555ac200447f24041dbebc82af
Author: Frank Naegler <frank.naegler@typo3.org>
Date:   Wed Feb 6 11:29:52 2019 +0100

    [TASK] Adjust and improve documentation
  • Loading branch information
NeoBlack committed Feb 6, 2019
1 parent 2968a7f commit 2348246
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions Documentation/Administrators/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The extension needs to be installed as any other extension of TYPO3 CMS:

#. **Use composer**: Use `composer require T3G/blog`.


Latest version from git
-----------------------
You can get the latest version from git by using the git command:
Expand Down Expand Up @@ -68,12 +69,13 @@ To create a new blog setup, follow these steps:
The Setup Wizard creates the following pages for you:

- Rootpage (hidden by default, contains the TypoScript and PageTS-Config)
- > Data (a folder to hold categories and tags)
- > Data (a folder to hold categories, authors and tags, but also blog posts are possible)
- > Category (this page is used to show blog posts, related to single category, or a category overview)
- > Tag (this page is used to show blog posts, related to single tag, or a tag overview)
- > Archive (this page is the archive, it lists all blog posts by given date (month and year, or year only)
- > First blog post (yes, a first blog post, as an example)


Setup without Wizard
^^^^^^^^^^^^^^^^^^^^

Expand All @@ -82,7 +84,7 @@ To create a new blog setup, follow these steps:
1) Create the following page structure:

- Rootpage (contains the TypoScript and PageTS-Config)
- > Data (a folder to hold categories and tags)
- > Data (a folder to hold categories, authors and tags, but also blog posts are possible)
- > Category (this page is used to show blog posts, related to single category, or a category overview)
- > Tag (this page is used to show blog posts, related to single tag, or a tag overview)
- > Archive (this page is the archive, it lists all blog posts by given date (month and year, or year only)
Expand All @@ -100,7 +102,11 @@ To create a new blog setup, follow these steps:
plugin.tx_blog.settings.archiveUid = NEW_blogArchivePage
plugin.tx_blog.settings.storagePid = NEW_blogFolder
4) Optional: Install and use the extension blog_template for a default template set
.. note::

If you have multiple folder or root pages for your blog posts your have
to add all root pages to :typoscript:`plugin.tx_blog.settings.storagePid`
as a comma separated list. The first value must be the value of NEW_blogFolder


RealURL Setup
Expand All @@ -120,11 +126,27 @@ To get nice looking URLs add the following realurl configuration to your project
'<UID_ARCHIVE_PAGE>' => 'tx_blog_archive'
]
Frontend Routing Setup
^^^^^^^^^^^^^^^^^^^^^^

The extension provides a frontend route enhancer config.
This route enhancer config is not final yet, but you can simply include it in your site configuration:

.. code-block:: yaml
imports:
- { resource: "EXT:blog/Configuration/Routes/Default.yaml" }
Feel free to modify or enhance this configuration, feedback is welcome.


Plugin types
------------

The following plugins are available after installing the extension.


List of Posts by Date
^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -139,6 +161,7 @@ Displays a list of blog posts ordered by date. All non-hidden, non-deleted and n

Backend view of blog post list.


List by Tag
^^^^^^^^^^^^

Expand Down Expand Up @@ -189,6 +212,7 @@ templates included in the extension you won't need them as they represent parts
in your templates. For special circumstances we provide these plugins as standalone versions so you can use them in every
way you want:


Sidebar
"""""""

Expand Down Expand Up @@ -238,11 +262,13 @@ Tags are blog specific records. Creating a new tag works in the same way as crea
* Enter a title for the tag
* Click "Save"


Enable sharing
--------------

To enable sharing go to the page properties of your blog entry and set the check box "Sharing enabled"


AvatarProvider
--------------

Expand Down

0 comments on commit 2348246

Please sign in to comment.