New Module: Documentation
Development and Programming
This is a simple module that does lets you display the contents of a directory inside the control panel, and link to it by creating a new control panel tab. A client of mine needed some documentation on how to use the site, and I wanted to make it easily accessible.
There is an accompanying extension that lets you set the directory in which your documentation resides. The module itself just displays the contents of said directory. For example, I set my directory to /path/to/my/site/documentation, and the module looks for an index.php file within that directory. From there you can do anything you want.
http://brianlitzinger.com/assets/downloads/ee/documentation_1.1.zip
Thanks! Certainly looks more professional than using the Bulletin Board.
I’ve installed it and tossed in a few different pages. I noticed “index.php” works, “index.html” doesn’t. Also, I guess it would be helpful to note that the CSS on the page is overridden by the control panel CSS. I haven’t tried linking to other pages within the directory. Does the content have to be contained within one page? Certainly doable, just want to know what the restrictions are. I’m assuming this would also use the scripts loaded in the control panel.
I defaulted it to index.php, so you can use the $site_url variable in your page, and so you can use any other PHP to include a navigation to link to other documentation pages. I’m only using one page, but I’m guessing that if you want multiple pages you’ll need to append the CP url (C=modules&M=Documentation) to each nav link, and possibly add your own parameter, e.g C=modules&M=Documentation&DocPage=foo. It’s just doing file include with the output buffer… so any PHP is acceptable within your index.php file.
And yes, it will inherit the CP styles. I had to create a small <style> block at the top of my page to tweak some things.
Good to know. I’ll just use jquery dynamic includes or tabs if need be. :coolsmile:
Bug fix. v1.1 is available for download at the URL in the original post.
Can I use an EE template for my documentation? I’d rather not FTP as i’ll be changing it a lot.
No, it’s just setup to read an index.php file with HTML. $site_url is available in the index file so you can include images or documents with a proper link.
Can I use an EE template for my documentation? I’d rather not FTP as i’ll be changing it a lot.
You can always up a ‘read only’ weblog and calling it documentation…but then you would loose this module’s ease of use.
Is this module retired?
It isn’t retired. I haven’t used it or heard much feedback on it in a long time and kind of forgot about it :D
I added the download link back to the original post.
I still use it. It was mentioned in the latest EE Podcast so you may have more interest. I’ve attached a screenshot of it in use. I’ve set it up with tabs from jQuery Tools to make it easier to navigate.