LISTSERV mailing list manager LISTSERV 16.5

Help for TEI-L Archives


TEI-L Archives

TEI-L Archives


TEI-L@LISTSERV.BROWN.EDU


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Proportional Font

LISTSERV Archives

LISTSERV Archives

TEI-L Home

TEI-L Home

TEI-L  June 2006

TEI-L June 2006

Subject:

Re: Authoring app information revisited

From:

Martin Holmes <[log in to unmask]>

Reply-To:

[log in to unmask]

Date:

Fri, 9 Jun 2006 11:47:28 -0700

Content-Type:

text/plain

Parts/Attachments:

Parts/Attachments

text/plain (350 lines)

Hi there,

I'm having real trouble figuring out how to create an ODD file that 
encapsulates the constraints of the model we've been discussing. Here's 
the current incarnation:

<appInfo xml:id="ImageMarkupTool1">
   <appDetail adType="appName">Image Markup Tool></appDetail>
   <appDetail adType="appVersion">1.0.3.5</appDetail>
   <appDetail adType="appURI">http://..../></appDetail>
   <appDetail adType="appDesc">Tool for annotating images using TEI with 
SVG</appDetail>
   <appDetail adType="lastSave"><date value="2006-10-01"/></appDetail>
   <appDetail adType="sectionsTouched">
     <ptr target="#sec1"/>
     <ptr target="#sec99"/>
   </appDetail>
</appInfo>

Working from the ODD files in the SourceForge SVN as examples, I think I 
have a formulation of the appInfo tag that's OK:

<elementSpec xmlns="http://www.tei-c.org/ns/1.0" module="appDesc" 
xml:id="APPINFO" ident="appInfo" mode="add">
     <equiv/>
     <gloss>application information</gloss>
     <desc>[...description snip...]</desc>
     <classes>
         <memberOf key="model.encodingPart"/>
	<memberOf key="att.declarable"/>
     </classes>
     <content>
         <rng:group xmlns:rng="http://relaxng.org/ns/structure/1.0">
         <rng:zeroOrMore>
             <rng:ref name="appDetail" />
         </rng:zeroOrMore>
             <rng:optional>
                 <rng:ref name="note" />
             </rng:optional>
         </rng:group>
         <attribute>
             <rng:ref xmlns:rng="http://relaxng.org/ns/structure/1.0" 
name="att.global.attribute.xmlid"/>
         </attribute>
     </content>
     <exemplum>
         <egXML xmlns="http://www.tei-c.org/ns/Examples">[snip...]</egXML>
     </exemplum>
</elementSpec>

Do I have the attribute specified correctly here? I want to specify that 
the standard xml:id attribute is required on this element.

When I come to the appDetail tag, it gets a bit harder. I want to 
specify co-occurrence constraints, such that:

-When adType="appURI", then content can only be a well-formed URI.

-When adType="lastSave", then content can only be a date tag.

-When adType="sectionsTouched", then content can only be a list of valid 
pointers to elements in the document.

-When adType is anything else, any text is allowed.

I've trawled around in the SVN for ages looking for examples of this 
kind of thing, but I just can't find anything that helps.

This is what I have so far -- please take a look and let me know what 
needs fixing:

<?xml version="1.0"?>
<TEI xmlns="http://www.tei-c.org/ns/1.0" xml:lang="en">
     <teiHeader>
         <fileDesc>
             <titleStmt>
                 <title>Application Information Module</title>
                 <author>Martin Holmes</author>
             </titleStmt>
             <publicationStmt>
                 <p>for use by whoever wants it</p>
             </publicationStmt>
             <sourceDesc>
                 <p>created on Friday 9th of June 2006</p>
             </sourceDesc>
         </fileDesc>
     </teiHeader>
     <text>
         <body>
             <moduleSpec xml:id="APPINFORMATION" ident="appinformation">
                 <altIdent>Application information for authoring/editing 
applications</altIdent>
                 <gloss>Additional elements for describing software 
applications which are used to author or edit TEI files.</gloss>

<elementSpec xmlns="http://www.tei-c.org/ns/1.0" module="appDesc" 
xml:id="APPINFO" ident="appInfo" mode="add">
     <equiv/>
     <gloss>application information</gloss>
     <desc>records information about an application which has edited the
         TEI file. Its main purposes are: 1) to allow an application to 
discover that it has
         previously opened/edited a file, and what version of itself was 
used to do that; 2) to                             show (through a date 
element) which application last edited the file to allow for
         diagnosis of any problems that might have been caused by that 
application; 3)
         to allow users to discover information about an application 
used to edit the file;
         4) to allow the application to "declare an interest" in 
elements of the file which it
         has edited, so that other applications or human editors may be 
more wary of
         making changes to those sections of the file.</desc>
     <classes>
         <memberOf key="model.encodingPart"/>
         <memberOf key="att.declarable"/>
     </classes>
     <content>
         <rng:group xmlns:rng="http://relaxng.org/ns/structure/1.0">
         <rng:zeroOrMore>
             <rng:ref name="appDetail" />
         </rng:zeroOrMore>
             <rng:optional>
                 <rng:ref name="note" />
             </rng:optional>
         </rng:group>
         <attribute>
             <rng:ref xmlns:rng="http://relaxng.org/ns/structure/1.0" 
name="att.global.attribute.xmlid"/>
         </attribute>
     </content>

     <exemplum>
         <egXML xmlns="http://www.tei-c.org/ns/Examples">
             <appInfo xml:id="ImageMarkupTool1">
                 <appDetail name="appName">Image Markup Tool></appDetail>
                 <appDetail name="appVersion">1.0.3.5</appDetail>
                 <appDetail 
name="appURI">http://www.tapor.uvic.ca/~mholmes/image_markup/</appDetail>
                 <appDetail name="appDesc">Tool for annotating images 
using TEI with SVG</appDetail>
                 <appDetail name="lastSave"><date 
value="2006-06-01"/></appDetail>
                 <appDetail name="sectionsTouched">
                     <ptr target="#sec1"/>
                     <ptr target="#sec99"/>
                 </appDetail>
             </appInfo>
         </egXML>
         <p>This example shows an appInfo tag describing an application 
called the Image Markup Tool, version 1.0.3.5, which has declared an 
interest in two sections of the file, and which last saved the file on 
June 6 2006.</p>
     </exemplum>
</elementSpec>

                 <elementSpec xmlns="http://www.tei-c.org/ns/1.0" 
xmlns:rng="http://relaxng.org/ns/structure/1.0" module="appDesc" 
ident="appDetail" xml:id="APPDETAIL">
                     <equiv/>
                     <gloss>detail about an authoring/editing 
application</gloss>
                     <desc>is used to provide information about specific 
attributes of the
                         editing application. It can have two 
configurations: in the first, it has only a adType
                         attribute with one of six values (appName, 
appVersion, appURI, appDesc, lastSave and
                         sectionsTouched), which specify known types of 
information about the application; in
                         the second, adType can be a user-defined text 
value. When adType="lastSave", the
                         tag content should be a date tag; when 
adType="sectionsTouched", it should be a list
                         of ptr elements; and when adType="appURI", the 
content should be a well-formed URI.
                         Otherwise, the content should be text.
                     </desc>
                     <classes>
                         <memberOf key="att.typed"/>
                         <memberOf key="model.glossLike"/>
                     </classes>
                     <content>
                         <rng:choice 
xmlns:rng="http://relaxng.org/ns/structure/1.0">
                             <rng:group>
                                 <oneOrMore>
                                     <rng:ref name="ptr" />
                                 </oneOrMore>
                             </rng:group>
                             <rng:group>
                                 <datatype><rng:ref name="data.pointer" 
/></datatype>
                             </rng:group>
                             <rng:group>
                                 <rng:ref name="date" />
                             </rng:group>
                             <rng:group>
                                 <rng:text/>
                             </rng:group>
                         </rng:choice>
                     </content>
                     <attList>
                         <attDef ident="adType" mode="add" usage="req">
                             <desc>indicates the type of application 
detail</desc>
                             <datatype>
                                 <text/>
                             </datatype>
                             <valList type="open">
                                 <valItem 
ident="appName"><gloss>human-readable name of the 
application</gloss></valItem>
                                 <valItem 
ident="appVersion"><gloss>application version (e.g. 
1.2.3.4)</gloss></valItem>
                                 <valItem ident="appURI"><gloss>URI of 
the application's download location or home page</gloss></valItem>
                                 <valItem 
ident="appDesc"><gloss>Description of the application</gloss></valItem>
                                 <valItem ident="lastSave"><gloss>The 
date and time at which the application last saved the file. When this 
value is used, the content of the appDetail tag should be a date 
element.</gloss></valItem>
                                 <valItem 
ident="sectionsTouched"><gloss>A list of identifiers pointing to 
elements in the file which the application has edited.</gloss></valItem>
                             </valList>
                             <defaultVal>#IMPLIED</defaultVal>
                         </attDef>
                     </attList>
                     <exemplum>
                         <egXML xmlns="http://www.tei-c.org/ns/Examples"/>
                         <p>See the example in the elementDesc for the 
appInfo tag.</p>
                     </exemplum>
                     <remarks>
                         <p>I haven't yet figured out how to encode the 
constraint relationships between the adType attribute values and the 
contents of the tag.</p>
                     </remarks>
                 </elementSpec>
</moduleSpec>
     </body>
     </text>
</TEI>

Cheers,
Martin





Martin Holmes wrote:
> Hi there,
> 
> Lou Burnard wrote:
>> Yes, I did start on the task last night but got swamped by other things
>> today. The great merit of using an ODD to represent your proposal (aside
>> from saving the editors work!) is that it does actually force you to
>> think about how your new components interact with the rest of what's
>> there.
>> It's also a lot easier, in my view. For example: you want <appInfo> to
>> appear inside <encodingDesc>. If you check the content of <encodingDesc>
>> as defined in P5, you will see that is defined by reference to the class
>> model.encodingPart. Ergo, to get your new element in there all you need
>> do is specify that it is a member of that class. Inside
>> elementSpec/classes you provide a <memberOf key="model.encodingPart"/>
>> and that's it. 
> 
> Will do. It does make sense to me now. I had been under the impression 
> that the RNG module files were the source from which the ODD stuff was 
> built, but it's obviously the other way round, as Sebastian explained....
> 
>> Looking more closely at the proposal last night I was also struck by the
>> fact that the proposed application seemed rather narrow in scope --
>> basically for an annotation tool to record in the header which bits of
>> the document it had processed when. Seems to me it might be more
>> TEI-like to generalise this: I had envisaged a general purpose element
>> which could be used by any application program to record whatever data
>> it wants, provided it can be constrained usefully as name-value pairs (a
>> bit like it's done in java, I understand)
>>
>> I'm also less and less convinced about the need for a global tools
>> attribute. If you just want to indicate within the document which parts
>> have been processed, I think that could be done by pointing from the
>> header:
>>
>> <appInfo tool="myWizBang">
>>   <appParam name="lastRun"><date value="2006-10-01"/></appParam>
>>   <appParam name="sectionsTouched"><ptr target="#sec1"/>
>>          <ptr target="#sec99"/></appParam>
>>   <appParam name="resultStatus">dismal failure</appParam>
>> </appInfo>
> 
> I've also been uneasy about this since the beginning, and I like this 
> suggestion much better. I'll reformulate based on this approach.
> 
> I also like the tag name appInfo, but I'm not sure about appParam; 
> appParam would suggest that it records input parameters fed to the app 
> through its command line, which isn't the case (or at least, that's not 
> how I envisage using it, although there's no reason why such data 
> shouldn't be stored in this tag). Perhaps a better name would be 
> appDetail. So we'd have something like this:
> 
> <appInfo xml:id="ImageMarkupTool1">
>   <appDetail name="appName">Image Markup Tool></appDetail>
>   <appDetail name="appVersion">1.0.3.5</appDetail>
>   <appDetail name="appURI">http://..../></appDetail>
>   <appDetail name="appDesc">Tool for annotating images using TEI with 
> SVG</appDetail>
>   <appDetail name="lastRun"><date value="2006-10-01"/></appDetail>
>   <appDetail name="sectionsTouched">
>     <ptr target="#sec1"/>
>     <ptr target="#sec99"/>
>   </appDetail>
> </appInfo>
> 
>> Alternatively, since this really is a processing matter of limited or no
>> interest in interchange, why not use a processing instruction?
>>
>> <?myWizBang wuz-ere 2006-10-01?>
> 
> I like this much less, because it's harder to constrain to well-formed 
> and predictable structures, and therefore much harder for applications 
> to learn about each other in a predictable way. I think there's a strong 
> case for a small formal element set. It's not just recording which bits 
> of the file it's touched; it's also recording, for the benefit of future 
> versions of itself, which version of itself last touched the file. This 
> will enable apps working on the same file to provide useful user 
> feedback, as we've discussed before. And the restrictive use of a single 
> xml:id for a major application version (<creatorApp xml:id="MyApp2">) 
> means that these tags can't proliferate much.
> 
> I'll make up an ODD file by the end of the week.
> 
> Cheers,
> Martin
> 

-- 
Martin Holmes
University of Victoria Humanities Computing and Media Centre
([log in to unmask])
Half-Baked Software, Inc.
([log in to unmask])
[log in to unmask]

Top of Message | Previous Page | Permalink

Advanced Options


Options

Log In

Log In

Get Password

Get Password


Search Archives

Search Archives


Subscribe or Unsubscribe

Subscribe or Unsubscribe


Archives

June 2019
May 2019
April 2019
March 2019
February 2019
January 2019
December 2018
November 2018
October 2018
September 2018
August 2018
July 2018
June 2018
May 2018
April 2018
March 2018
February 2018
January 2018
December 2017
November 2017
October 2017
September 2017
August 2017
July 2017
June 2017
May 2017
April 2017
March 2017
February 2017
January 2017
December 2016
November 2016
October 2016
September 2016
August 2016
July 2016
June 2016
May 2016
April 2016
March 2016
February 2016
January 2016
December 2015
November 2015
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
September 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012
November 2012
October 2012
September 2012
August 2012
July 2012
June 2012
May 2012
April 2012
March 2012
February 2012
January 2012
December 2011
November 2011
October 2011
September 2011
August 2011
July 2011
June 2011
May 2011
April 2011
March 2011
February 2011
January 2011
December 2010
November 2010
October 2010
September 2010
August 2010
July 2010
June 2010
May 2010
April 2010
March 2010
February 2010
January 2010
December 2009
November 2009
October 2009
September 2009
August 2009
July 2009
June 2009
May 2009
April 2009
March 2009
February 2009
January 2009
December 2008
November 2008
October 2008
September 2008
August 2008
July 2008
June 2008
May 2008
April 2008
March 2008
February 2008
January 2008
December 2007
November 2007
October 2007
September 2007
August 2007
July 2007
June 2007
May 2007
April 2007
March 2007
February 2007
January 2007
December 2006
November 2006
October 2006
September 2006
August 2006
July 2006
June 2006
May 2006
April 2006
March 2006
February 2006
January 2006
December 2005
November 2005
October 2005
September 2005
August 2005
July 2005
June 2005
May 2005
April 2005
March 2005
February 2005
January 2005
December 2004
November 2004
October 2004
September 2004
August 2004
July 2004
June 2004
May 2004
April 2004
March 2004
February 2004
January 2004
December 2003
November 2003
October 2003
September 2003
August 2003
July 2003
June 2003
May 2003
April 2003
March 2003
February 2003
January 2003
December 2002
November 2002
October 2002
September 2002
August 2002
July 2002
June 2002
May 2002
April 2002
March 2002
February 2002
January 2002
December 2001
November 2001
October 2001
September 2001
August 2001
July 2001
June 2001
May 2001
April 2001
March 2001
February 2001
January 2001
December 2000
November 2000
October 2000
September 2000
August 2000
July 2000
June 2000
May 2000
April 2000
March 2000
February 2000
January 2000
December 1999
November 1999
October 1999
September 1999
August 1999
July 1999
June 1999
May 1999
April 1999
March 1999
February 1999
January 1999
December 1998
November 1998
October 1998
September 1998
August 1998
July 1998
June 1998
May 1998
April 1998
March 1998
February 1998
January 1998
December 1997
November 1997
October 1997
September 1997
August 1997
July 1997
June 1997
May 1997
April 1997
March 1997
February 1997
January 1997
December 1996
November 1996
October 1996
September 1996
August 1996
July 1996
June 1996
May 1996
April 1996
March 1996
February 1996
January 1996
December 1995
November 1995
October 1995
September 1995
August 1995
July 1995
June 1995
May 1995
April 1995
March 1995
February 1995
January 1995
December 1994
November 1994
October 1994
September 1994
August 1994
July 1994
June 1994
May 1994
April 1994
March 1994
February 1994
January 1994
December 1993
November 1993
October 1993
September 1993
August 1993
July 1993
June 1993
May 1993
April 1993
March 1993
February 1993
January 1993
December 1992
November 1992
October 1992
September 1992
August 1992
July 1992
June 1992
May 1992
April 1992
March 1992
February 1992
January 1992
December 1991
November 1991
October 1991
September 1991
August 1991
July 1991
June 1991
May 1991
April 1991
March 1991
February 1991
January 1991
December 1990
November 1990
October 1990
September 1990
August 1990
July 1990
June 1990
April 1990
March 1990
February 1990
January 1990

ATOM RSS1 RSS2



LISTSERV.BROWN.EDU

CataList Email List Search Powered by the LISTSERV Email List Manager