Re: Web based documentation
To All: I will be away on Vacation from July 18th returning on July 22nd. You can address your issues with the following persons in my absence: All Web and Hosting Related issues contact Jeff Kirkland at [EMAIL PROTECTED] All Technical issues please contact Ben Consaul at [EMAIL PROTECTED] If you should require immediate Technical assistance please call the TSG help desk at 888-429-4114 or 603-429-4114 Thank you and God Bless, -Eric ___ gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss
Re: Web based documentation
Is there anyway we can kick off people that put vacation reply stuff onto shared email lists? Thanks. On 7/22/05, Eric J. Pfeier <[EMAIL PROTECTED]> wrote: > To All: I will be away on Vacation from July 18th returning on July 22nd. > You can address your issues with the following persons in my absence: All > Web and Hosting Related issues contact Jeff Kirkland at > [EMAIL PROTECTED] All Technical issues please contact Ben Consaul > at [EMAIL PROTECTED] If you should require immediate Technical > assistance please call the TSG help desk at 888-429-4114 or 603-429-4114 > Thank you and God Bless, -Eric > ___ > gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org > http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss ___ gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss
Re: Web based documentation
On Fri, Jul 22, 2005 at 11:24:36AM -0400, Cole Tuininga wrote: > > * CVS compatibility - If we're working on a big upgrade for the project > that will involve lots of documentation changes, I'd like to be able to > write the documentation before hand and deploy it at the same time we > deploy the software updates. We use Twiki for our internal documentation. I'm not an expert in either CVS or Wikis, but Twiki does use RCS for storing its files in the back end. -Mark signature.asc Description: Digital signature
Re: Web based documentation
TikiWiki (http://tikiwiki.org/) could give you the pluggable authentication and control that you are looking for with integrated versioning capabilities and browser-friendly output (in fact many output options) I'm not sure whether it will match your requirements exactly, and I haven't been following the project for a while so you'll just have to check it out to get the current features. Another project that I used a bit more recently was Seagull(http://seagull.phpkitchen.com/). Seagull is an Object-Oriented PHP framework, with excellent documentation, and leverages the packages in PEAR. Although intended to be a framework first, it does include some nifty capabilities in the area of permissions, authentication and content management including documentation. One of the neat features that I liked about it was that if you structured your documents, you could actually output a pdf of the whole collection such that you could publish a 'print version' too. For support, this would be a possible revenue stream: free access to the online version one page at a time, searchable and easily navigable. And if you want to have a print copy around, to read offline, purchase the printed copy almost on demand. ___ gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss
Re: Web based documentation
On Jul 22, 2005, at 11:24 AM, Cole Tuininga wrote: I'm looking for some suggestions (general or specific) with regards to web based software system for doing documentation. Cole: It sounds like you are looking for something closer to a CMS or a publishing system rather than something collaborative like a wiki. I spotted this review in InfoWorld last week, on an open source, xml based CMS. No personal experience, but the IW folks thought pretty highly of it: Article here: http://www.infoworld.com/article/05/07/11/28TCxmlcm_1.html?CONTENT% 20MANAGEMENT And software here: http://cocoondev.org/daisy/index.html ___ gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss
Re: Web based documentation
I'll give another shout of support for TWiki. It supports all the authentication you're looking for in terms of read and write privileges, connecting to any PAM authentication mechanism. It's not CVS compatible, but uses RCS instead, so if you're only saying CVS so that you have revision histories, then it's just as good. No one has had any trouble with Firefox or IE. It's a good system with tons of 3rd party plugins and themes and stuff too. -N ___ gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss
Re: Web based documentation
Cole Tuininga <[EMAIL PROTECTED]> writes: > I'm looking for some suggestions (general or specific) with regards to > web based software system for doing documentation. The short story is > that we have an in-house web based software project that we want to > finally provide documentation for. The basic requirements/wishlist goes > something like this: > > * Must be configurable to require authentication to read it. > - A plus: pluggable authentication so the current user database could > be used. > - A plus: If the requirement for authentication before hand could be > on a page by page basis. In other words, some pages (or > areas) would require it, others not. > > * Must have separate permissions for reading/writing documentation. > - A plus: If this was on a page/area basis. > > * CVS compatibility - If we're working on a big upgrade for the project > that will involve lots of documentation changes, I'd like to be able to > write the documentation before hand and deploy it at the same time we > deploy the software updates. > > * Web based - needs to support "normal" browsers. This is not exactly what you're looking for, however, I've become so addicted to it, this seems a good time to plug this nifty emacs extension :) emacs-wiki is a series of emacs modules which allow you to essentially create a wiki from flat, text files within emacs. Since everything is text file, version control is simple. If everyone is using a text editor, emacs or vi, then placing the source files within something like CVS, SVN, ARCH, etc, is a no-brainer. Or, a NFS mounted directory. The big win comes if using emacs, since the mode with auto-create new page names just by selecting the WikiWord (though WikiWords are not required for pages, emacs-wiki supports normal filenames, as well as spaces in filenames). Additionally, the mode has the ability to publish the content in various forms: html, pdf, ps, etc. Which fulfills your requirement for the ability to view the content in "normal browsers" :) Since the original docs are just files, you can separate the permissions of read vs write. There are even modules which can be added to provide authentication using a Mason framework. There's a pretty active emacs-wiki mailing list, and you can almost always find someone on #emacs who uses emacs-wiki, or it's eventual replacement muse-mode, as well as planner-mode, an emacs-based PIM built on top of either emacs-wiki or muse. I don't have a URL handy, but I'm sure if you search http://www.emacswiki.org forg emacs-wiki under the HyperMedia category, you'll find it. Googling would be good too, google for 'emacs-wiki' and 'sacha' (she's one of the maintainers). While I don't expect this to be what you're looking for, I hope I've at least piqued the interest of someone here :) -- Seeya, Paul ___ gnhlug-discuss mailing list gnhlug-discuss@mail.gnhlug.org http://mail.gnhlug.org/mailman/listinfo/gnhlug-discuss
