From a13bb75e343d28394f85cdd3cc9786fa317fd270 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 6 Jun 2019 16:14:14 +0200 Subject: [PATCH] TASK: Migrate documentation to TYPO3 support setup Resolves: #176 --- .gitignore | 1 + Documentation/.gitignore | 1 - Documentation/Makefile | 230 ------------- Documentation/Settings.cfg | 63 ++++ Documentation/{source => }/changelog.rst | 0 .../1.0.0/20190517-typo3-v9-update.rst | 0 .../20180306-120-facet-configuration.rst | 0 .../20180308-131-respect-page-cache-clear.rst | 0 .../20180308-introduce-php70-type-hints.rst | 0 .../20180309-25-provide-sys-language-uid.rst | 0 ...15-134-make-conent-fields-configurable.rst | 0 .../20180410-148-keep-sys_language_uid.rst | 0 ...t-relation-resolver-to-data-processing.rst | 0 ...180518-75-make-index-name-configurable.rst | 0 ...-allow-zero-as-typoscript-filter-value.rst | 0 ...e-pluginname-in-configurationcontainer.rst | 0 Documentation/{source => }/concepts.rst | 0 Documentation/configuration.rst | 109 ++++++ .../configuration/connections.rst | 0 ...entObjectDataProcessorAdapterProcessor.rst | 0 .../dataProcessing/CopyToProcessor.rst | 0 .../dataProcessing/GeoPointProcessor.rst | 0 .../dataProcessing/RemoveProcessor.rst | 0 .../TcaRelationResolvingProcessor.rst | 0 .../{source => }/configuration/indexing.rst | 0 .../{source => }/configuration/searching.rst | 0 Documentation/{source => }/connections.rst | 0 Documentation/{source => }/dataprocessors.rst | 0 Documentation/{source => }/development.rst | 0 .../{source => }/development/connection.rst | 0 .../{source => }/development/contribution.rst | 0 .../development/dataProcessor.rst | 0 .../{source => }/development/indexer.rst | 0 Documentation/{source => }/features.rst | 0 Documentation/{source => }/index.rst | 0 Documentation/{source => }/indexer.rst | 0 Documentation/{source => }/installation.rst | 9 +- Documentation/make.bat | 281 ---------------- Documentation/{source => }/readme.rst | 0 Documentation/source/conf.py | 312 ------------------ Documentation/source/configuration.rst | 50 --- Documentation/{source => }/usage.rst | 0 42 files changed, 178 insertions(+), 878 deletions(-) delete mode 100644 Documentation/.gitignore delete mode 100644 Documentation/Makefile create mode 100644 Documentation/Settings.cfg rename Documentation/{source => }/changelog.rst (100%) rename Documentation/{source => }/changelog/1.0.0/20190517-typo3-v9-update.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180306-120-facet-configuration.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180308-131-respect-page-cache-clear.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180308-introduce-php70-type-hints.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180315-134-make-conent-fields-configurable.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180410-148-keep-sys_language_uid.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180424-149-extract-relation-resolver-to-data-processing.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180518-75-make-index-name-configurable.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20180926-163-allow-zero-as-typoscript-filter-value.rst (100%) rename Documentation/{source => }/changelog/prior-1.0.0/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer.rst (100%) rename Documentation/{source => }/concepts.rst (100%) create mode 100644 Documentation/configuration.rst rename Documentation/{source => }/configuration/connections.rst (100%) rename Documentation/{source => }/configuration/dataProcessing/ContentObjectDataProcessorAdapterProcessor.rst (100%) rename Documentation/{source => }/configuration/dataProcessing/CopyToProcessor.rst (100%) rename Documentation/{source => }/configuration/dataProcessing/GeoPointProcessor.rst (100%) rename Documentation/{source => }/configuration/dataProcessing/RemoveProcessor.rst (100%) rename Documentation/{source => }/configuration/dataProcessing/TcaRelationResolvingProcessor.rst (100%) rename Documentation/{source => }/configuration/indexing.rst (100%) rename Documentation/{source => }/configuration/searching.rst (100%) rename Documentation/{source => }/connections.rst (100%) rename Documentation/{source => }/dataprocessors.rst (100%) rename Documentation/{source => }/development.rst (100%) rename Documentation/{source => }/development/connection.rst (100%) rename Documentation/{source => }/development/contribution.rst (100%) rename Documentation/{source => }/development/dataProcessor.rst (100%) rename Documentation/{source => }/development/indexer.rst (100%) rename Documentation/{source => }/features.rst (100%) rename Documentation/{source => }/index.rst (100%) rename Documentation/{source => }/indexer.rst (100%) rename Documentation/{source => }/installation.rst (89%) delete mode 100644 Documentation/make.bat rename Documentation/{source => }/readme.rst (100%) delete mode 100644 Documentation/source/conf.py delete mode 100644 Documentation/source/configuration.rst rename Documentation/{source => }/usage.rst (100%) diff --git a/.gitignore b/.gitignore index 3403a5d..ac17c98 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /composer.lock /.Build /var/ +/Documentation-GENERATED-temp/ diff --git a/Documentation/.gitignore b/Documentation/.gitignore deleted file mode 100644 index 378eac2..0000000 --- a/Documentation/.gitignore +++ /dev/null @@ -1 +0,0 @@ -build diff --git a/Documentation/Makefile b/Documentation/Makefile deleted file mode 100644 index e54e38d..0000000 --- a/Documentation/Makefile +++ /dev/null @@ -1,230 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -a -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) - $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " epub3 to make an epub3" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - @echo " dummy to check syntax errors of document sources" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/TYPO3Extensionsearch_core.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TYPO3Extensionsearch_core.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/TYPO3Extensionsearch_core" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TYPO3Extensionsearch_core" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: epub3 -epub3: - $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 - @echo - @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -.PHONY: dummy -dummy: - $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy - @echo - @echo "Build finished. Dummy builder generates no files." diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg new file mode 100644 index 0000000..4cc7893 --- /dev/null +++ b/Documentation/Settings.cfg @@ -0,0 +1,63 @@ +# 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] + +project = search_core +version = 1.0.0 +release = 1.0.0 +t3author = Daniel Siepmann +copyright = since 2017 by Daniel Siepmann + +description = Short sample description in one longer sentence or short paragraph. + +[html_theme_options] + +; for theme t3SphinxThemeRtd + +#### NOTE: Fill in YOUR values in the following! + +github_branch = master +github_repository = Codappix/search_core/ + +# usually an email address +project_contact = coding@daniel-siepmann.de + +# URL of online discussions, you can leave this blank +project_discussions = + +# URL of webpage of your extension (if it has one) +project_home = https://github.com/Codappix/search_core + +# URL to Issues +project_issues = https://github.com/Codappix/search_core/issues + +# URL of repository +project_repository = https://github.com/Codappix/search_core + +# just leave this blank +use_opensearch = + + +[intersphinx_mapping] +t3tcaref = https://docs.typo3.org/typo3cms/TCAReference/ +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: diff --git a/Documentation/source/changelog.rst b/Documentation/changelog.rst similarity index 100% rename from Documentation/source/changelog.rst rename to Documentation/changelog.rst diff --git a/Documentation/source/changelog/1.0.0/20190517-typo3-v9-update.rst b/Documentation/changelog/1.0.0/20190517-typo3-v9-update.rst similarity index 100% rename from Documentation/source/changelog/1.0.0/20190517-typo3-v9-update.rst rename to Documentation/changelog/1.0.0/20190517-typo3-v9-update.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180306-120-facet-configuration.rst b/Documentation/changelog/prior-1.0.0/20180306-120-facet-configuration.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180306-120-facet-configuration.rst rename to Documentation/changelog/prior-1.0.0/20180306-120-facet-configuration.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180308-131-respect-page-cache-clear.rst b/Documentation/changelog/prior-1.0.0/20180308-131-respect-page-cache-clear.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180308-131-respect-page-cache-clear.rst rename to Documentation/changelog/prior-1.0.0/20180308-131-respect-page-cache-clear.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180308-introduce-php70-type-hints.rst b/Documentation/changelog/prior-1.0.0/20180308-introduce-php70-type-hints.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180308-introduce-php70-type-hints.rst rename to Documentation/changelog/prior-1.0.0/20180308-introduce-php70-type-hints.rst diff --git a/Documentation/source/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 similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst rename to Documentation/changelog/prior-1.0.0/20180309-25-provide-sys-language-uid.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180315-134-make-conent-fields-configurable.rst b/Documentation/changelog/prior-1.0.0/20180315-134-make-conent-fields-configurable.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180315-134-make-conent-fields-configurable.rst rename to Documentation/changelog/prior-1.0.0/20180315-134-make-conent-fields-configurable.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180410-148-keep-sys_language_uid.rst b/Documentation/changelog/prior-1.0.0/20180410-148-keep-sys_language_uid.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180410-148-keep-sys_language_uid.rst rename to Documentation/changelog/prior-1.0.0/20180410-148-keep-sys_language_uid.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180424-149-extract-relation-resolver-to-data-processing.rst b/Documentation/changelog/prior-1.0.0/20180424-149-extract-relation-resolver-to-data-processing.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180424-149-extract-relation-resolver-to-data-processing.rst rename to Documentation/changelog/prior-1.0.0/20180424-149-extract-relation-resolver-to-data-processing.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180518-75-make-index-name-configurable.rst b/Documentation/changelog/prior-1.0.0/20180518-75-make-index-name-configurable.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180518-75-make-index-name-configurable.rst rename to Documentation/changelog/prior-1.0.0/20180518-75-make-index-name-configurable.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20180926-163-allow-zero-as-typoscript-filter-value.rst b/Documentation/changelog/prior-1.0.0/20180926-163-allow-zero-as-typoscript-filter-value.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20180926-163-allow-zero-as-typoscript-filter-value.rst rename to Documentation/changelog/prior-1.0.0/20180926-163-allow-zero-as-typoscript-filter-value.rst diff --git a/Documentation/source/changelog/prior-1.0.0/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer.rst b/Documentation/changelog/prior-1.0.0/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer.rst similarity index 100% rename from Documentation/source/changelog/prior-1.0.0/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer.rst rename to Documentation/changelog/prior-1.0.0/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer.rst diff --git a/Documentation/source/concepts.rst b/Documentation/concepts.rst similarity index 100% rename from Documentation/source/concepts.rst rename to Documentation/concepts.rst diff --git a/Documentation/configuration.rst b/Documentation/configuration.rst new file mode 100644 index 0000000..7cb6fa8 --- /dev/null +++ b/Documentation/configuration.rst @@ -0,0 +1,109 @@ +.. highlight:: typoscript + +.. _configuration: + +Configuration +============= + +Installation wide configuration is handled inside of the extension manager. Just check out the +options there, they all have labels. + +Everything else is configured through TypoScript. If you overwrite them through `setup` make sure to +keep them in the `module` area as they will be accessed from backend mode of TYPO3 for indexing. Do +so by placing the following line at the end:: + + module.tx_searchcore < plugin.tx_searchcore + +.. todo:: + + We will use references inside the extension to make the above unnecessary in the future. + +The structure is following TYPO3 Extbase conventions. All settings are placed inside of:: + + plugin.tx_searchcore.settings + +Here is the example default configuration that's provided through static include: + +.. code-block:: typoscript + + plugin { + tx_searchcore { + settings { + connections { + elasticsearch { + host = localhost + port = 9200 + index = typo3content + } + } + + indexing { + tt_content { + additionalWhereClause = tt_content.CType NOT IN ('gridelements_pi1', 'list', 'div', 'menu', 'shortcut', 'search', 'login') AND (tt_content.bodytext != '' OR tt_content.header != '') + } + + pages { + additionalWhereClause = pages.doktype NOT IN (3, 199, 6, 254, 255) + abstractFields = abstract, description, bodytext + contentFields = header, bodytext + } + } + } + } + } + +.. code-block:: typoscript + + plugin { + tx_searchcore { + settings { + connections { + elasticsearch { + host = {$plugin.tx_searchcore.settings.connections.elasticsearch.host} + port = {$plugin.tx_searchcore.settings.connections.elasticsearch.port} + index = {$plugin.tx_searchcore.settings.connections.elasticsearch.index} + } + } + + indexing { + # Not for direct indexing therefore no indexer. + # Used to configure tt_content fetching while indexing pages + tt_content { + additionalWhereClause = {$plugin.tx_searchcore.settings.indexing.tt_content.additionalWhereClause} + } + + pages { + indexer = Codappix\SearchCore\Domain\Index\TcaIndexer\PagesIndexer + additionalWhereClause = {$plugin.tx_searchcore.settings.indexing.pages.additionalWhereClause} + abstractFields = {$plugin.tx_searchcore.settings.indexing.pages.abstractFields} + contentFields = {$plugin.tx_searchcore.settings.indexing.pages.contentFields} + } + } + + searching { + fields { + query = _all + } + } + } + } + } + + module.tx_searchcore < plugin.tx_searchcore + +.. _configuration_options: + +Options +------- + +The following sections contains the different options grouped by their applied area, e.g. for +:ref:`connections` and :ref:`indexer`: ``plugin.tx_searchcore.settings.connection`` or +``plugin.tx_searchcore.settings.indexing``: + +.. toctree:: + :maxdepth: 1 + :glob: + + configuration/connections + configuration/indexing + configuration/searching diff --git a/Documentation/source/configuration/connections.rst b/Documentation/configuration/connections.rst similarity index 100% rename from Documentation/source/configuration/connections.rst rename to Documentation/configuration/connections.rst diff --git a/Documentation/source/configuration/dataProcessing/ContentObjectDataProcessorAdapterProcessor.rst b/Documentation/configuration/dataProcessing/ContentObjectDataProcessorAdapterProcessor.rst similarity index 100% rename from Documentation/source/configuration/dataProcessing/ContentObjectDataProcessorAdapterProcessor.rst rename to Documentation/configuration/dataProcessing/ContentObjectDataProcessorAdapterProcessor.rst diff --git a/Documentation/source/configuration/dataProcessing/CopyToProcessor.rst b/Documentation/configuration/dataProcessing/CopyToProcessor.rst similarity index 100% rename from Documentation/source/configuration/dataProcessing/CopyToProcessor.rst rename to Documentation/configuration/dataProcessing/CopyToProcessor.rst diff --git a/Documentation/source/configuration/dataProcessing/GeoPointProcessor.rst b/Documentation/configuration/dataProcessing/GeoPointProcessor.rst similarity index 100% rename from Documentation/source/configuration/dataProcessing/GeoPointProcessor.rst rename to Documentation/configuration/dataProcessing/GeoPointProcessor.rst diff --git a/Documentation/source/configuration/dataProcessing/RemoveProcessor.rst b/Documentation/configuration/dataProcessing/RemoveProcessor.rst similarity index 100% rename from Documentation/source/configuration/dataProcessing/RemoveProcessor.rst rename to Documentation/configuration/dataProcessing/RemoveProcessor.rst diff --git a/Documentation/source/configuration/dataProcessing/TcaRelationResolvingProcessor.rst b/Documentation/configuration/dataProcessing/TcaRelationResolvingProcessor.rst similarity index 100% rename from Documentation/source/configuration/dataProcessing/TcaRelationResolvingProcessor.rst rename to Documentation/configuration/dataProcessing/TcaRelationResolvingProcessor.rst diff --git a/Documentation/source/configuration/indexing.rst b/Documentation/configuration/indexing.rst similarity index 100% rename from Documentation/source/configuration/indexing.rst rename to Documentation/configuration/indexing.rst diff --git a/Documentation/source/configuration/searching.rst b/Documentation/configuration/searching.rst similarity index 100% rename from Documentation/source/configuration/searching.rst rename to Documentation/configuration/searching.rst diff --git a/Documentation/source/connections.rst b/Documentation/connections.rst similarity index 100% rename from Documentation/source/connections.rst rename to Documentation/connections.rst diff --git a/Documentation/source/dataprocessors.rst b/Documentation/dataprocessors.rst similarity index 100% rename from Documentation/source/dataprocessors.rst rename to Documentation/dataprocessors.rst diff --git a/Documentation/source/development.rst b/Documentation/development.rst similarity index 100% rename from Documentation/source/development.rst rename to Documentation/development.rst diff --git a/Documentation/source/development/connection.rst b/Documentation/development/connection.rst similarity index 100% rename from Documentation/source/development/connection.rst rename to Documentation/development/connection.rst diff --git a/Documentation/source/development/contribution.rst b/Documentation/development/contribution.rst similarity index 100% rename from Documentation/source/development/contribution.rst rename to Documentation/development/contribution.rst diff --git a/Documentation/source/development/dataProcessor.rst b/Documentation/development/dataProcessor.rst similarity index 100% rename from Documentation/source/development/dataProcessor.rst rename to Documentation/development/dataProcessor.rst diff --git a/Documentation/source/development/indexer.rst b/Documentation/development/indexer.rst similarity index 100% rename from Documentation/source/development/indexer.rst rename to Documentation/development/indexer.rst diff --git a/Documentation/source/features.rst b/Documentation/features.rst similarity index 100% rename from Documentation/source/features.rst rename to Documentation/features.rst diff --git a/Documentation/source/index.rst b/Documentation/index.rst similarity index 100% rename from Documentation/source/index.rst rename to Documentation/index.rst diff --git a/Documentation/source/indexer.rst b/Documentation/indexer.rst similarity index 100% rename from Documentation/source/indexer.rst rename to Documentation/indexer.rst diff --git a/Documentation/source/installation.rst b/Documentation/installation.rst similarity index 89% rename from Documentation/source/installation.rst rename to Documentation/installation.rst index e24b348..a72741f 100644 --- a/Documentation/source/installation.rst +++ b/Documentation/installation.rst @@ -26,10 +26,11 @@ 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: -.. literalinclude:: ../../composer.json - :caption: Dependencies from composer.json - :lines: 19-21 - :dedent: 8 +.. code:: + + "php": ">=7.2.0 <8", + "typo3/cms-core": "^9.5", + "ruflin/elastica": "^3.2" Setup ----- diff --git a/Documentation/make.bat b/Documentation/make.bat deleted file mode 100644 index 28e834b..0000000 --- a/Documentation/make.bat +++ /dev/null @@ -1,281 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source -set I18NSPHINXOPTS=%SPHINXOPTS% source -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. epub3 to make an epub3 - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - echo. coverage to run coverage check of the documentation if enabled - echo. dummy to check syntax errors of document sources - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -REM Check if sphinx-build is available and fallback to Python version if any -%SPHINXBUILD% 1>NUL 2>NUL -if errorlevel 9009 goto sphinx_python -goto sphinx_ok - -:sphinx_python - -set SPHINXBUILD=python -m sphinx.__init__ -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -:sphinx_ok - - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\TYPO3Extensionsearch_core.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\TYPO3Extensionsearch_core.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "epub3" ( - %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "coverage" ( - %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage - if errorlevel 1 exit /b 1 - echo. - echo.Testing of coverage in the sources finished, look at the ^ -results in %BUILDDIR%/coverage/python.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -if "%1" == "dummy" ( - %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. Dummy builder generates no files. - goto end -) - -:end diff --git a/Documentation/source/readme.rst b/Documentation/readme.rst similarity index 100% rename from Documentation/source/readme.rst rename to Documentation/readme.rst diff --git a/Documentation/source/conf.py b/Documentation/source/conf.py deleted file mode 100644 index c559ba3..0000000 --- a/Documentation/source/conf.py +++ /dev/null @@ -1,312 +0,0 @@ -# -*- coding: utf-8 -*- -# -# TYPO3 Extension search_core documentation build configuration file, created by -# sphinx-quickstart on Thu Dec 15 16:10:27 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.ifconfig', - 'sphinx.ext.extlinks', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'TYPO3 Extension search_core' -copyright = u'2016 - 2018, Daniel Siepmann' -author = u'Daniel Siepmann' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = u'0.0.7' -# The full version, including alpha/beta/rc tags. -release = u'0.0.7' -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'alabaster' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - 'description': 'TYPO3 Extension to integrate search services.', - 'github_user': 'Codappix', - 'github_repo': 'search_core', - 'github_button': True, - 'github_banner': True, - 'travis_button': False, # As long as master is not on travis - 'page_width': '1200px', -} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. -# " v documentation" by default. -#html_title = u'TYPO3 Extension search_core v0.0.6' - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -#html_last_updated_fmt = None - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -html_sidebars = { - "**": ['about.html', 'globaltoc.html', 'localtoc.html', 'donate.html', 'searchbox.html', 'relations.html'] -} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'TYPO3Extensionsearch_coredoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'TYPO3Extensionsearch_core.tex', u'TYPO3 Extension search\\_core Documentation', - u'Daniel Siepmann', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'typo3extensionsearch_core', u'TYPO3 Extension search_core Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'TYPO3Extensionsearch_core', u'TYPO3 Extension search_core Documentation', - author, 'TYPO3Extensionsearch_core', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - 't3tcaref': ('https://docs.typo3.org/typo3cms/TCAReference/', None), - 't3tsref': ('https://docs.typo3.org/typo3cms/TyposcriptReference/', None), -} -extlinks = { - 'project': ('https://github.com/Codappix/search_core/projects/%s', 'Github project: '), - 'pr': ('https://github.com/Codappix/search_core/pull/%s', 'Github pull request: '), - 'issue': ('https://github.com/Codappix/search_core/issues/%s', 'Github issue: '), -} diff --git a/Documentation/source/configuration.rst b/Documentation/source/configuration.rst deleted file mode 100644 index 53ac469..0000000 --- a/Documentation/source/configuration.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. highlight:: typoscript - -.. _configuration: - -Configuration -============= - -Installation wide configuration is handled inside of the extension manager. Just check out the -options there, they all have labels. - -Everything else is configured through TypoScript. If you overwrite them through `setup` make sure to -keep them in the `module` area as they will be accessed from backend mode of TYPO3 for indexing. Do -so by placing the following line at the end:: - - module.tx_searchcore < plugin.tx_searchcore - -.. todo:: - - We will use references inside the extension to make the above unnecessary in the future. - -The structure is following TYPO3 Extbase conventions. All settings are placed inside of:: - - plugin.tx_searchcore.settings - -Here is the example default configuration that's provided through static include: - -.. literalinclude:: ../../Configuration/TypoScript/constants.txt - :language: typoscript - :caption: Static TypoScript Constants - -.. literalinclude:: ../../Configuration/TypoScript/setup.txt - :language: typoscript - :caption: Static TypoScript Setup - -.. _configuration_options: - -Options -------- - -The following sections contains the different options grouped by their applied area, e.g. for -:ref:`connections` and :ref:`indexer`: ``plugin.tx_searchcore.settings.connection`` or -``plugin.tx_searchcore.settings.indexing``: - -.. toctree:: - :maxdepth: 1 - :glob: - - configuration/connections - configuration/indexing - configuration/searching diff --git a/Documentation/source/usage.rst b/Documentation/usage.rst similarity index 100% rename from Documentation/source/usage.rst rename to Documentation/usage.rst