Vincent.. Are the docs in a form that can easily be edited off-line -- possibly in something like Word or similar? I'm looking though the SJS manual and found several typos that I could fix if that's OK with you -- I was thinking I could just send you an updated set of docs but am not sure if that's the best way, etc.. I did notice that you were asking for some help for us native english speakers and I don't mind if I'm going to be reading them anyway.. Just thought I'd ask..
-- Rick
Your help is definitely welcome.
There are several sources that are merged to compose the SJS docs :
- Docbook sources (that are easily edited using a wysiwyg tool like XMLmind). Since SJS is not in a public repo, I attach the docbook sources to this post. Docbook is XML based, you can also fix typos directly using a simple text editor if you know what sentence you're looking for.
- Custom plaintext format source (self explainatory) : also attached to the post.
Don't hesitate to attach the modified files (or a patch) to the post or even better, attach them to a new Mantis enhancement request. I will then merge them back asap.
Thanks!
Vincent
| Attachment | Size |
|---|---|
| sjs-docbook-manual.zip | 71.91 KB |
| sjs-text-reference.zip | 32.27 KB |
Thanks Vincent.. I'm initially going to work only on the SJS material to fix various typos and language use that I noticed in a few places. I may expand a few places if that's OK with you by adding some examples where some are missing,etc.
For the main reference manual, I think it might be a good idea to split the doc up as it stands today -- pull out the sample application section and put that into a quick-start guide of sorts along with perhaps a new section on creating an empty Jspresso project to help people (like me) that perhaps do not work in Java day-in, day-out and may not be 100% familiar with all of the tools at their disposal,etc.. I find that latter part of the JSpresso reference manual (chapter II and beyond) has a much different "feel" to it than chapter 1 does which is why I think it might be a good idea to break them into two separate docs -- one that goes over the basics of Jspresso (sample projects, features, benefits) and leave the real reference material in the other doc for those more advanced users that are ready to just dive right in..
One more thing -- if you visit the documentation page and hover over the name of the first two PDF document links (jspresso reference and SJS reference), they're call the same thing "reference-guide.pdf". If someone wants to download both of them they will need to rename one of them to ensure they don't overwrite the first one downloaded as most people will probably put both documents into the same folder -- it would probably be a good idea to rename them to be "SJS-Reference-Guide.pdf" and "Jspresso-Reference-Guide.pdf" or similar.
Thanks!
Thank you very much for your valuable inputs, Rick.
We are definitely looking for fixes/suggestions like these. I will create some Mantis tasks to make sure that we don't foget them.
Best,
Vincent
Can I attach my doc updates to that task as well when the time comes? Also, would it be possible to get the files associated with the regular Jspresso manual at some point (not necessarily today)? I'll see about working on both as I'm learning things and doing the associated lookups.. Thanks!
Hi Rick,
The Jspresso manual is made of 2 different things :
I already had opened this Mantis task to track the documentation updates. You should be able to attach doc updates to this task. You can log-in to Mantis with your Jspresso.org account.
Thanks again and enjoy !
Vincent
