PHPackages mapbender/documentation - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. mapbender/documentation ActiveLibrary[Utility & Helpers](/categories/utility) mapbender/documentation ======================= Mapbender documentation v4.1.3(1y ago)73.9k24[11 issues](https://github.com/mapbender/mapbender-documentation/issues)[1 PRs](https://github.com/mapbender/mapbender-documentation/pulls)MITPython Since May 5Pushed 3mo ago18 watchersCompare [ Source](https://github.com/mapbender/mapbender-documentation)[ Packagist](https://packagist.org/packages/mapbender/documentation)[ RSS](/packages/mapbender-documentation/feed)WikiDiscussions main Synced 2d ago READMEChangelog (10)DependenciesVersions (18)Used By (0) Mapbender Documentation ======================= [](#mapbender-documentation) This is the repository of the Mapbender documentation. You can find compiled pages of the latest [tagged releases](https://github.com/mapbender/mapbender-documentation/releases) on the [official documentation landing page](https://doc.mapbender.org/). Other versions of the documentation are also available on the same page under [Older Versions](https://doc.mapbender.org/#older-versions). The website code is generated using [Sphinx](https://sphinx-doc.org/), the documentation is written in [Restructured Text](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html). The documentation source code is available on [Github](https://github.com/mapbender/mapbender-documentation). Prerequisites ------------- [](#prerequisites) To build the website locally, you need to install Sphinx first. Install it and the required extensions in Debian-based distributions with: ``` sudo apt install sphinx-common python3-sphinx sudo apt install python3-sphinxcontrib.phpdomain sudo apt install python3-sphinx-rtd-theme sudo apt install python3-sphinx-notfound-page sudo apt install python3-sphinx-copybutton ``` You will then be able to build the documentation by running: ``` make ``` How to build ------------ [](#how-to-build) Alternatively, clone the repository from GitHub to any directory: ``` cd /data git clone git@github.com:mapbender/mapbender-documentation cd mapbender-documentation git checkout master ``` Then, build a tagged version with: ``` sphinx-build . _build -A version=4.0 ``` Now, create a symlink from your build folder to the Apache Webserver: ``` ln -s /data/mapbender-documentation/_build/ /var/www/html/mb-doc ``` Finally, you can open the documentation in a web browser using: If you want to rebuild the documentation, delete the old build first: ``` rm -rf _build ``` How to participate ------------------ [](#how-to-participate) To contribute to the documentation, first create a fork of this repository, then implement your changes in it and finally test the changes on your local machine. ``` cd /mapbender-documentation/en/elements/basic # In your forked repo, let's assume that you want to create a docs page that is part of the Mapbender CoreBundle. Switch to the folder where you want to put your file. cp overview.rst basic/add_wms.rst # Create an .rst file. In this example, we copy the overview.rst as a template for the new documentation file. # Write the documentation. Keep it short and simple. Use the structure of the document and check the documentation rules below. sphinx-build . _build -A version=4.0 # Build the documentation locally to see what your documentation looks like. Adjust the version number (optional). ln -s /data/mapbender-documentation/_build/ /var/www/html/mb-doc # Create a symlink from your Sphinx build folder to your Apache web server to test the documentation locally. ``` Now, take a look at the documentation in your browser. Is everything OK? Are any changes needed? If not, you can create a pull request to add your reviewed changes to the documentation. How to write ------------ [](#how-to-write) Here are some basic conventions for writing documentation. ### Formatting syntax [](#formatting-syntax) We implement the basic .rst formatting syntax in the Mapbender documentation. It is documented in detail on the [Sphinx page](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#rst-primer). For inline markup, the aim is to comply with the following syntax: - One asterisk for file names (*README.md*), - two asterisks for text quoted directly from Mapbender, e.g. feature names or button labels (**Save**), - backquotes for (file) paths (`figures/sketch.png`), - double backquotes for inline code (`bin/console mapbender:security:migrate-from-acl`), For several lines of code, we use code blocks. ``` .. code-block:: ``` Moreover, we use formatting blocks to add important information to the documentation. ``` .. hint:: This is a small hint. .. note:: This is an important note. .. tip:: This is a handy tip. .. warning:: This is a warning. ``` Referencing syntax ------------------ [](#referencing-syntax) Here are some basic conventions for referencing images and headings. ### Referencing images [](#referencing-images) Images for the documentation are available in `mapbender-documentation/figures`. - Create optimized web images in .png file format that are approximately 1 MB (or smaller) in size. - For elements, use *elementname.png* and *elementname\_configuration.png* as names. - If you also provide German image files, please keep the names and create two more images in the `de` folder. - See the [Quickstart](en/quickstart.rst) file to see image referencing methods in action. ### Referencing text [](#referencing-text) Each .rst file has its own tag that you can refer to. Use `:ref:` and the tag in the first line of the corresponding file to refer to another page in the documentation, e.g.: ``` :ref:`overview_de` points to the German page of the overview map. ``` For referencing specific documentation sections, we use the [Sphinx Autosectionlabel extension](https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html). It allows to reference sections using its title. The syntax is a combination of the file path name, a colon and the section title name. For example, you can add a link to the *Install Mapbender* section of the Quickstart document like this: ``` The following class refers to the :ref:`en/quickstart:Install Mapbender` text section. ``` ### Languages [](#languages) The two fully supported languages (i.e.: en - English, de - German) should have the same file structure: ``` /mapbender-documentation index.rst # refers to the different languages /figures # images that are included in the documentation /de # German file locations ... /en # English file locations index.rst # refers to TheBook, Developer's Book & the Bundle Documentation bundles.rst # lists the chapters of this category - refers to rst files development.rst # lists the chapters of this category - refers to rst files /architecture /development .... /elements /backend /basic .... ``` Have fun! ### Health Score 47 — FairBetter than 93% of packages Maintenance48 Moderate activity, may be stable Popularity27 Limited adoption so far Community33 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~494 days Recently: every ~622 days Total 7 Last Release 374d ago Major Versions v3.2 → v4.0.02025-01-30 ### Community Maintainers ![](https://www.gravatar.com/avatar/e93698c8e1784f88100eab35a186fab222bcbb5dc805d52f36cb6c459fa4743c?d=identicon)[werrolf](/maintainers/werrolf) ![](https://www.gravatar.com/avatar/0154eb5bdfa738d2bbc95bb345ba5f971d9395a2318f8724e42fa3bd384ae9c2?d=identicon)[LazerTiberius](/maintainers/LazerTiberius) ![](https://www.gravatar.com/avatar/edc576f86046edb0015945a3a3d25416817641cf746711c59574662cc7b9a791?d=identicon)[Phocacius](/maintainers/Phocacius) ![](https://www.gravatar.com/avatar/ebb4ec9ae68f36a1f5a3fd3b71b42a4029484a70e5f4c59bb7fb76b09f0d9e6e?d=identicon)[astroidex](/maintainers/astroidex) ![](https://www.gravatar.com/avatar/477770124fbda6af8025e087fcf19d606bd95f9c4322f9b53035fb617117300f?d=identicon)[AxxL](/maintainers/AxxL) --- Top Contributors [![rschwammborn](https://avatars.githubusercontent.com/u/21199730?v=4)](https://github.com/rschwammborn "rschwammborn (664 commits)")[![astroidex](https://avatars.githubusercontent.com/u/996298?v=4)](https://github.com/astroidex "astroidex (599 commits)")[![AxxL](https://avatars.githubusercontent.com/u/2235393?v=4)](https://github.com/AxxL "AxxL (430 commits)")[![fhaefker](https://avatars.githubusercontent.com/u/26274210?v=4)](https://github.com/fhaefker "fhaefker (165 commits)")[![eschuerg](https://avatars.githubusercontent.com/u/46448870?v=4)](https://github.com/eschuerg "eschuerg (150 commits)")[![kartoffelfee](https://avatars.githubusercontent.com/u/31849670?v=4)](https://github.com/kartoffelfee "kartoffelfee (92 commits)")[![wirkus](https://avatars.githubusercontent.com/u/2026210?v=4)](https://github.com/wirkus "wirkus (91 commits)")[![thzanger](https://avatars.githubusercontent.com/u/67112568?v=4)](https://github.com/thzanger "thzanger (78 commits)")[![pwheregroup](https://avatars.githubusercontent.com/u/25791018?v=4)](https://github.com/pwheregroup "pwheregroup (75 commits)")[![CharlyUnicorn](https://avatars.githubusercontent.com/u/13517141?v=4)](https://github.com/CharlyUnicorn "CharlyUnicorn (74 commits)")[![nmoelkner](https://avatars.githubusercontent.com/u/28730583?v=4)](https://github.com/nmoelkner "nmoelkner (49 commits)")[![psch](https://avatars.githubusercontent.com/u/1265495?v=4)](https://github.com/psch "psch (32 commits)")[![werrolf](https://avatars.githubusercontent.com/u/24895932?v=4)](https://github.com/werrolf "werrolf (14 commits)")[![swinkelmann](https://avatars.githubusercontent.com/u/3600745?v=4)](https://github.com/swinkelmann "swinkelmann (13 commits)")[![marmancs](https://avatars.githubusercontent.com/u/984349?v=4)](https://github.com/marmancs "marmancs (13 commits)")[![eSlider](https://avatars.githubusercontent.com/u/1188335?v=4)](https://github.com/eSlider "eSlider (12 commits)")[![adawuda](https://avatars.githubusercontent.com/u/84370170?v=4)](https://github.com/adawuda "adawuda (8 commits)")[![a12e24](https://avatars.githubusercontent.com/u/167756429?v=4)](https://github.com/a12e24 "a12e24 (6 commits)")[![jmckenna](https://avatars.githubusercontent.com/u/1611709?v=4)](https://github.com/jmckenna "jmckenna (5 commits)")[![lbromen](https://avatars.githubusercontent.com/u/57358199?v=4)](https://github.com/lbromen "lbromen (5 commits)") --- Tags geolocationgeoportalgeospatialgismapbenderpythonrstsphinxweb-clientdocumentationmapbender ### Embed Badge ![Health badge](/badges/mapbender-documentation/health.svg) ``` [![Health](https://phpackages.com/badges/mapbender-documentation/health.svg)](https://phpackages.com/packages/mapbender-documentation) ``` ### Alternatives [genericmilk/docudoodle Generate documentation for your Laravel application using OpenAI 15433.6k](/packages/genericmilk-docudoodle)[mapbender/mapbender Mapbender library 10418.0k8](/packages/mapbender-mapbender)[codelicia/xulieta Xulieta is a light php binary that lint documentation snippets 6713.7k5](/packages/codelicia-xulieta)[doxphp/doxphp Dox for PHP, inspired by Dox for JavaScript. 503.2k2](/packages/doxphp-doxphp) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)