Stand-alone documentation for Tag & Module Help

Discussion of the documentation project.
Locked
tedinoz

Stand-alone documentation for Tag & Module Help

Post by tedinoz »

I'm new here, Hopefully this isn't off topic, please say so if it is.

I was getting pretty frustrated jumping back & forth to the on-line help for the various modules and tags. So much so that I have cut-and-paste the Help into a Word document and converted to PDF (complete with formatting and bookmarks).

At some stage in the future, there will have to be local help files - it is just unworkabe to repeatedly have to refer to the wiki or elsewhere on the web to look something up.

Anyway, I would willingly share the PDF document except that it is 186KB (zipped) and I'm too tired to think of another way to get it to the forum (which has a 128KB limit - for good reasons I'm sure). Perhaps, if you want a copy, you should post a reply here and we'll figure something out. If anyone wants the Word doc (instead of or as well) - no problewm; reply also thru the forum.

Regards

Ted
tsw
Power Poster
Power Poster
Posts: 1408
Joined: Tue Dec 13, 2005 10:50 pm

Re: Stand-alone documentation for Tag & Module Help

Post by tsw »

There is local documentation (although it is more of a brief explanation of all paramaters) for modules and tags, look in extensions -> modules and click "help" for one of the modules you have installed

If I remember correctly wiki has a export to pdf function builtin...
cyberman

Re: Stand-alone documentation for Tag & Module Help

Post by cyberman »

tedinoz wrote: I was getting pretty frustrated jumping back & forth to the on-line help for the various modules and tags. So much so that I have cut-and-paste the Help into a Word document and converted to PDF (complete with formatting and bookmarks).
But you should think about too that there are a lot language files which has the help inside - and pdf files can't IMHO reworked / translated in a online translation center.
it is 186KB (zipped)
Have you think about international translations ? On CMSms there are 20 translation projects. Only your file with all translations needs more than 3 MB. It's much more than the whole CMS  :).
tsw wrote: There is local documentation (although it is more of a brief explanation of all paramaters) for modules and tags, look in extensions -> modules and click "help" for one of the modules you have installed
But it's a nice idea to open help section in a new window or better a function to make a help pdf  :) ...
Locked

Return to “[locked] Documentation0ld”