[MOBY-dev] BioMOBY web doesn't contain documentation about serviceNotes and ProvisionInformation

[Frank Gibbons]

José María,

Part of the reason it was missing is that there was so little to say, until 
the Exception reporting RFC. From the 
moby-live/Docs/MOBY-S_API/MessageStructure.html documentation file:

"The serviceNotes block is only loosely defined in this version of the API, 
and is currently meant to contain human-readable freetext. serviceNotes are 
optional. "

That's pretty much all one could say until recently, so it's hard to find 
any mention of it unless you grep all the files. What are your plans for 
integrating the exception-reporting into the main codebase? Will it be Java 
first, Java only, or Perl? The Provision Information Block (PIB) is 
mentioned in ObjectStructure.html, again a one-liner.

As the code begins to reflect the implementation of the Exception-RFC, we 
should add documentation to reflect that.

Mark, there's also the question of how the website gets updated. The best 
way to do it in my view, would be to have the website updated nightly and 
automatically to reflect the documentation (both from static HTML) for the 
non-language-specific parts of the API, and also from the POD/javadoc in 
the language-specific parts. Seems like it shouldn't be too hard to run it 
from cron, nor take too long to run (perhaps we could even do it hourly, 
instead of daily?).

-Frank

At 01:25 PM 1/23/2006, you wrote:
>Thanks Eddie!
>
>         I have found where you told the documentation about
>ProvisionInformation (I didn't see it, I'm blind!) ...
>
>... but serviceNotes information is still missing.
>
>         Best Regards,
>                 José María
>
>Edward Kawas wrote:
> > Hi Jose Maria,
> >
> > The documentation is there, somewhere (I cant seem to connect to the site
> > right now ...).
> >
> > In the cvs, the file is ObjectStructure.html.
> >
> > Hope this helps,
> >
> > Eddie
> >
> >
> >>-----Original Message-----
> >>From: moby-dev-bounces at biomoby.org
> >>[mailto:moby-dev-bounces at biomoby.org] On Behalf Of José María
> >>Fernández
> >>Sent: Monday, January 23, 2006 8:19 AM
> >>To: mobydev
> >>Subject: [MOBY-dev] BioMOBY web doesn't contain documentation
> >>about serviceNotes and ProvisionInformation
> >>
> >>Hi everybody,
> >>      I have been browsing the developers documentation
> >>hanging on the (now not so) new BioMOBY web site, and I have
> >>realized that there is no information about serviceNotes and
> >>ProvisionInformation tags! Ye olde documentation contained
> >>that information (snif, snif).
> >>
> >>      Best Regards,
> >>              José María
> >>--
> >>José María Fernández González         e-mail: jmfernandez at cnb.uam.es
> >>Tlfn: (+34) 91 585 54 50              Fax:    (+34) 91 585 45 06
> >>Grupo de Diseño de Proteinas          Protein Design Group
> >>Centro Nacional de Biotecnología      National Center of Biotechnology
> >>C.P.: 28049                           Zip Code: 28049
> >>C/. Darwin nº 3 (Campus Cantoblanco, U. Autónoma), Madrid
> >>(Spain) _______________________________________________
> >>MOBY-dev mailing list
> >>MOBY-dev at biomoby.org
> >>http://biomoby.org/mailman/listinfo/moby-dev
> >
> >
> >
> > _______________________________________________
> > MOBY-dev mailing list
> > MOBY-dev at biomoby.org
> > http://biomoby.org/mailman/listinfo/moby-dev
> >
>
>--
>José María Fernández González           e-mail: jmfernandez at cnb.uam.es
>Tlfn:   (+34) 91 585 54 50              Fax:    (+34) 91 585 45 06
>Grupo de Diseño de Proteinas            Protein Design Group
>Centro Nacional de Biotecnología        National Center of Biotechnology
>C.P.: 28049                             Zip Code: 28049
>C/. Darwin nº 3 (Campus Cantoblanco, U. Autónoma), Madrid (Spain)
>_______________________________________________
>MOBY-dev mailing list
>MOBY-dev at biomoby.org
>http://biomoby.org/mailman/listinfo/moby-dev

PhD, Computational Biologist,
Harvard Medical School BCMP/SGM-322, 250 Longwood Ave, Boston MA 02115, USA.
Tel: 617-432-3555       Fax: 
617-432-3557       http://llama.med.harvard.edu/~fgibbons