From 9b1814b44c5bf1dc4b8ec38f267798dcd9eab82f Mon Sep 17 00:00:00 2001 From: Alexander Nitsche Date: Mon, 23 May 2022 13:06:00 +0200 Subject: [PATCH] [DOCS] Align with new TYPO3 documentation standards (#1158) * [DOCS] Align with new TYPO3 documentation standards - align README.rst, Index.rst, Includes.txt, Settings.cfg - add genindex.rst, Sitemap.rst - pose with total and monthly download rate Each TYPO3 package should show - current release version - total download rate - monthly download rate in badges. - remove outdated encoding note - insert TOCs for large pages - insert label for every page title - link terms to official TYPO3 documentation - link extensions to TER * [DOCS] Add TS constants to documentation index * [DOCS] Rename Includes.txt to Includes.rst.txt --- .editorconfig | 4 +- .gitignore | 1 + Documentation/AdministratorManual/Index.rst | 19 +- .../AdministratorManual/Migration/6-2-11.rst | 15 +- .../AdministratorManual/Migration/6-2-14.rst | 15 +- .../Configuration/Extension/Index.rst | 19 +- .../Configuration/ImageRendering/Index.rst | 26 ++- Documentation/Configuration/Index.rst | 19 +- .../Configuration/TypoScript/Index.rst | 52 ++++- Documentation/Contribution/Index.rst | 74 +++++++ Documentation/Includes.rst.txt | 34 +++ Documentation/Includes.txt | 21 -- Documentation/Index.rst | 83 ++++---- Documentation/Installation/Index.rst | 31 +++ Documentation/Introduction/Index.rst | 38 ++-- Documentation/QuickStart/Index.rst | 66 ++++++ Documentation/Settings.cfg | 72 +++++-- Documentation/Sitemap.rst | 9 + Documentation/genindex.rst | 7 + README.rst | 195 +++++------------- composer.json | 2 +- 21 files changed, 494 insertions(+), 308 deletions(-) create mode 100644 Documentation/Contribution/Index.rst create mode 100644 Documentation/Includes.rst.txt delete mode 100644 Documentation/Includes.txt create mode 100644 Documentation/Installation/Index.rst create mode 100644 Documentation/QuickStart/Index.rst create mode 100644 Documentation/Sitemap.rst create mode 100644 Documentation/genindex.rst diff --git a/.editorconfig b/.editorconfig index 3b20f4b71..5193999e9 100644 --- a/.editorconfig +++ b/.editorconfig @@ -39,11 +39,13 @@ indent_size = 4 [*.md] indent_style = space indent_size = 4 +max_line_length = 80 # ReST-Files -[*.rst] +[*.{rst,rst.txt}] indent_style = space indent_size = 3 +max_line_length = 80 # TypoScript [*.typoscript] diff --git a/.gitignore b/.gitignore index 6e41f4a47..5b2cc518d 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ Build/node_modules/* composer.lock *.cache nbproject +/Documentation-GENERATED-temp/ diff --git a/Documentation/AdministratorManual/Index.rst b/Documentation/AdministratorManual/Index.rst index 282b92b06..21349559a 100644 --- a/Documentation/AdministratorManual/Index.rst +++ b/Documentation/AdministratorManual/Index.rst @@ -1,25 +1,20 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - +.. include:: /Includes.rst.txt .. _admin-manual: Administrator manual ==================== -.. only:: html - - This chapter describes how to manage the extension from a superuser point of view. +This chapter describes how to manage the extension from a superuser point of +view. - For a complete changelog please see the release notes on `GitHub `_. +For a complete changelog please see the release notes on +`GitHub `_. +**Table of Contents:** .. toctree:: - :maxdepth: 5 + :maxdepth: 1 :titlesonly: Migration/6-2-14 diff --git a/Documentation/AdministratorManual/Migration/6-2-11.rst b/Documentation/AdministratorManual/Migration/6-2-11.rst index 411f5db99..23f1605d7 100644 --- a/Documentation/AdministratorManual/Migration/6-2-11.rst +++ b/Documentation/AdministratorManual/Migration/6-2-11.rst @@ -1,10 +1,4 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../../Includes.txt - +.. include:: /Includes.rst.txt .. _migration_6.2.11: @@ -15,6 +9,13 @@ Upgrade from 6.2.10 to 6.2.11 This document will only cover **breaking changes**, that could happen while overriding the Bootstrap Package. +**Table of Contents:** + +.. contents:: + :backlinks: top + :class: compact-list + :depth: 1 + :local: diff --git a/Documentation/AdministratorManual/Migration/6-2-14.rst b/Documentation/AdministratorManual/Migration/6-2-14.rst index 8f4e69338..60077dab2 100644 --- a/Documentation/AdministratorManual/Migration/6-2-14.rst +++ b/Documentation/AdministratorManual/Migration/6-2-14.rst @@ -1,10 +1,4 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../../Includes.txt - +.. include:: /Includes.rst.txt .. _migration_6.2.14: @@ -15,6 +9,13 @@ Upgrade from 6.2.13 to 6.2.14 This document will only cover **breaking changes**, that could happen while overriding the Bootstrap Package. +**Table of Contents:** + +.. contents:: + :backlinks: top + :class: compact-list + :depth: 1 + :local: diff --git a/Documentation/Configuration/Extension/Index.rst b/Documentation/Configuration/Extension/Index.rst index 179dc8469..6bfc6fed8 100644 --- a/Documentation/Configuration/Extension/Index.rst +++ b/Documentation/Configuration/Extension/Index.rst @@ -1,20 +1,21 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../../Includes.txt +.. include:: /Includes.rst.txt +.. _extension-configuration: ======================= Extension Configuration ======================= -Use the extension manager to adjust the Bootstrap Package to your needs. - +Use the :ref:`Extension Manager ` to adjust the +Bootstrap Package to your needs. PageTsConfig ============ The Bootstrap Package has a lot of PageTsConfig defaults. -In some cases it can be useful to deactivate some of them if you do not need them. +In some cases it can be useful to deactivate some of them if you do not need +them. + +.. TODO: + All PageTsConfig properties should be listed here - as already done + with the sibling chapters "Image Rendering" and "TypoScript". diff --git a/Documentation/Configuration/ImageRendering/Index.rst b/Documentation/Configuration/ImageRendering/Index.rst index a0031ef5a..0379c9ec8 100644 --- a/Documentation/Configuration/ImageRendering/Index.rst +++ b/Documentation/Configuration/ImageRendering/Index.rst @@ -1,10 +1,6 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../../Includes.txt +.. include:: /Includes.rst.txt +.. _image-rendering: =============== Image Rendering @@ -15,6 +11,14 @@ supports multiple variants for various device sizes. Each variant defines the **break point**, **width** and the optional **sizes** for high resolution image support. +**Table of Contents:** + +.. contents:: + :backlinks: top + :class: compact-list + :depth: 2 + :local: + Image Variants @@ -129,10 +133,10 @@ for devices with a minimum device pixel ratio from 1.5 and 2. } The data for image rendering is now extended with a sub-set for high-resolution -variants. If you did not overwrite the default templates, it will just work as +variants. If you did not overwrite the default templates, it will just work as soon as you add the configuration. If you have overwritten the default -templates, it will still work as before, but you need to add the new support for -high-resolution images yourself. +templates, it will still work as before, but you need to add the new support for +high-resolution images yourself. Please check the new updated templates and adjust your code if you want this support. @@ -240,11 +244,11 @@ Options for variants: +---------------+-----------+-------------------------------------------------+ | aspectRatio | float | Optional, defines the default aspect ratio | | | | which will override all previously defined | -| | | ratios on image level | +| | | ratios on image level | +---------------+-----------+-------------------------------------------------+ | sizes | array | Optional, defines the available high resolution | | | | image multiplier for a minimal device pixel | -| | | ratio per variant | +| | | ratio per variant | +---------------+-----------+-------------------------------------------------+ diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst index 4bb1c584e..f4e526cf2 100644 --- a/Documentation/Configuration/Index.rst +++ b/Documentation/Configuration/Index.rst @@ -1,20 +1,17 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. +.. include:: /Includes.rst.txt -.. include:: ../Includes.txt +.. _configuration: - -============================== +============= Configuration -============================== +============= + +**Table of Contents:** .. toctree:: - :maxdepth: 5 + :maxdepth: 2 :titlesonly: - :glob: Extension/Index ImageRendering/Index - TypoScript/Index \ No newline at end of file + TypoScript/Index diff --git a/Documentation/Configuration/TypoScript/Index.rst b/Documentation/Configuration/TypoScript/Index.rst index 586cc25a0..903408a33 100644 --- a/Documentation/Configuration/TypoScript/Index.rst +++ b/Documentation/Configuration/TypoScript/Index.rst @@ -1,23 +1,34 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../../Includes.txt +.. include:: /Includes.rst.txt +.. index:: ! TypoScript +.. _typoscript: ========== TypoScript ========== -Bootstrap Package was built to be as adjustable as possible, so nothing is fixed and everything can be overridden with TypoScript constants. -The constants are grouped in basic and advanced settings. Use the **TYPO3 Constant Editor** in the backend to modify the values. + +Bootstrap Package was built to be as adjustable as possible, so nothing is fixed +and everything can be overridden with TypoScript constants. The constants are +grouped in basic and advanced settings. Use the :ref:`Constant Editor ` +in the backend to modify the values. + +**Table of Contents:** + +.. contents:: + :backlinks: top + :class: compact-list + :depth: 2 + :local: Bootstrap Package: Basic Constants ================================== + The basic settings will provide easy to use and understandable options for that are used mainly for styling and appearance. +.. index:: TypoScript; page.logo + page.logo --------- @@ -47,6 +58,9 @@ page.logo } +.. TODO: This property seems to be outdated. There is a second "page.meta" + further down. + page.meta --------- @@ -61,6 +75,8 @@ page.meta +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.theme + page.theme ---------- @@ -77,6 +93,8 @@ page.theme +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.theme.copyright + page.theme.copyright -------------------- @@ -90,6 +108,8 @@ page.theme.copyright +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.theme.news + page.theme.news --------------- @@ -112,6 +132,8 @@ page.theme.news +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.theme.language + page.theme.language ------------------- @@ -129,6 +151,8 @@ Bootstrap Package: Advanced Constants The advanced settings should be used only if you really know what you are doing. +.. index:: TypoScript; page.fluidtemplate + page.fluidtemplate ------------------ @@ -143,6 +167,8 @@ page.fluidtemplate +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.includePath + page.includePath ---------------- @@ -157,6 +183,8 @@ page.includePath +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.meta + page.meta --------- @@ -175,6 +203,8 @@ page.meta +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; page.tracking.google + page.tracking.google -------------------- @@ -187,6 +217,8 @@ page.tracking.google +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; config + config ------ @@ -214,6 +246,8 @@ config +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; plugin.bootstrap_package.settings + plugin.bootstrap_package.settings --------------------------------- @@ -226,6 +260,8 @@ plugin.bootstrap_package.settings +-----------------------------------+---------------+-----------------------------------------------------------------------+ +.. index:: TypoScript; plugin.bootstrap_package_contentelements.view + plugin.bootstrap_package_contentelements.view --------------------------------------------- diff --git a/Documentation/Contribution/Index.rst b/Documentation/Contribution/Index.rst new file mode 100644 index 000000000..e64160949 --- /dev/null +++ b/Documentation/Contribution/Index.rst @@ -0,0 +1,74 @@ +.. include:: /Includes.rst.txt + +.. _contribution: + +============ +Contribution +============ + +Feel free to create an issue or fork this project and create a pull request +when you're happy with your changes. + +**Table of Contents:** + +.. contents:: + :backlinks: top + :class: compact-list + :depth: 2 + :local: + + +Bug reporting +============= + +Please open an `issue at GitHub`__ and describe your problem. + +__ https://github.com/benjaminkott/bootstrap_package/issues + + +Clean code +========== + +We check the source code according to the our Coding Guidelines. To reformat +the code automatically, you can use *PHP CS Fixer* as follows: + +.. code-block:: bash + + composer cgl + + +Local environment +================= + +The extension comes with a ready to use DDEV Local configuration. Type +``ddev start`` in the extension root folder to start the Docker container. + +``ddev launch`` will open the browser and head to the testing website. You can +use ``ddev launch typo3`` to get directly to the backend. + + +License +======= + +This project is released under the terms of the `MIT license`_. + +.. _MIT license: https://en.wikipedia.org/wiki/MIT_License + + +Slack +===== + +You can connect directly with us on `Slack`_, the preferred instant +communication platform of TYPO3 CMS developers. If you already have access to +the TYPO3 Slack platform join the #bootstrap-package channel. If you don't have +access yet, you can register at `my.typo3.org`_. + +.. _Slack: https://typo3.slack.com/messages/bootstrap-package/ +.. _my.typo3.org: https://my.typo3.org/about-mytypo3org/slack + + +Twitter +======= + +If you have any questions about this project or just want to talk: +Send a tweet `@benjaminkott `_. diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt new file mode 100644 index 000000000..af7f7005e --- /dev/null +++ b/Documentation/Includes.rst.txt @@ -0,0 +1,34 @@ +.. More information about this file: + https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt + +.. ---------- +.. text roles +.. ---------- + +.. role:: aspect(emphasis) +.. role:: bash(code) +.. role:: html(code) +.. role:: js(code) +.. role:: php(code) +.. role:: rst(code) +.. role:: sep(strong) +.. role:: sql(code) + +.. role:: tsconfig(code) + :class: typoscript + +.. role:: typoscript(code) +.. role:: xml(code) + :class: html + +.. role:: yaml(code) + +.. default-role:: code + +.. --------- +.. highlight +.. --------- + +.. By default, code blocks use PHP syntax highlighting + +.. highlight:: php diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt deleted file mode 100644 index 8ef89a78a..000000000 --- a/Documentation/Includes.txt +++ /dev/null @@ -1,21 +0,0 @@ -.. ================================================== -.. 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 diff --git a/Documentation/Index.rst b/Documentation/Index.rst index d4da518de..d47e28fcf 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,61 +1,60 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. +.. include:: /Includes.rst.txt -.. include:: Includes.txt - - -.. _start: - -============================================================= +================= Bootstrap Package -============================================================= +================= -.. only:: html +:Extension key: + bootstrap_package - :Classification: - bootstrap_package +:Package name: + bk2k/bootstrap-package - :Version: - |release| +:Version: + |release| - :Language: - en +:Language: + en - :Description: - Bootstrap Package delivers a full configured frontend theme for TYPO3, based on the Bootstrap CSS Framework. +:Author: + Benjamin Kott & Contributors - :Keywords: - Theme, Bootstrap +:License: + This document is published under the + `Open Publication License `__. - :Copyright: - 2014 +:Rendered: + |today| - :Author: - Benjamin Kott +---- - :Email: - info@bk2k.info +Bootstrap Package delivers a fully configured frontend theme for TYPO3, based on +the Bootstrap CSS Framework. - :License: - This document is published under the Open Content License - available from http://www.opencontent.org/opl.shtml +The goal of this package is also to give an advanced example of how modern +templating in TYPO3 CMS can be handled nicely without depending on third party +extensions. Bootstrap Package comes with a fully configurable Frontend via +TypoScript. This includes the TypoScript Constant Editor. - :Rendered: - |today| +---- - The content of this document is related to TYPO3, - a GNU/GPL CMS/Framework available from `www.typo3.org `_. +**Table of Contents:** + +.. toctree:: + :maxdepth: 2 + :titlesonly: + Introduction/Index + Installation/Index + QuickStart/Index + Configuration/Index + AdministratorManual/Index + Contribution/Index - **Table of Contents** +.. Meta Menu .. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: + :hidden: - Introduction/Index - Configuration/Index - AdministratorManual/Index \ No newline at end of file + Sitemap + genindex diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst new file mode 100644 index 000000000..e49922843 --- /dev/null +++ b/Documentation/Installation/Index.rst @@ -0,0 +1,31 @@ +.. include:: /Includes.rst.txt + +.. _installation: + +============ +Installation +============ + +The latest version can be installed via `TER`_ or via composer by running + +.. code-block:: bash + + composer require bk2k/bootstrap-package + +in a TYPO3 v10.4+ installation. + +.. _TER: https://extensions.typo3.org/extension/bootstrap_package + + +Recommended Apache Modules +========================== + +* mod_autoindex +* mod_alias +* mod_deflate +* mod_expires +* mod_filter +* mod_mime +* mod_headers +* mod_setenvif +* mod_rewrite diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst index c8f0db463..650cf4cc4 100644 --- a/Documentation/Introduction/Index.rst +++ b/Documentation/Introduction/Index.rst @@ -1,23 +1,20 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. +.. include:: /Includes.rst.txt -.. include:: ../Includes.txt +.. _introduction: - -============================== +============ Introduction -============================== +============ -Bootstrap Package is a theme for TYPO3 CMS based on the `Bootstrap CSS Framework `_ Version 5.1 +Bootstrap Package is a theme for TYPO3 CMS based on the +`Bootstrap CSS Framework `_ Version 5.1. Features -============================== +======== * Full configured TypoScript Setup provided as Static Template * Completely adjustable via TypoScript Constants -* TYPO3 CMS rendering is adjusted to the needs of `Bootstrap CSS Framework `_ +* TYPO3 CMS rendering is adjusted to the needs of Bootstrap CSS Framework: * Layouts for all Content Elements * Section Frames @@ -41,18 +38,23 @@ Features Screenshots -============================== +=========== .. figure:: ../Images/Screens/Desktop.jpg - :width: 500px - :alt: Desktop + :width: 820px + :alt: Desktop + + Desktop View .. figure:: ../Images/Screens/Tablet.jpg - :width: 400px - :alt: Tablet + :width: 820px + :alt: Tablet + + Tablet View .. figure:: ../Images/Screens/Mobile.jpg - :width: 180px - :alt: Mobile + :alt: Mobile + + Mobile View diff --git a/Documentation/QuickStart/Index.rst b/Documentation/QuickStart/Index.rst new file mode 100644 index 000000000..02392cdea --- /dev/null +++ b/Documentation/QuickStart/Index.rst @@ -0,0 +1,66 @@ +.. include:: /Includes.rst.txt + +=========== +Quick Start +=========== + +Follow these steps to get your Bootstrap package up and running quickly. + +**Table of Contents:** + +.. contents:: + :backlinks: top + :class: compact-list + :depth: 2 + :local: + + +Disable default content rendering extensions +============================================ + +You do not need to have either `Fluid Styled Content`_ or `CSS Styled Content`_ +installed, we have currently marked both extensions as conflicting to avoid +misconfiguration. + +If you really know what you are doing, it is safe to use Core content rendering +along with Bootstrap Package. But please note that we are adding more content +elements that are not supported by these system extensions. + +.. _Fluid Styled Content: https://extensions.typo3.org/extension/fluid_styled_content/ +.. _CSS Styled Content: https://extensions.typo3.org/extension/css_styled_content/ + + +Make sure you have a root page +============================== + +Create a new page or edit an existing one and set this as *root page*. You can +find this option in the :ref:`Edit Page ` mode filed +under :guilabel:`Behavior > Miscellaneous`. + + +Create a new template on the root page +====================================== + +General +------- + +* Template Title: You can name this as you like, for example "Bootstrap Package". +* Website Title: This will be your website title visible in the frontend. + +Options +------- + +* Clear constants and setup by checking the boxes. +* Clear the predefined TypoScript setup from the text box if any. +* Use this template as root-level template by checking the box. + +Includes +-------- + +Include static (from extensions) + +* Bootstrap Package (required) + +Static Template Files from TYPO3 Extensions + +* Include before all static templates if root flag is set diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg index 53c0e7b5d..82c138198 100644 --- a/Documentation/Settings.cfg +++ b/Documentation/Settings.cfg @@ -1,18 +1,62 @@ -# coding: utf-8 +# More information about this file: +# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg + [general] + project = Bootstrap Package -version = 12.1.0-dev -release = 12.1.0-dev -copyright = since 2014 by Benjamin Kott +version = main (development) +release = main (development) +copyright = since 2014 by Benjamin Kott & Contributors [html_theme_options] -github_branch = master -github_repository = benjaminkott/bootstrap_package -project_contact = info@bk2k.info -project_discussions = https://typo3.slack.com/messages/bootstrap-package -project_home = https://www.bootstrap-package.com -project_issues = https://github.com/benjaminkott/bootstrap_package/issues -project_repository = https://github.com/benjaminkott/bootstrap_package - -[extlinks] -issue = https://github.com/benjaminkott/bootstrap_package/issues/%s | Issue # + +# "Edit on GitHub" button +github_repository = benjaminkott/bootstrap_package +github_branch = master + +# Footer links +project_home = https://www.bootstrap-package.com +project_contact = mailto:info@bk2k.info +project_repository = https://github.com/benjaminkott/bootstrap_package +project_issues = https://github.com/benjaminkott/bootstrap_package/issues +project_discussions = https://typo3.slack.com/messages/bootstrap-package + +use_opensearch = + +[intersphinx_mapping] + +# Official TYPO3 manuals +# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ +# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/ +# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ +t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/11.5/en-us/ +# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ +t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/11.5/en-us/ +# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/ +# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ +# t3home = https://docs.typo3.org/ +# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ +# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ +# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ +# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ +# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ +# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/ +# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ +# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/ +t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/11.5/en-us/ +# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/ +# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ +# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ + +# TYPO3 system extensions +# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ +# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ +# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ +# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/ +# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/ +# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ +# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ +# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ +# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ +# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/ +# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ diff --git a/Documentation/Sitemap.rst b/Documentation/Sitemap.rst new file mode 100644 index 000000000..09d3c6f56 --- /dev/null +++ b/Documentation/Sitemap.rst @@ -0,0 +1,9 @@ +:template: sitemap.html + +.. include:: /Includes.rst.txt + +======= +Sitemap +======= + +.. The sitemap.html template will insert here the page tree automatically. diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst new file mode 100644 index 000000000..806ec56a7 --- /dev/null +++ b/Documentation/genindex.rst @@ -0,0 +1,7 @@ +.. include:: /Includes.rst.txt + +===== +Index +===== + +.. Sphinx will insert here the general index automatically. diff --git a/README.rst b/README.rst index ff7845bf4..7e91594c5 100644 --- a/README.rst +++ b/README.rst @@ -1,157 +1,60 @@ -================================================== -Bootstrap Package -================================================== +.. image:: https://poser.pugx.org/bk2k/bootstrap-package/v/stable + :alt: Latest Stable Version + :target: https://extensions.typo3.org/extension/bootstrap_package/ -.. image:: Documentation/Images/Screens/typo3-frontend.png?raw=true - :alt: Bootstrap Package - -Bootstrap Package delivers a fully configured frontend -theme for TYPO3, based on the Bootstrap CSS Framework. - -The goal of this package is also to give an advanced example of how modern templating -in TYPO3 CMS can be handled nicely without depending on third party extensions. -Bootstrap Package comes with a fully configurable Frontend via TypoScript. This -includes the TypoScript Constant Editor. - -Minimal Dependencies -==================== - -* TYPO3 CMS 10.4 or 11.5 for Bootstrap Package 12.x -* TYPO3 CMS 9.5 or 10.4 for Bootstrap Package 11.x -* TYPO3 CMS 8.7 or 9.5 for Bootstrap Package 10.x, 9.x and 8.x -* TYPO3 CMS 7.6 for Bootstrap Package 7.x - -Quick Install Guide -=================== - -Disable default content rendering extensions --------------------------------------------- - -You do not need to have Fluid Styled Content or CSS Styled Content installed, we -have currently marked both extensions as conflicting to avoid misconfiguration. - -If you really know what you are doing, it is safe to use core content rendering -definitions alongside with the Bootstrap Package. But please be aware that we are -adding more content elements that are not supported from those extensions. - -* css_styled_content -* fluid_styled_content - -Make sure you have a root page ------------------------------- - -Create a new page or edit an existing one and set this as *root page*. -You can find this option in the page-edit-mode filed under behavior/miscellaneous. - -Create a new Template on this Page ----------------------------------- - -General -~~~~~~~ - -* Template Title: You can name this as you like: Example "Bootstrap Package" -* Website Title: This will be your website title visible in the frontend - -Options -~~~~~~~ - -* Clear Constants and Setup by checking the boxes -* Clear the predefined TypoScript setup from the textbox if any -* Use this Template as Root-Level Template by checking the box - -Includes -~~~~~~~~ - -Include static (from extensions) - -* Bootstrap Package (required) - -Static Template Files from TYPO3 Extensions - -* Include before all static templates if root flag is set - - -Recommended Apache Modules -~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. image:: https://img.shields.io/badge/TYPO3-11-orange.svg + :alt: TYPO3 11 + :target: https://get.typo3.org/version/11 -* mod_autoindex -* mod_alias -* mod_deflate -* mod_expires -* mod_filter -* mod_mime -* mod_headers -* mod_setenvif -* mod_rewrite +.. image:: https://img.shields.io/badge/TYPO3-10-orange.svg + :alt: TYPO3 10 + :target: https://get.typo3.org/version/10 +.. image:: https://poser.pugx.org/bk2k/bootstrap-package/d/total + :alt: Total Downloads + :target: https://packagist.org/packages/bk2k/bootstrap-package -Usage -===== +.. image:: https://poser.pugx.org/bk2k/bootstrap-package/d/monthly + :alt: Monthly Downloads + :target: https://packagist.org/packages/bk2k/bootstrap-package -Documentation -------------- - -* `Wiki `_ -* `Documentation `_ - -Contributing ------------- - -Feel free to fork this project and create a pull request when you're happy -with your changes. We check the source code according to the our Coding Guidelines. -To reformat the code automatically, you can use ``php-cs-fixer`` as follows: - -.. code-block:: - - composer cgl - -DDEV Local ----------- - -The extension comes with a ready to use DDEV Local configuration. Type -``ddev start`` in the extension root folder to start the Docker container. - -``ddev launch`` will open the browser and head to the testing website. You can -use ``ddev launch typo3`` to get directly to the backend. - -Bug reporting -------------- - -Please open an `issue here at github`__ and describe your problem. +.. image:: https://github.com/benjaminkott/bootstrap_package/workflows/CI/badge.svg + :alt: Continuous Integration Status + :target: https://github.com/benjaminkott/bootstrap_package/actions?query=workflow%3ACI -__ https://github.com/benjaminkott/bootstrap_package/issues +.. image:: Documentation/Images/Screens/typo3-frontend.png?raw=true + :alt: Bootstrap Package -License -------- +===================================== +TYPO3 extension ``bootstrap_package`` +===================================== -This project is released under the terms of the `MIT license `_. +The *Bootstrap Package* delivers a fully configured frontend theme for TYPO3, +based on the Bootstrap CSS Framework. -Test the Bootstrap Package -========================== +The goal of this package is also to give an advanced example of how modern +templating in TYPO3 CMS can be handled nicely without depending on third party +extensions. Bootstrap Package comes with a fully configurable Frontend via +TypoScript. This includes the TypoScript Constant Editor. If you are interested in the Bootstrap Package you can test it in our -`Introduction `_ Demo Setup. - -Contact & Communication -======================= - -Slack ------ - -You can connect directly with us on `Slack `_, the -preferred instant communication platform of TYPO3 CMS developers. If you already have access to the -TYPO3 Slack platform join the #bootstrap-package channel. If you don't have access yet, you can -register `here `_. - -Twitter -------- - -If you have any questions about this project or just want to talk: -Send a tweet `@benjaminkott `_. - -Code Quality -============ - -.. image:: https://github.com/benjaminkott/bootstrap_package/workflows/CI/badge.svg - :alt: Continuous Integration Status - :target: https://github.com/benjaminkott/bootstrap_package/actions?query=workflow%3ACI +`Introduction `_ +Demo Setup. + +:Repository: https://github.com/benjaminkott/bootstrap_package +:Documentation: https://docs.typo3.org/p/bk2k/bootstrap-package/main/en-us/ +:Wiki: https://github.com/benjaminkott/bootstrap_package/wiki +:TER: https://extensions.typo3.org/extension/bootstrap_package + +Compatibility +============= + +========== ========= ========= =============== ======== + \ BP 12.x BP 11.x BP 10.x - 8.x BP 7.x +========== ========= ========= =============== ======== +TYPO3 11 yes no no no +TYPO3 10 yes yes no no +TYPO3 9 no yes yes no +TYPO3 8 no no yes no +TYPO3 7 no no no yes +========== ========= ========= =============== ======== diff --git a/composer.json b/composer.json index a9682e510..9dcec5cc1 100644 --- a/composer.json +++ b/composer.json @@ -144,6 +144,6 @@ "issues": "https://github.com/benjaminkott/bootstrap_package/issues", "wiki": "https://github.com/benjaminkott/bootstrap_package/wiki", "source": "https://github.com/benjaminkott/bootstrap_package", - "docs": "https://docs.typo3.org/p/bk2k/bootstrap-package/master/en-us/" + "docs": "https://docs.typo3.org/p/bk2k/bootstrap-package/main/en-us/" } }