[Ldraw-content] Proposed change to LDraw part file header to
support the CA - Version4
LDraw
ldraw at holly-wood.it
Thu Aug 24 05:48:16 EDT 2006
dear LSC members,
looks like that functioning as secretary suits me. based on the
discussion about version 3 I updated the document accordingly. the
changes are:
* removed pre-character ! from BFC statement as the majority of the LSC
is against this.
* added the HELP meta-statement in response of steve's statement that
there is already a comment for file usage in the header (beside that I
feel strongly about ;-):
http://five.pairlist.net/pipermail/lsc/2006-August/000470.html
the format is based on the partial discussion in April 2005:
http://five.pairlist.net/pipermail/lsc/2005-April/000342.html
* added END-OF-HEADER meta-statement. I deducted from the discussion
that there is a need for. please cancel is altogether if you feel that I
misinterpret the mood within the lsc.
* reordered sequence
the word document containing all the formating can be found at:
www.holly-wood.it/tmp/CAheaderV4.doc
one last thing. please correct me if I'm wrong but the PartDescription
is currently limited to 64 characters which surely helps to keep the
description readable, but is nonsens when it comes to subparts 'cos
sometimes you have to cut out pieces to get it submitted to the PT. a
title like this is not possible:
~Slope Brick 33 3 x 6 with Classic Space Large Pattern - Gold Detail
please consider to cancel the limitation altogether.
w.
Proposed changes to the LDraw part header to support the Contributor
Agreement - Version 4
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 is not conform to the new meta command syntax
e) The header fails to clearly identify unofficial parts
f) The header fails to clearly separate the header section from the file
content
The proposed new structure for official parts is :
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 !OTHER STANDARD META-STATEMENTS
0 !HISTORY YYYY-MM-DD [UserName] Free text description of change
0 // Second row simulating formatting
or
0 !HISTORY YYYY-MM-DD {RealName} Free text description of change
0 !END-OF-HEADER
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
and the square brackets are included in the file to indicate LDraw
usernames.
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 // 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 !END-OF-HEADER
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 !CATEGORY Boat
0 !KEYWORDS Pirates, Caribbean, Ship
2 24 100 24 80 80 24 20
I’d also like the release process to automatically add lines to this
when a part is made official – at present it is unclear which changes
are included in which version of the file.
I also propose to add full headers to the ~Moved to files and other
admin generated files with a special name / username, probably “PTadmin”.
As Travis pointed out the header fails to clearly identify if the file
is a part, especially when they are at the PT. I therefore suggest to
modify the !LDRAW_ORG statement for PT-usage only as following:
0 !LDRAW_ORG Unofficial_Part| Unofficial_Subpart| Unofficial_Primitive
|Unofficial_48_Primitive
A syntax like "Unofficial Part", "Subpart_unofficial",
"Unofficial_Element", "Non-official Part" would be rejected by the PT.
0 !HISTORY 2006-05-22 [PTadmin] Initial version
0 !HISTORY 2006-08-01 [PTadmin] Official update 2006-02
0 !HISTORY 2006-08-22 [Holly-Wood] Sum up of the current discussion,
added unofficial statement,
0 !HISTORY 2006-08-22 [Holly-Wood] added exclamation mark, added
keywords and category, made BFC compliant
0 !HISTORY 2006-08-23 [Holly-Wood] version 4. removed pre-character !
from BFC statement, added HELP meta-
0 //
statement, added END-OF-HEADER meta-statement
More information about the Ldraw-content
mailing list