Hi Guys, I got lyx running, so I can adapt the original pjal manual and regenerate the pdf. It still looks a bit magic to me, but it works...
IMO the documentation issue can be largly reduced if we update this document.The major tasks here are: - Update the chapters 'language definition' and 'compiler' to meet the current version of the jal compiler and update all examples to be jallib compliant. - redo all of the 'libraries' chapter: - things like 'PIC definition library structure' and 'Making JAL 2.0 to recognize your own PIC device' can be moved to an appendix, since Rob handles this for everybody. - make one or two sections for the use of the device files, use of digital io etc. - add a section for each lib we concider 'common'. Each section should explain the library with examples (so kind of combination of the api doc and the samples). To do this will be a huge task and I am prepared to take a major part on me, writing text, examples etc. But I can't do this without your help. You need to provide text (like the principles of jallib, principles and scope of the device files etc), read what I create and correct it etc. Early this year this had not the required priority so I put it aside. Is this still the case (and are there more important issues to spend our time on) or should we all start working on this now? Joep 2009/1/1 Joep Suijs <[email protected]>: > Hi, > > First of all, I'd like to whish all of you a happy 2009! > > About you message: > The docs you mention provide most of the info: language definition, > compiler info, base libraries, samples. > Together with a bit of history, experience with programming > (preferable with embedded systems) and some testing, you will get > there. > > My point is that these are a lot of sources you have to combine. The > jalv2 html manual, for instance, does not mention conditional compile. > And it does not cover any libraries. > But to answer you question: I seem to be the only one so I don't > intend to work on the manual but spend my time on my other projects > (until next week - then i'll probably run out of time again ;) > > As an alternative for documentation, it could be an idea to create a > main page (on the net or within the distribution) that has a link to > all major sources: > - jalv2 html manual > - jallib reference > - jal(lib) blog > - examples (it would be nice if they where browseable, but probably > hard to get a decent indent in html..) > - jaledit > - deployment (bootloaders, wisp648, xwisp2 etc). > > > Btw: the links in the table of content in the jalv2 html manual don't > work on my computer (both on firefox and IE). Do they work for you? > If not, how (and who) to fix this? > > Joep > > > 2009/1/1, Sebastien Lelong <[email protected]>: >> Hi Joep, >> >> Just a follow-up on this. I don't know if you still want to update this >> manual, but looking at jalv2 html manual (see compiler/JalV2-manual.html) it >> seems there's quite nice information here. Maybe a combination of this + all >> txt files (jalpragm.txt, etc...) would be "enough" to provide a full, >> exhaustive documentation about jalv2 ? >> >> Now my question is: why 90 pages ?... Isn't this more a book, than a >> documentation on jalv2 ? Ala Bert's book ? >> >> >> Seb >> >> 2008/12/20 Joep Suijs <[email protected]> >> >> > >> > Hi all, >> > >> > I mentioned the pjal documentation, a 90-page document of 2 years ago, >> > a few times on the jallist. >> > As far as I know it is the only document that explains JAL full and in >> > detail and the only issue is that it is not maintained. >> > However, I don't see any response on this matter which makes me wonder >> > if it is only me who would like such a manual? I'm even concidering to >> > adapt it to the current version myself, instead of working on jallib. >> > But... i'm new to lyx so that will take a lot of time. And I can do >> > the typing on my own, but need people to provide feedback on what >> > should be changed / added, to verify what I have written and translate >> > it into English. >> > In addition to this, we should update all examples to jallib and could >> > add basics of jallib. >> > >> > But before I decide to work on this, I'd like to have your view on this >> matter. >> > >> > Joep >> > >> > >> > >> >> >> >> -- >> Sébastien Lelong >> http://www.sirloon.net >> http://sirbot.org >> >> >> >> > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "jallib" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/jallib?hl=en -~----------~----~----~----~------~----~------~--~---
