You can write any plans, questions here (or anywhere, and link from here). It is also common (but not a requirement) to join irc ( ChatViaIrc ) when working on the manual.

<code>

export CVSROOT=:ext:<your sourceforge username>@cvs.sourceforge.net:/cvsroot/megasquirtavr

</code>

The new storage location of the manual is

<code>

svn co https://svn.x-dsl.hu/svn/manual

</code>

See SubVersionSvn (instead of GenBoard/FirmWare/CVSUsage).

* cure the CGI wrapper, so we can trigger sourceforge from a distant wget to generate the manual. I prefer this, having 2 instances of the generated manual seems to be little overhead with some gains. Might just take changing system("/home/groups/m/me/megasquirtavr/bin/daily_snapshot.sh"); to an exec() function.

* s/oldURL/newURL/

** tweak wiki engine (php)

** tweak wiki mysql database

** tweak wiki mysql database dump sql-text (that is to be loaded back of course)

I tried to update the sourceforge html manual, no luck so far:

* the http://vems.hu/manual/ uses different html filenames, http://vems.hu/manual/html/ch09.html instead of http://megasquirtavr.sourceforge.net/manualhtml/Detailed.Sensor.RPM.html

* on sourceforge, /home/users/m/ma/marcell/megasquirtavr I copied

** manual dir (the dir with the generated html from the vems.hu server) - svn tree should do

* edited bin/generate_html_manual.sh , similar to bin/daily_snapshot.sh but without checking out from CVS. Checking out from SVN should work too,

** but first it should be able to generate HTML with proper filenames.

Should be simple to solve, with some more attention.

Contact one of the maintainers or use a simple text editor and send diffs for reviewing.

*How do I contact one of the "maintainers" if I am interested in filling in some of the missing info? I would be more comfortable to make a wiki page that I can temporarily dump stuff in with a link to the manual page and the text to insert if someone would want to take it, check it and make it part of the manual. I have very basic computer skills(never done any web page type stuff, I am a quick learner though) but I can handle the wiki quite comfortably.

EricN gt40eric at yahoo dot com

MembersPage/PhatBob I've emailed you, and look forward to working with you

Now the XML manual is as easy to work with as word:

but without the serious maintenance (locking, diffing, efficient storage of revisions) and presentation problems of the previous MS Word doc format.

Note that the tree-browsing view on the left shows the proper names (id-s) of sections now. There are some guidelines in CVS manual/design/guidelines.txt but nothing too complex.

In any case, ask for help here or ListsAndForums genboard-dev list if you have problems.

* [Morphon] and [Morphon XML editor free download]

I edited a few lines of the manual in Morphon.

* first Morphon complained about syntax

* the diff became huge, 7429 lines (with -U3). Mostly removed linebreaks (that were added for readibility, I assume?), but who knows ? I didn't dare to commit it, I applied it again (it's mostly about EC36pin28 for the HALL supply +5V, rev172)

What is the recommended method for editing ? Should we make it Morphon compatible or it does not worth the effort ?

Generated HTML manual is getting useful for human consumption. Errors that should be corrected by now:

* formatting is broken (many wiki text copypasted without taking care about formatting). Check wt2db experiments below.

* pages unified: not possible to link into a small paragraph (eg. when making index for something)

* many broken links

If you think you can help fix either (maybe just running xsltproc command with the right arguments on sourceforge) please help.

Note that everyone with RW access to CVS

* has ssh access to shell.sourceforge.net with his username/pw

* take care about permissions: everything should be read-writable by anyone in the megasquirtavr group (chmod -R g+rw dir)