Create a documentation for your project in the backend.
Latest Release
Development Branch
- Composer key:
mzeis/mzeis_documentation
- Version: 1.0.0 (unreleased)
- Extension on GitHub
- Magento >= CE 1.9.1 (may also work in other versions)
- Install the extension using Composer or modman. The extension cannot be found on packages.firegento.com but will be added once stable.
- Remove the files.
- Remove the following database tables:
- mzeis_documentation_page
- Remove all entries in database table
core_config_data
starting withpath
admin/mzeis_documentation/
.
Navigate to System > Documentation
. Start editing the homepage of the
documentation by clicking the Edit
button.
###Permissions
You can define permissions for viewing, editing and deleting pages per admin user role (menu item
System > Permissions > Users
, resource System > Documentation
).
###Configuration The configuration for this extension can be found in `System > Configuration > Advanced
Admin
. Alternatively you also can click on the link
Configuration` in the documentation menu.
####Set another page as the documentation homepage By default, the documentation homepage is "Home". If you want to set another page as the homepage, enter the name in `System > Configuration > Advanced
Admin > Documentation > Homepage`.
###Editing a page
Go to System > Documentation
, view any documentation page and click the Edit
button
in the right top corner of the screen.
In the edit form, you can add content using the WYSIWYG editor.
You can insert images, variables and widgets. Note that widgets won't always display successfully since you are viewing the page in the backend and not in the frontend which most widgets are made for.
###Renaming a page
When viewing a page, click the Rename
button in the top right corner. Choose a unique page name.
The links to the page will be renamed accordingly.
###Creating a new page You create a new page by editing an existing page and adding a documentation link in this format:
[[My new page]]
After saving, you will see a link to the page My new page
. When you click on it you will be told
that there is no content for this page yet. Edit the new page to fill it with content.
###Searching You can search through the documentation by using the search form in the left top corner. The search searches for your term in the name and content of the documentation pages. The search results are returned in an alphabetical manner.
###Showing all pages
Click on the documentation menu link All pages
to get an overview over all pages.
###Orphan pages
It might happen that an existing pages isn't linked to anymore by any other pages when these
pages are changed. The documentation menu link Orphan pages
will show you all pages without
links pointing at them.
If you have any issues with this extension, please create an issue on GitHub. Please provide error messages, debug information like output from the Magento error logs and the exact steps / code to reproduce the issue.
Any contribution is highly appreciated. The best way to contribute code is to
open a pull request on GitHub.
Always create pull requests against the dev
branch.
Matthias Zeis (matthias-zeis.com, @mzeis)
(c) 2015 Matthias Zeis