RE: [opendocument-users] Implementor notes

["Dennis E. Hamilton" <dennis.hamilton@acm.org>]

Hi Bart,

I was not thinking that the OIC's on-line Specification Analysis would be a
place for implementation notes or even linking to someone's
implementation-note details.

It seems to me that implementation notes need to be independently
authorable, versioned, annotated, etc., and their availability and content
should be under the authority of the respective implementer.    

 - Dennis

MORE THOUGHTS

My thinking is that the on-line OIC material be a resource that
independently-developed implementation notes can use to refer to the
deep-linkable version of the ODF specification along with its connection to
OIC analysis, conformance notes, interoperability cases, and test guidance.

I was not suggesting anything about how implementation notes would be made
available.  I imagined that independently-developed web-accessible ones
could tie to the OIC Specification Analysis and related material.  I'm sure
implementers will have their own ideas about the way they want to develop,
organize, and deliver any implementation notes, especially with
consideration of different releases, handling up- and down-level
accommodation of different ODF versions, etc. 

For any implementation notes that I make, I will use web pages that link to
the OIC material.  

In the absence of the on-line OIC material, now that I see how to organize
the material as an annotated hypertext document on the web, I would simply
do the same thing using web pages directly, with cross-references with the
accompanying implementation interpretations.  I imagine the result would be
similar to the Microsoft notes and annotations for the Office 2007
implementation of ODF, especially when made locally searchable in nice ways.
I'm not sure whether enabling comments at the individual implementation
topic is needed for my projects.  Fine-grained note-level commenting could
be provided using something like Disqus perhaps.

In many ways, using a web-authoring approach would permit direct tie-in with
source-code management and versioning support.  Much of the complexity of
bending MoinMoin to my will would be avoided.  Either way, there is probably
more that can be done with automated tools in the off-line authoring part of
the task.  (I would not use a database for presentation, but page-generation
might eventually be supported by a database in some way.  That is beyond my
current planning horizon.  I always find a manual technique that works first
and then see how to computer-aid the process once I have a good
understanding of what's needed.)

What I have learned about all of this so far is recounted at 
<http://wiki.oasis-open.org/oic/SpecAnalysis/Discussion>.

 - Dennis

Dennis E. Hamilton
------------------
NuovoDoc: Design for Document System Interoperability 
mailto:Dennis.Hamilton@acm.org | gsm:+1-206.779.9430 
http://NuovoDoc.com http://ODMA.info/dev/ http://nfoWorks.org 


-----Original Message-----
From: Hanssens Bart [mailto:Bart.Hanssens@fedict.be] 
http://lists.oasis-open.org/archives/opendocument-users/200906/msg00067.html
Sent: Thursday, June 18, 2009 01:30
To: dennis.hamilton@acm.org; 'Sander Marechal'
Cc: opendocument-users@lists.oasis-open.org
Subject: RE: [opendocument-users] Implementor notes

[ ... ]

But I'm not sure if it still scales if we have to maintain the links to
notes
(perhaps in several languages) and bug tracks of various products, as well
as general remarks etc. Or maybe that's just me dreaming of a perfect
world again :-)

[ ... ]


________________________________________
From: Dennis E. Hamilton [dennis.hamilton@acm.org]
http://lists.oasis-open.org/archives/opendocument-users/200906/msg00066.html
Sent: Thursday, June 18, 2009 12:50 AM
To: 'Sander Marechal'; Hanssens Bart
Cc: opendocument-users@lists.oasis-open.org
Subject: RE: [opendocument-users] Implementor notes

Sander, some additional information related to this thread:

 1. Something like this is being done on the OIC TC by putting the ODF 1.1
specification up on a Wiki.  Some initial fragments can be seen at
<http://wiki.oasis-open.org/oic/SpecAnalysis>.  The design is intended to
support linking to separate annotation pages that address matters of concern
to the ODF Interoperability and Conformance (OIC) TC.

[ ... ]

-----Original Message-----
From: Sander Marechal [mailto:s.marechal@jejik.com]
http://lists.oasis-open.org/archives/opendocument-users/200906/msg00064.html
Sent: Wednesday, June 17, 2009 15:23
To: Hanssens Bart
Cc: opendocument-users@lists.oasis-open.org
Subject: Re: [opendocument-users] Implementor notes

Hanssens Bart wrote:
http://lists.oasis-open.org/archives/opendocument-users/200906/msg00061.html
> Well, if OASIS publishes an XHTML version of the spec, with predictable
> anchors for every numbered section, every implementer could publish
> an Atom stream with a link to that particular section.

Yes, that is an excellent suggestion IMHO. Could the ODF interop TC help
with this? It seems like a very practical thing that doesn't add much
value to the standard by itself but which could really help developers
with interop.

Bonus points if the anchors are persistent over different ODF versions
when a certain element or section hasn't changed in the spec.

--
Sander Marechal

---------------------------------------------------------------------
To unsubscribe, e-mail: opendocument-users-unsubscribe@lists.oasis-open.org
For additional commands, e-mail:
opendocument-users-help@lists.oasis-open.org


---------------------------------------------------------------------
To unsubscribe, e-mail: opendocument-users-unsubscribe@lists.oasis-open.org
For additional commands, e-mail:
opendocument-users-help@lists.oasis-open.org