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 Mapbender documentation repository.
You can find the compiled pages of the latest released version at https://doc.mapbender.org/. Other versions of the documentation are also available at https://docs.mapbender.org/.
The sources are on Github.
The website code is generated using Sphinx, therefore the documentation source is written in Restructured Text.
To build the website locally, you need to install Sphinx first. Install it in Debian-based distributions via
You can then build the documentation by running:
How to build the documentation
How to participate in the documentation
To participate in the documentation, create a fork and submit a pull request with your changes. In your fork, write new content, e.g.:
Now, take a look at the documentation page in your browser. Is everything ok? Are any changes needed? If not, you can create a pull request to add your reviewed changes into the documentation.
Rules
Below you'll find some basic conventions about documentation writing.
Crosslinks
Create crosslinks to refer to another documentation page with a label. Labels that refer to a page are always in the first line of the file. Feel free to add labels above headings, if you want to refer to these instead.
Add the crosslink to your documentation text section like this:
Note that German labels always use the _de suffix.
Images (figures)
Images for the documentation are located at mapbender-documentation/figures
- Create images with size 800 x 600px
- Have a look at quickstart.rst to learn about image referring
- For elements, use elementname.png and elementname_configuration.png as name. If you also provide german image files, please keep the names and create two more images in the de folder.
Languages
The two fully supported languages (i.e.: en - english, de - german) should have the same file structure, that is:
Have fun!
