From 9b6479e12d7839c69e0f481cc3c04b64ce7969c5 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 15 Dec 2016 16:47:09 +0100 Subject: [PATCH 1/2] WIP|FEATURE: First basic documentation --- Documentation/.gitignore | 1 + Documentation/Makefile | 230 +++++++++++++++++++ Documentation/make.bat | 281 ++++++++++++++++++++++++ Documentation/source/conf.py | 304 ++++++++++++++++++++++++++ Documentation/source/index.rst | 38 ++++ Documentation/source/installation.rst | 45 ++++ 6 files changed, 899 insertions(+) create mode 100644 Documentation/.gitignore create mode 100644 Documentation/Makefile create mode 100644 Documentation/make.bat create mode 100644 Documentation/source/conf.py create mode 100644 Documentation/source/index.rst create mode 100644 Documentation/source/installation.rst diff --git a/Documentation/.gitignore b/Documentation/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/Documentation/.gitignore @@ -0,0 +1 @@ +build diff --git a/Documentation/Makefile b/Documentation/Makefile new file mode 100644 index 0000000..e54e38d --- /dev/null +++ b/Documentation/Makefile @@ -0,0 +1,230 @@ +# 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/make.bat b/Documentation/make.bat new file mode 100644 index 0000000..28e834b --- /dev/null +++ b/Documentation/make.bat @@ -0,0 +1,281 @@ +@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/conf.py b/Documentation/source/conf.py new file mode 100644 index 0000000..6b6fb3d --- /dev/null +++ b/Documentation/source/conf.py @@ -0,0 +1,304 @@ +# -*- 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', +] + +# 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, 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'1.0.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0.0' + +# 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': 'DanielSiepmann', + '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 v1.0.0' + +# 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'] +} + +# 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 = {'https://docs.python.org/': None} diff --git a/Documentation/source/index.rst b/Documentation/source/index.rst new file mode 100644 index 0000000..5ba0cef --- /dev/null +++ b/Documentation/source/index.rst @@ -0,0 +1,38 @@ +TYPO3 Extension search_core's documentation! +============================================ + +Introduction +============ + +What does it do? +---------------- + +The goal of this extension is to provide search integrations into TYPO3 CMS. The extension will +abstract the concrete implementations to allow exchange of concrete backends like elasticsearch or +solr. + +The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to +update search indexes on updates. Also a command line interface is provided for interactions like +reindexing. + +Current state +------------- + +This is still a very early alpha version. More information can be taken from Github at +`current issues`_ and `current projects`_. + +We are also focusing on Code Quality and Testing through `travis ci`_, `scrutinizer`_ and `codacy`_. + +.. _current issues: https://github.com/DanielSiepmann/search_core/issues +.. _current projects: https://github.com/DanielSiepmann/search_core/projects +.. _travis ci: https://travis-ci.org/DanielSiepmann/search_core +.. _scrutinizer: https://scrutinizer-ci.com/g/DanielSiepmann/search_core/inspections +.. _codacy: https://www.codacy.com/app/daniel-siepmann/search_core/dashboard + +Table of Contents +================= + +.. toctree:: + :maxdepth: 2 + + installation diff --git a/Documentation/source/installation.rst b/Documentation/source/installation.rst new file mode 100644 index 0000000..30c0bb8 --- /dev/null +++ b/Documentation/source/installation.rst @@ -0,0 +1,45 @@ +.. heighlight:: typoscript +.. _installation: + +Installation +============ + +The extension can be installed through composer: + +.. code-block:: bash + + composer require "danielsiepmann/search_core" "dev-feature/integrate-elasticsearch" + +or by downloading and placing it inside the :file:`typo3conf/ext`-Folder of your installation. + +Afterwards you need to enable the extension through the extension manager and include the static +typoscript setup. + +.. _configuration: + +Configuration +============= + +The extension offers the following configuration options 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. 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. + +Currently no constants are available, but this will change in the near future to make configuration +easier. + +The strucutre 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 setup: + +.. literalinclude:: ../../Configuration/TypoScript/setup.txt + :language: typoscript + :linenos: + :caption: Static TypoScript Setup From fdf5aa4f8220a51fb29dc9c3b7bff4a7852c8de1 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 15 Dec 2016 17:59:13 +0100 Subject: [PATCH 2/2] FEATURE: Add documentation of current state * Document all options * Document concepts * Document connections and indexer --- Documentation/source/concepts.rst | 30 +++++ Documentation/source/conf.py | 6 +- Documentation/source/configuration.rst | 163 +++++++++++++++++++++++++ Documentation/source/connections.rst | 26 ++++ Documentation/source/index.rst | 8 +- Documentation/source/indexer.rst | 28 +++++ Documentation/source/installation.rst | 39 +----- Documentation/source/usage.rst | 23 ++++ 8 files changed, 286 insertions(+), 37 deletions(-) create mode 100644 Documentation/source/concepts.rst create mode 100644 Documentation/source/configuration.rst create mode 100644 Documentation/source/connections.rst create mode 100644 Documentation/source/indexer.rst create mode 100644 Documentation/source/usage.rst diff --git a/Documentation/source/concepts.rst b/Documentation/source/concepts.rst new file mode 100644 index 0000000..4d48d35 --- /dev/null +++ b/Documentation/source/concepts.rst @@ -0,0 +1,30 @@ +.. _concepts: + +Concepts +======== + +The extension is built with the following concepts in mind. + +.. _concepts_connections: + +Connections +----------- + +It should be possible to use different search services like elasticsearch and solr out of the box. +If a service is not contained, it should be possible to implement the necessary part by implementing +the necessary interfaces and configuring the extension to use the new connection. + +Also it should be possible to use multiple connections at once. This way multiple search services +can be used in the same installation. + +Currently only :ref:`Elasticsearch` is provided. + +.. _concepts_indexing: + +Indexing +-------- + +The indexing is done by one of the available indexer. It should be possible to define the indexer to +use for certein document types. Also it should be possible to write custom indexer to use. + +Currently only the :ref:`TcaIndexer` is provided. diff --git a/Documentation/source/conf.py b/Documentation/source/conf.py index 6b6fb3d..648d618 100644 --- a/Documentation/source/conf.py +++ b/Documentation/source/conf.py @@ -167,7 +167,7 @@ html_static_path = ['_static'] # Custom sidebar templates, maps document names to template names. html_sidebars = { - "**": ['about.html', 'globaltoc.html', 'localtoc.html', 'donate.html', 'searchbox.html'] + "**": ['about.html', 'globaltoc.html', 'localtoc.html', 'donate.html', 'searchbox.html', 'relations.html'] } # Additional templates that should be rendered to pages, maps page names to @@ -301,4 +301,6 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = { + 't3-tca-ref': ('https://docs.typo3.org/typo3cms/TCAReference/', None) +} diff --git a/Documentation/source/configuration.rst b/Documentation/source/configuration.rst new file mode 100644 index 0000000..657395f --- /dev/null +++ b/Documentation/source/configuration.rst @@ -0,0 +1,163 @@ +.. highlight:: typoscript + +.. _configuration: + +Configuration +============= + +The extension offers the following configuration options 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. 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. + +Currently no constants are available, but this will change in the near future to make configuration +easier. + +The strucutre 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 setup: + +.. literalinclude:: ../../Configuration/TypoScript/setup.txt + :language: typoscript + :linenos: + :caption: Static TypoScript Setup + +.. _configuration_options: + +Options +------- + +The following section contain the different options for e.g. +``plugin.tx_searchcore.settings.connection`` or ``plugin.tx_searchcore.settings.index``. + +.. _configuration_options_connection: + +connection +^^^^^^^^^^ + +Holds settings regarding the connection to search service like elasticsearch or solr. + +Configured as:: + + plugin { + tx_searchcore { + settings { + connection { + // the settings + } + } + } + } + +.. _host: + +``host`` +"""""""" + + Used by: :ref:`Elasticsearch`. + + The host, e.g. ``localhost`` or an ip where the search service is reachable from TYPO3 + installation. + + Example:: + + plugin.tx_searchcore.settings.connection.host = localhost + +.. _port: + +``port`` +"""""""" + + Used by: :ref:`Elasticsearch`. + + The port where search service is reachable. E.g. default ``9200`` for elasticsearch. + + Example:: + + plugin.tx_searchcore.settings.connection.port = 9200 + + + +.. _configuration_options_index: + +index +^^^^^ + +Holds settings regarding the indexing of TYPO3 records to search service. + +Configured as:: + + plugin { + tx_searchcore { + settings { + index { + // the settings + } + } + } + } + +.. _allowedTables: + +``allowedTables`` +""""""""""""""""" + + Used by: :ref:`TcaIndexer`. + + Defines which TYPO3 tables are allowed to be indexed. Only whitelisted tables will be processed + through Command Line Interface and Hooks. + + Contains a comma separated list of table names. Spaces are trimmed. + + Example:: + + plugin.tx_searchcore.settings.index.allowedTables = tt_content, fe_users + +.. _rootLineBlacklist: + +``rootLineBlacklist`` +""""""""""""""""""""" + + Used by: :ref:`TcaIndexer`. + + Defines a blacklist of page uids. Records below any of these pages, or subpages, are not + indexed. This allows you to define areas that should not be indexed. + The page attribute *No Search* is also taken into account to prevent indexing records from only one + page without recursion. + + Contains a comma separated list of table names. Spaces are trimmed. + + Example:: + + plugin.tx_searchcore.settings.index.rootLineBlacklist = 3, 10, 100 + +Also it's possible to define some behaviour for the different document types. In context of TYPO3 +tables are used as document types 1:1. It's possible to configure different tables. The following +options are available: + +.. _additionalWhereClause: + +``additionalWhereClause`` +""""""""""""""""""""""""" + + Used by: :ref:`TcaIndexer`. + + Add additional SQL to where clauses to determine indexable records from the table. This way you + can exclude specific records like ``tt_content`` records with specific ``CType`` values or + something else. E.g. you can add a new field to the table to exclude records from indexing. + + Example:: + + plugin.tx_searchcore.settings.index.tt_content.additionalWhereClause = tt_content.CType NOT IN ('gridelements_pi1', 'list', 'div', 'menu') + + .. attention:: + + Make sure to prefix all fields with the corresponding table name. The selection from + database will contain joins and can lead to SQL errors if a field exists in multiple tables. diff --git a/Documentation/source/connections.rst b/Documentation/source/connections.rst new file mode 100644 index 0000000..678a92d --- /dev/null +++ b/Documentation/source/connections.rst @@ -0,0 +1,26 @@ +.. _connections: + +Connections +=========== + +See Concept of :ref:`concepts_connections` for further background information. + +The extension provides the following connections out of the box: + +.. _Elasticsearch: + +Elasticsearch +------------- + +Integrates `elastic Elasticsearch`_ using `elastica`_ into TYPO3. + +Provides basic support like indexing without mappings and full text search at the moment. + +The connection is configurable through the following options: + +* :ref:`host` + +* :ref:`port` + +.. _elastic Elasticsearch: https://www.elastic.co/products/elasticsearch +.. _elastica: http://elastica.io/ diff --git a/Documentation/source/index.rst b/Documentation/source/index.rst index 5ba0cef..40ba743 100644 --- a/Documentation/source/index.rst +++ b/Documentation/source/index.rst @@ -33,6 +33,12 @@ Table of Contents ================= .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :glob: installation + configuration + usage + concepts + connections + indexer diff --git a/Documentation/source/indexer.rst b/Documentation/source/indexer.rst new file mode 100644 index 0000000..ec9d59a --- /dev/null +++ b/Documentation/source/indexer.rst @@ -0,0 +1,28 @@ +.. _indexer: + +Indexer +======= + +See Concept of :ref:`concepts_indexing` for further background information. + +The extension provides the following indexer out of the box: + +.. _TcaIndexer: + +TcaIndexer +---------- + +Provides zero configuration TYPO3 integration by using the :ref:`t3-tca-ref:start`. You just can +start indexing TYPO3. + +The indexer will use the TCA to fetch all necessary information like relations. Currently the +implementation is very basic. In future it will also provide mapping for Elasticsearch and further +stuff. + +The indexer is configurable through the following options: + +* :ref:`allowedTables` + +* :ref:`rootLineBlacklist` + +* :ref:`additionalWhereClause` diff --git a/Documentation/source/installation.rst b/Documentation/source/installation.rst index 30c0bb8..ff5ce0b 100644 --- a/Documentation/source/installation.rst +++ b/Documentation/source/installation.rst @@ -1,45 +1,16 @@ -.. heighlight:: typoscript +.. highlight:: bash .. _installation: Installation ============ -The extension can be installed through composer: +The extension can be installed through composer:: -.. code-block:: bash + composer require "leonmrni/search_core dev-feature/integrate-elasticsearch" - composer require "danielsiepmann/search_core" "dev-feature/integrate-elasticsearch" - -or by downloading and placing it inside the :file:`typo3conf/ext`-Folder of your installation. +or by `downloading`_ and placing it inside the :file:`typo3conf/ext`-Folder of your installation. Afterwards you need to enable the extension through the extension manager and include the static typoscript setup. -.. _configuration: - -Configuration -============= - -The extension offers the following configuration options 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. 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. - -Currently no constants are available, but this will change in the near future to make configuration -easier. - -The strucutre 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 setup: - -.. literalinclude:: ../../Configuration/TypoScript/setup.txt - :language: typoscript - :linenos: - :caption: Static TypoScript Setup +.. _downloading: https://github.com/DanielSiepmann/search_core/archive/feature/integrate-elasticsearch.zip diff --git a/Documentation/source/usage.rst b/Documentation/source/usage.rst new file mode 100644 index 0000000..edbd837 --- /dev/null +++ b/Documentation/source/usage.rst @@ -0,0 +1,23 @@ +.. highlight:: bash +.. _usage: + +Usage +===== + +.. _usage_manual_indexing: + +Manual indexing +--------------- + +You can trigger indexing from CLI:: + + ./typo3/cli_dispatch.phpsh extbase index:index --table 'tt_content' + +This will index the table ``tt_content`` using the :ref:`TcaIndexer`. + +.. _usage_auto_indexing: + +Auto indexing +------------- + +Indexing is done through hooks everytime an record is changed.