Download the PHP package mapbender/documentation without Composer
On this page you can find all versions of the php package mapbender/documentation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mapbender/documentation
More information about mapbender/documentation
Files in mapbender/documentation
Package documentation
Short Description Mapbender documentation
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package documentation
Mapbender Documentation
This is the repository of the Mapbender documentation.
You can find compiled pages of the latest tagged releases on the official documentation landing page. Other versions of the documentation are also available on the same page under Older Versions.
The website code is generated using Sphinx, the documentation is written in Restructured Text.
The documentation source code is available on Github.
Prerequisites
To build the website locally, you need to install Sphinx first. Install it and the required extensions in Debian-based distributions with:
You will then be able to build the documentation by running:
How to build
Alternatively, clone the repository from GitHub to any directory:
Then, build a tagged version with:
Now, create a symlink from your build folder to the Apache Webserver:
Finally, you can open the documentation in a web browser using:
If you want to rebuild the documentation, delete the old build first:
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.
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
Here are some basic conventions for writing documentation.
Formatting syntax
We implement the basic .rst formatting syntax in the Mapbender documentation. It is documented in detail on the Sphinx page.
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.
Moreover, we use formatting blocks to add important information to the documentation.
Referencing syntax
Here are some basic conventions for referencing images and headings.
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
defolder. - See the Quickstart file to see image referencing methods in action.
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.:
For referencing specific documentation sections, we use the Sphinx Autosectionlabel extension. 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:
Languages
The two fully supported languages (i.e.: en - English, de - German) should have the same file structure:
Have fun!
