[LSC] Call For Votes: Proposed changes to the LDraw part header to support the CA - Version 7

Thu Sep 7 16:54:01 EDT 2006

I re re vote YES...
  ----- Original Message ----- 
  From: Travis Cobbs 
  To: LDraw Standards Committee 
  Sent: Wednesday, September 06, 2006 7:51 PM
  Subject: [Norton AntiSpam] [LSC] Call For Votes: Proposed changes to the LDraw part header to support the CA - Version 7

  If you've already read version 6, the only differences are the wrapped history lines, and the note that you must choose one of the existing categories in the category statement; you can't make up new ones.

  I think all the open issues have now been discussed, so I'm making a call for votes on the below version of the proposed changes.  I'll submit my vote in a reply to this message. 

  Proposed changes to the LDraw part header to support the Contributor Agreement - Version 7

  The following shortcomings in the current LDraw part header require
  attention to support the Contributor Agreement : 

  a)    The author line fails to identify the LDraw.org username – the basis upon which CA affirmation is assessed.
  b)    The header does not identify whether the part is covered by the Contributor Agreement or not. 
  c)    The change history comment lines are unstructured and fail to clearly identify the LDraw.org username.
  d)    The header does not conform to the new meta command syntax. (Only acceptable to partially correct this.) 
  e)    The header fails to clearly identify unofficial parts.
  f)    The header fails to clearly separate the header section from the file content. (Removed by Travis based on Steve's advice.  We can of course change our mind on this.) 

  The proposed new structure for official parts is :

  -------------------Beginning of Proposal-------------------

  0 PartDescription
  0 Name: Filename.dat
  0 Author: RealName [UserName]
  0 !LDRAW_ORG Part|Subpart|Primitive|48_Primitive UPDATE YYYY-RR 

  0 !LICENSE Redistributable under CCAL version 2.0 : see CAreadme.txt or
  0 !LICENSE Not redistributable : see NonCAreadme.txt

  0 !HELP Optional free text description of file usage 
  0 !HELP Second row after user's line break to simulate paragraph

  0 BFC ( CERTIFY ( CCW | CW ) | NOCERTIFY )

  0 !CATEGORY Category name
  0 !KEYWORDS words, more words,…,
  0 !KEYWORDS words in second row, …, final words 

  0 !CMDLINE LDraw run-time command(s)

  0 !HISTORY YYYY-MM-DD [UserName] Free text description of change. This can wrap to a
  0 !HISTORY YYYY-MM-DD [UserName] second row with the same date if necessary.
  or
  0 !HISTORY YYYY-MM-DD {RealName} Free text description of change 

  0 // Comments
  1 <colour> x y z a b c d e f g h i <file>

  Where
  PartDescription is the descriptive name of the part (limited to 64 characters)
  Filename is the file name
  RealName is the author's real name 
  UserName is the author's LDraw username. It needs to be optional for those past authors that don't have a PT username
  YYYY-RR is the LDraw update year and release within year
  The square brackets are included in the file to indicate LDraw usernames. 

  The following meta-commands are optional:
  !HELP
  !CMDLINE
  BFC (It is highly recommended to include this statement with a NOCERTIFY for non-BFC certified parts, but not required.)
  !KEYWORDS
  !CATEGORY (This is required if the first word of the part description isn't in the offical category list here: http://www.ldraw.org/article/340.  Note, however, that you must use one of the listed categories.)

  All other meta-commands above are mandatory.  No other meta-commands are allowed in the part header.

  For example:

  0 Animal Scorpion
  0 Name: 30169.dat
  0 Author: Chris Dee [cwdee]
  0 !LDRAW_ORG Part UPDATE 2006-01 
  0 !LICENSE Redistributable under CCAL version 2.0 : see CAreadme.txt

  0 !HELP Obviously there is no need for additional
  0 !HELP information in this part. But it will give
  0 !HELP you an idea of the primitive formatting. 
  0 !HELP
  0 !HELP And probably we should limit the length of
  0 !HELP a line to 40 – 50 characters for the sake of readability.

  0 BFC CERTIFY CW

  0 !CATEGORY Animal
  0 !KEYWORDS Sting, Poison, Adventurers, Egypt 
  0 !KEYWORDS Zodiac

  0 !CMDLINE –c1

  0 !HISTORY 2000-08-?? {Axel Poque} fixes to resolve L3P error messages
  0 !HISTORY 2000-08-?? {Manfred Moolhuysen} fixes to resolve L3P error messages,
  0 !HISTORY 2000-08-?? {Manfred Moolhuysen} fixed gap where body meets head 
  0 !HISTORY 2002-04-25 [PTadmin] Official update 2002-02
  0 !HISTORY 2004-05-18 [guyvivan] Made BFC compliant
  0 !HISTORY 2004-05-18 [guyvivan] Use more primitive
  0 !HISTORY 2006-??-?? [PTadmin] Official update 2006-01 

  0 // Tail
  1 16 1 0 23 1 0 0 0 1 0 0 0 1 4-4cyli.dat

  or

  0 Boat Base  8 x 10
  0 Name: 2622.dat
  0 Author: Chris Alano
  0 !LDRAW_ORG Part UPDATE 2000-02
  0 !LICENSE Not redistributable : see NonCAreadme.txt

  0 BFC NOCERTIFY

  0 !KEYWORDS Pirates, Caribbean, Ship

  2 24 100 24 80 80 24 20

  -------------------End of Proposal-------------------

  --Travis

------------------------------------------------------------------------------

  _______________________________________________
  LSC mailing list
  LSC at ldraw.org
  http://five.pairlist.net/mailman/listinfo/lsc
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://five.pairlist.net/pipermail/lsc/attachments/20060907/78ab3438/attachment.htm