From 839a9a954a1dcd0a060bef7d0a4319b2a0bf1a62 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 6 Jun 2019 17:17:45 +0200 Subject: [PATCH] Improve documentation * Update some parts regarding current state. Relates: #176 --- Documentation/Settings.cfg | 5 ++-- .../1.0.0/20190517-typo3-v9-update.rst | 4 +-- .../20180309-25-provide-sys-language-uid.rst | 2 ++ Documentation/configuration.rst | 4 +++ Documentation/configuration/searching.rst | 28 ++++++++----------- Documentation/development/contribution.rst | 19 ++++--------- Documentation/features.rst | 6 ++-- Documentation/index.rst | 2 +- Documentation/indexer.rst | 8 ------ Documentation/installation.rst | 22 ++++++--------- Documentation/readme.rst | 2 +- Documentation/usage.rst | 8 +++--- 12 files changed, 46 insertions(+), 64 deletions(-) diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg index 4cc7893..475d1a9 100644 --- a/Documentation/Settings.cfg +++ b/Documentation/Settings.cfg @@ -59,5 +59,6 @@ t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/ [extlinks] issue = https://github.com/Codappix/search_core/issues/%s | GitHub issue: -project = https://github.com/Codappix/search_core/projects/%s | Github project: -pr = https://github.com/Codappix/search_core/pull/%s | Github pull request: +project = https://github.com/Codappix/search_core/projects/%s | GitHub project: +pr = https://github.com/Codappix/search_core/pull/%s | GitHub pull request: +package = https://packagist.org/packages/%s | Composer package: diff --git a/Documentation/changelog/1.0.0/20190517-typo3-v9-update.rst b/Documentation/changelog/1.0.0/20190517-typo3-v9-update.rst index b434a13..398fb6f 100644 --- a/Documentation/changelog/1.0.0/20190517-typo3-v9-update.rst +++ b/Documentation/changelog/1.0.0/20190517-typo3-v9-update.rst @@ -10,8 +10,8 @@ This change contains some breaking changes: namespace was removed. * ``\Codappix\SearchCore\DataProcessing\ContentObjectDataProcessorAdapterProcessor`` - has changed signature for ``__construct`` due to removed ``Compatibility`` - namespace. + has changed signature for ``__construct`` due to removed ``Compatibility`` + namespace. * PHP Interface ``\Codappix\SearchCore\Connection\SearchRequestInterface`` has changed, due to extending TYPO3 Interface diff --git a/Documentation/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst b/Documentation/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst index 5230b75..3bee848 100644 --- a/Documentation/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst +++ b/Documentation/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst @@ -1,3 +1,5 @@ +.. _change-feature-25: + Feature 25 "Respect multiple languages" - Provide sys_language_uid ================================================================== diff --git a/Documentation/configuration.rst b/Documentation/configuration.rst index 7cb6fa8..f2c608a 100644 --- a/Documentation/configuration.rst +++ b/Documentation/configuration.rst @@ -25,6 +25,8 @@ The structure is following TYPO3 Extbase conventions. All settings are placed in Here is the example default configuration that's provided through static include: .. code-block:: typoscript + :caption: Constants + :name: static-typoscript-constants plugin { tx_searchcore { @@ -53,6 +55,8 @@ Here is the example default configuration that's provided through static include } .. code-block:: typoscript + :caption: Setup + :name: static-typoscript-setup plugin { tx_searchcore { diff --git a/Documentation/configuration/searching.rst b/Documentation/configuration/searching.rst index 52abc07..8deae2a 100644 --- a/Documentation/configuration/searching.rst +++ b/Documentation/configuration/searching.rst @@ -123,32 +123,28 @@ E.g. you submit a filter in form of: .. code-block:: html - - Due to TYPO3 7.x fluid limitations, we build this input ourself. - No longer necessary in 8 and above - - - + This will create a ``month`` filter with sub properties. To make this filter actually work, you can add the following TypoScript, which will be added to the filter:: diff --git a/Documentation/development/contribution.rst b/Documentation/development/contribution.rst index f65bb21..2c0cfa5 100644 --- a/Documentation/development/contribution.rst +++ b/Documentation/development/contribution.rst @@ -30,29 +30,20 @@ Then setup your system:: git clone git@github.com:codappix/search_core.git \ && cd search_core \ - && export typo3DatabaseName="searchcoretest87" \ - && export TYPO3_VERSION="~8.7" \ + && export typo3DatabaseName="searchcoretest" \ && make install \ && make unitTests \ - && make functionalTests + && make functionalTests \ + && make cgl If all tests are okay, start your work. -If you are working with multiple TYPO3 versions make sure to export `typo3DatabaseName` and -`TYPO3_VERSION` in your environment like:: - - export typo3DatabaseName="searchcoretest76" - export TYPO3_VERSION="~7.6" - -Also run the install command for each version before running any tests. Only this will make sure you -are testing against the actual TYPO3 Version and database scheme. - .. _contribution_development: Development ----------- -All changes are introduced through pull requests at `Github`_ and should contain the following: +All changes are introduced through pull requests at `GitHub`_ and should contain the following: * Adjusted tests if tests existed before. Otherwise they will break on `travis-ci`_. @@ -64,6 +55,6 @@ All changes are introduced through pull requests at `Github`_ and should contain * Make sure to follow the documented :ref:`concepts`. -.. _Github: https://github.com/codappix/search_core +.. _GitHub: https://github.com/codappix/search_core .. _travis-ci: https://travis-ci.org/ .. _PSR-2: http://www.php-fig.org/psr/psr-2/ diff --git a/Documentation/features.rst b/Documentation/features.rst index 57014bd..4c2cba5 100644 --- a/Documentation/features.rst +++ b/Documentation/features.rst @@ -26,7 +26,7 @@ Searching .. note:: Currently only integrated for Elasticsearch with no abstraction. - If you need to implement your own search, please open an issue on Github and we will change the code + If you need to implement your own search, please open an issue on GitHub and we will change the code base. Via TypoScript it's possible to configure the fields to query, minimum match and script fields. @@ -54,8 +54,10 @@ Planned The following features are currently planned and will be integrated: #. :issue:`25` Multi language. + + Partially supported, see :ref:`change-feature-25`. + #. :issue:`94` Respect access rights while indexing relations. -#. :issue:`75` Configuration of index name (for Elasticsearch). For a full list, check out our `open issues`_. diff --git a/Documentation/index.rst b/Documentation/index.rst index 1cc9eb6..fd91a08 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -8,10 +8,10 @@ Table of Contents :glob: features + concepts installation configuration usage - concepts connections indexer dataprocessors diff --git a/Documentation/indexer.rst b/Documentation/indexer.rst index 733f5b9..8b6c15e 100644 --- a/Documentation/indexer.rst +++ b/Documentation/indexer.rst @@ -20,10 +20,6 @@ start indexing TYPO3. Just add the indexer for a TYPO3 table. The indexer will use the TCA to fetch all necessary information like relations. -.. note:: - - Not all relations are resolved yet, see :issue:`17`. - .. _PagesIndexer: PagesIndexer @@ -34,7 +30,3 @@ start indexing TYPO3. The indexer will use the TCA to fetch all necessary information like relations. Currently the implementation is very basic. - -.. note:: - - Not all relations are resolved yet, see :issue:`17` and :pr:`20`. diff --git a/Documentation/installation.rst b/Documentation/installation.rst index a72741f..a8498a3 100644 --- a/Documentation/installation.rst +++ b/Documentation/installation.rst @@ -9,16 +9,7 @@ Composer The extension can be installed through composer:: - composer require "codappix/search_core" "~0.0.7" - -Note that you have to allow unstable packages: - -.. code-block:: json - - { - "minimum-stability": "dev", - "prefer-stable": true - } + composer require "codappix/search_core" "^1.0" Download -------- @@ -26,11 +17,14 @@ Download You can also `download`_ the extension and placing it inside the :file:`typo3conf/ext`-Folder of your installation. In that case you need to install all dependencies yourself. Dependencies are: -.. code:: +PHP + Higher or equal then 7.2.0 and lower then 8 - "php": ">=7.2.0 <8", - "typo3/cms-core": "^9.5", - "ruflin/elastica": "^3.2" +TYPO3 CMS + Higher or equal then 9.5.0 and lower then 10.0.0 + +Library https://elastica.io/ + In version 3.2.x Setup ----- diff --git a/Documentation/readme.rst b/Documentation/readme.rst index f4ad917..b658ac7 100644 --- a/Documentation/readme.rst +++ b/Documentation/readme.rst @@ -18,7 +18,7 @@ re-indexing. Current state ------------- -This is still a very early beta version. More information can be taken from Github at +This is still a very early beta version. More information can be taken from GitHub at `current issues`_. We are also focusing on Code Quality and Testing through `travis ci`_, ``phpcs``, ``phpunit`` and diff --git a/Documentation/usage.rst b/Documentation/usage.rst index fc6d08a..441e9cf 100644 --- a/Documentation/usage.rst +++ b/Documentation/usage.rst @@ -11,8 +11,8 @@ Manual indexing You can trigger indexing from CLI:: - ./typo3/cli_dispatch.phpsh extbase index:index --identifier 'pages' - ./bin/typo3cms index:index --identifier 'pages' + ./typo3/cli_dispatch.phpsh extbase index:index 'pages' + ./bin/typo3cms index:index 'pages' This will index the table ``pages`` using the :ref:`TcaIndexer`. @@ -26,8 +26,8 @@ Manual deletion You can trigger deletion for a single index from CLI:: - ./typo3/cli_dispatch.phpsh extbase index:delete --identifier 'pages' - ./bin/typo3cms index:delete --identifier 'pages' + ./typo3/cli_dispatch.phpsh extbase index:delete 'pages' + ./bin/typo3cms index:delete 'pages' This will delete the index for the table ``pages``.