diff options
Diffstat (limited to 'bin/reevotech/vendor/addwiki/mediawiki-api/docs')
10 files changed, 887 insertions, 0 deletions
diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/Makefile b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/Makefile new file mode 100644 index 00000000..46208266 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make <target>' where <target> 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/mediawiki-api.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/mediawiki-api.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/mediawiki-api" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/mediawiki-api" + @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/bin/reevotech/vendor/addwiki/mediawiki-api/docs/category_traverser.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/category_traverser.rst new file mode 100644 index 00000000..497398e8 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/category_traverser.rst @@ -0,0 +1,28 @@ +Category Traversal +================== + +The CategoryTraverser class is used to start at one Category page in a wiki's category hierarchy +and descend through that category's children, grandchildren, and so on. +The basic output of this is a Pages object containing all the pages in the category tree. +It is also possible to register callbacks that will be called +for every subcategory or other page (i.e. anything not a category). + +Basic usage +----------- + +To get all pages in a category or any of its subcategories. + +.. code-block:: php + :linenos: + + // Construct the API. + $api = new \Mediawiki\Api\MediawikiApi( 'http://localhost/w/api.php' ); + $services = new \Mediawiki\Api\MediawikiFactory( $api ); + $categoryTraverser = $services->newCategoryTraverser(); + + // Get the root category. + $rootCatIdent = new PageIdentifier( new Title( 'Category:Categories' ) ); + $rootCat = $this->factory->newPageGetter()->getFromPageIdentifier( $pageIdentifier ); + + // Get all pages. + $allPages = $categoryTraverser->descend( $rootCat ); diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/conf.py b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/conf.py new file mode 100644 index 00000000..3310f585 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/conf.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# 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. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import sys, os +from sphinx.highlighting import lexers +from pygments.lexers.web import PhpLexer + +lexers['php'] = PhpLexer(startinline=True, linenos=1) +lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1) +primary_domain = 'php' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# 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 master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'mediawiki-api' +copyright = '2016, addwiki' +author = 'addwiki' + +# 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 = '0.6' +# The full version, including alpha/beta/rc tags. +release = '0.6' + +# 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 + +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'default' + +# 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'] + +# Output file base name for HTML help builder. +htmlhelp_basename = 'mediawiki-apidoc' diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/contributing.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/contributing.rst new file mode 100644 index 00000000..c2cd2813 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/contributing.rst @@ -0,0 +1,44 @@ +Contributing +============ + +We welcome all contributions, be they code, documentation, or even just ideas about how to make this package better! + +The best way to get started is to browse the `#addwiki board on Phabricator`_ +and either work on one of the tasks already there or create a new one with details of what you want to work on. + +.. _Addwiki board on Phabricator: https://phabricator.wikimedia.org/tag/addwiki/ + +Get the code +------------ + +The code is `hosted on GitHub`_. Clone the repository with:: + + $ git clone https://github.com/addwiki/mediawiki-api.git + +.. _hosted on GitHub: https://github.com/addwiki/mediawiki-api + +Run the tests +------------- + +After cloning the repository and updating the dependencies with Composer, +you should be able to run all **unit** tests with:: + + ./vendor/bin/phpunit ./tests/unit + +To run the **integration** tests you need to set up a local MediaWiki installation +(including with a ``admin`` administrator user with password ``admin123``) +and tell ``phpunit`` where to find it. + +1. Copy ``./phpunit.xml.dist`` to ``./phpunit.xml`` and add the following section:: + + <php> + <env name="MEDIAWIKI_API_URL" value="http://localhost/path/to/your/wiki/api.php" /> + </php> + +2. Create and promote a new user:: + + $ php mediawiki/maintenance/createAndPromote.php --sysop WikiSysop wiki123sysop + +Now all integration tests can be run with:: + + ./vendor/bin/phpunit ./tests/integration diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/file_uploader.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/file_uploader.rst new file mode 100755 index 00000000..9f8b534f --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/file_uploader.rst @@ -0,0 +1,28 @@ +Uploading files +=============== + +Basic usage +----------- + +To upload a single, small-sized file: + +.. code-block:: php + :linenos: + + // Construct the API. + $api = new \Mediawiki\Api\MediawikiApi( 'http://localhost/w/api.php' ); + $services = new \Mediawiki\Api\MediawikiFactory( $api ); + $fileUploader = $services->newFileUploader(); + + // Upload the file. + $fileUploader->upload( 'The_file.png', '/full/path/to/the_file.png' ); + +If you need to work with larger files, you can switch to chunked uploading: + +.. code-block:: php + :linenos: + + // Upload the file in 10 MB chunks. + $fileUploader = $services->newFileUploader(); + $fileUploader->setChunkSize( 1024 * 1024 * 10 ); + $fileUploader->upload( 'The_file.png', '/full/path/to/the_file.png' ); diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/index.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/index.rst new file mode 100644 index 00000000..558107b3 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/index.rst @@ -0,0 +1,25 @@ +Documentation for addwiki/mediawiki-api +======================================= + +Welcome to the documentation for the ``addwiki/mediawiki-api`` package! +This is part of the Addwiki_ family of PHP packages. + +.. _Addwiki: http://addwiki.readthedocs.io/ + +Quick links: + +* This documentation: http://addwiki.readthedocs.io/projects/mediawiki-api/ +* Source code: https://github.com/addwiki/mediawiki-api/ +* Issue tracker: https://phabricator.wikimedia.org/project/profile/1490/ + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + page_list_getter.rst + category_traverser.rst + namespace_getter.rst + file_uploader.rst + contributing.rst diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/make.bat b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/make.bat new file mode 100644 index 00000000..a5507331 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/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% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +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 ^<target^>` where ^<target^> 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\mediawiki-api.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\mediawiki-api.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/bin/reevotech/vendor/addwiki/mediawiki-api/docs/namespace_getter.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/namespace_getter.rst new file mode 100644 index 00000000..c362833f --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/namespace_getter.rst @@ -0,0 +1,54 @@ +Getting Namespaces +================== + +The Name Space Getter allows you to search for namespaces and their aliases and to list all namespaces of a wiki. + +To use it, first get a new NamespaceGetter object from the factory: + +.. code-block:: php + + $api = new \Mediawiki\Api\MediawikiApi( 'http://localhost/w/api.php' ); + $services = new \Mediawiki\Api\MediawikiFactory( $api ); + $namespaceGetter = $services->newNamespaceGetter(); + + +Looking for a namespace +----------------------- + +If you've got a page name like ``File:awesome_cats.jpg`` and want to know its namespace ID and possible localized names +and aliases, use the following code: + +.. code-block:: php + + $fileNamespace = $namespaceGetter->getNamespaceByName( 'File' ); + printf( "Name in local language: %s\n", $fileNamespace->getLocalName() ); + printf( "Possible aliases: %s\n", implode( ', ', $fileNamespace->getAliases() ) ); + // ... etc + +``getNamespaceByName`` accepts the canonical name, the local name and aliases. If you want to match only the canonical +name, use ``getNamespaceByCanonicalName`` instead. + + +Getting a namespaced page +------------------------- + +If you have a page title that is not in the default namespace, you can't pass the page name string ``PageGetter`` but +must construct a ``Title`` object instead: + +.. code-block:: php + + $pageName = 'User:MalReynolds'; + $nameParts = explode( ':', $pageName, 2 ); + $namespace = $namespaceGetter->getNamespaceByName( $nameParts[0] ); + $title = new \Mediawiki\DataModel\Title( $nameParts[1], $namespace->getId() ); + $page = $services->newPageGetter()->getFromTitle( $title ); + + +Listing all namespaces +---------------------- + +.. code-block:: php + + foreach( $namespaceGetter->getNamespaces() as $namespace ) { + echo $namespace->getLocalName() . "\n"; + }
\ No newline at end of file diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/page_list_getter.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/page_list_getter.rst new file mode 100644 index 00000000..aad9f8a8 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/page_list_getter.rst @@ -0,0 +1,88 @@ +Page Lists +========== + +The Page List Getter allows you to retrieve lists of pages based on various criteria. +It takes care of continuing queries where they span multiple requests, +ensuring that you get all pages in your result set. +This means that for some lists of pages a great many requests will be sent, +and you should account for this possible performance problem when you request these lists +(e.g. by running these as a background process and caching the results). + +To use it, first get a new PageListGetter object from the factory: + +.. code-block:: php + + $api = new \Mediawiki\Api\MediawikiApi( 'http://localhost/w/api.php' ); + $services = new \Mediawiki\Api\MediawikiFactory( $api ); + $pageListGetter = $services->newPageListGetter(); + +The examples below all use this ``$pageListGetter`` object. + +All methods of the PageListGetter return ``Page`` objects; +this class is part of the `addwiki/mediawiki-datamodel`_ package, +and is documented in `that page's documentation`_. + +.. _addwiki/mediawiki-datamodel: https://packagist.org/packages/addwiki/mediawiki-datamodel +.. _that page's documentation: http://addwiki.readthedocs.io/projects/mediawiki-datamodel/ + +All pages in a category +----------------------- + +Note that the category name as provided should also include the 'Category' namespace prefix +(in the language of the wiki, or in canonical English form). + +.. code-block:: php + + $examplePages = $pageListGetter->getPageListFromCategoryName( 'Category:Example pages' ); + foreach ( $examplePages->asArray() as $exPage ) { + echo $exPage->getTitle()->getText(); + } + +Pages that transclude a template +-------------------------------- + +Although generally it is templates that are transcluded, +any page may be and so any page title can be passed to this method. + +.. code-block:: php + + $usingTestTemplate = $pageListGetter->getPageListFromPageTransclusions( 'Template:Test' ); + +Pages that link to a given page +------------------------------- + +Get the list of pages that link to a particular page. + +.. code-block:: php + + $backLinks = $pageListGetter->getFromWhatLinksHere( 'Test page' ); + +Pages with a given prefix +------------------------- + +Find pages that have a particular prefix to their title. +This can also be used to find subpages of any page. + +.. code-block:: php + + $backLinks = $pageListGetter->getFromPrefix( 'A page/' ); + +Random pages +------------ + +Get up to ten random pages at a time. +This method takes the same arguments as the API `list=random`_ query. + +.. _list=random: https://www.mediawiki.org/wiki/API:Random + +* ``rnlimit`` How many pages to get. No more than 10 (20 for bots) allowed. Default: 1. +* ``rnnamespace`` Pipe-separate list of namespace IDs. +* ``rnfilterredir`` How to filter for redirects. Possible values: ``all``, ``redirects``, ``nonredirects``. Default: ``nonredirects``. + +.. code-block:: php + + $backLinks = $pageListGetter->getRandom( [ + 'rnlimit' => 7, + 'rnnamespace' => '3|5|6', + 'rnfilterredir' => 'all', + ] ); diff --git a/bin/reevotech/vendor/addwiki/mediawiki-api/docs/page_purger.rst b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/page_purger.rst new file mode 100644 index 00000000..84cd7523 --- /dev/null +++ b/bin/reevotech/vendor/addwiki/mediawiki-api/docs/page_purger.rst @@ -0,0 +1,34 @@ +Page Purger +=========== + +``PagePurger`` allows you to purge a single ``Page`` or multiple ``Pages``. +You can also check whether the ``Page`` or ``Pages`` have been purged successfully. + +To get started you need to create ``PagePurger`` object: + +.. code-block:: php + +$api = new \Mediawiki\Api\MediawikiApi( 'http://localhost/w/api.php' ); +$pagePurger = new \Mediawiki\Api\Service\PagePurger( $api ); + +Purge +----- + +Purge a single ``Page``. It will return a ``boolean`` that indicates if the purge operation was successful. + +Example: + +.. code-block:: php + +$page = new \Mediawiki\DataModel\Page(...); +$pagePurger->purge( $page ); + +PurgePages +---------- + +Purges every ``Page`` in the ``Pages`` object at once. It will return a new ``Pages`` object *with the purged ``Page``(s) only!* + +.. code-block:: php + +$pages = new \Mediawiki\DataModel\Pages(...); +$pagePurger->purgePages( $pages ); |