mirror of
https://github.com/diocloid/LinkTitles.git
synced 2025-07-13 17:59:29 +02:00
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
@mainpage LinkTitles
|
|
@author [Daniel Kraus (bovender)](http://www.mediawiki.org/wiki/User:Bovender)
|
|
@date 2012-2016
|
|
@copyright [GNU GPL v2+](http://www.gnu.org/licenses/gpl-2.0.html)
|
|
|
|
%LinkTitles source code documentation
|
|
=====================================
|
|
|
|
This is the [source code][] documentation for the [LinkTitles][] extension
|
|
for [MediaWiki][].
|
|
|
|
The central class is LinkTitles, which contains only static functions. If
|
|
you are looking for the linking algorithm, inspect the
|
|
LinkTitles\\Extension::parseContent() function.
|
|
|
|
The extension provides two methods for batch-processing of pages. One is a
|
|
@link LinkTitles\\Special special page @endlink that provides web-access (by
|
|
default restricted to sysops). The other is a @link LinkTitles\\Cli
|
|
maintenance script @endlink that can be called from the command line if you
|
|
have access to your server and are authorized to run php from the command
|
|
line.
|
|
|
|
@note The source code that is referenced in this documentation may not
|
|
necessarily reflect the latest code in the repository! Make sure to check
|
|
out the Git repository for the latest code.
|
|
|
|
|
|
A note on the publication of the source code documentation
|
|
----------------------------------------------------------
|
|
|
|
The documentation is automatically generated from the source code by
|
|
[Doxygen][]. A special branch of the Git repository, [`gh-pages`][gh-pages],
|
|
was created that holds the [GitHub project pages][github-pages]. To make use
|
|
of the project page facility provided by GitHub, the root directory of a
|
|
repository needs to be [erased][gh-erase] first before content is added.
|
|
Since this would remove the source code from which the documentation is
|
|
generated, deleting all files in the root directory while on the `gh-pages`
|
|
branch was not feasible.
|
|
|
|
The solution was to pull down the `gh-pages` branch as a submodule into an
|
|
empty `gh-pages\` subdirectory:
|
|
|
|
~~~~{.sh}
|
|
git submodule add -b gh-pages git@github.com:bovender/LinkTitles.git gh-pages
|
|
~~~~
|
|
|
|
This command tells git-submodule to only pull down the `gh-pages` branch as
|
|
a submodule -- we don't need to pull down the master branch into the same
|
|
repository again.
|
|
|
|
|
|
[source code]: http://github.com/bovender/LinkTitles
|
|
[LinkTitles]: http://www.mediawiki.org/wiki/Extension:LinkTitles
|
|
[MediaWiki]: http://www.mediawiki.org
|
|
[Doxygen]: http://www.doxygen.org
|
|
[github-pages]: https://pages.github.com/
|
|
[gh-pages]: https://github.com/bovender/LinkTitles/tree/gh-pages
|
|
[gh-erase]: https://help.github.com/articles/creating-project-pages-manually#create-a-gh-pages-branch
|