LDraw.org Official Parts Library Standards: Header META Commands

[Orion Pobursky]

Next up for discussion Header META Commands:
https://library.ldraw.org/documentation/...a-commands

[Willy Tschager]

Next up for discussion Header META Commands:
https://library.ldraw.org/documentation/...a-commands

0 Brick  2 x  4
0 Brick  1 x 10 (Note the lack of a leading space on the 2 digit number)
0 Brick  3.1 x  3.1
0 Brick 10.1 x  2.4 (Note the lack of a leading space on the 2 digit number)
0 Brick  3 x  3 x  0.34 (Note the 2 decimal places)

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

- such as Brick 2 x 6

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

0 !LICENSE Marked with CC0 1.0 : see CAreadme.txt

No part in the library comes with this license. Could you please explain (tough I have an idea what's behind - and I very welcome in). However it is missing in the Header Format at the top.

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

Colours are limited to the colour numbers of the colours defined in the Colour Definition Reference - LDConfig.ldr However, it also needs a link to the color specs.

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

I would also add "Depreciated" to Physical Colour and the outdated licenses in the Header Format at the top. Just to make it clearer.

w.

[Orion Pobursky]

No part in the library comes with this license. Could you please explain (tough I have an idea what's behind - and I very welcome in). However it is missing in the Header Format at the top.

The only real reason is that support for CC0 is not yet implemented in the library. I've had higher priority projects

All other corrections are made.

Great Feedback.

[Roland Melkert]

Typo:

for clarity, the blockquote format for requirements will used sparingly.

for clarity, the blockquote format for requirements will be used sparingly.

Maybe frame the meta 'source' so it's bit more clear in regards of the follow-up text.

If the file is not in the parts or p folder, the folder shall be included with a separator of '/'. For example 's/3001s01.dat' or '48/4-4cyli.dat'.

When did the slash become the default? I thought the backslash was the preferred separator given the dos background? At the very least the document should be consistent (there are backslashes used too).


my 2cts

[N. W. Perry]

I would also add "Depreciated" to Physical Colour and the outdated licenses in the Header Format at the top. Just to make it clearer.

The correct term is probably always going to be "deprecated".

deprecated: officially made obsolete, though still usable ("It's an older code, sir, but it checks out. I was about to clear them.")
depreciated: lost monetary value over time (like a used car)

[Orion Pobursky]

When did the slash become the default? I thought the backslash was the preferred separator given the dos background? At the very least the document should be consistent (there are backslashes used too).

This was a typo. '\' was intended.  This is fixed and the other feedback incorporated.

[Peter Blomberg]

My biggest concern is that the 'LDraw file specs' references the 'Official Library Header Specification' (in stead of declaring each possible official META command) and that the 'Header META Commands' seem to replace part of the 'Official Library Header Specification'. Furthermore, the two latter are not written in the same box-requirement style as displayed on the introduction page.

In my opinion, the 'LDraw file specification' should introduce each official META command and their allowed syntaxes similar to the line types.

Subsequently, the 'Official Library Header Specification'/'Header META commands' can then focus on the requirements such as the order of meta commands and the content tokens within those commands.

'Part Header' should be 'File Header' since it applies to any file, not just part files.

Requirement: "META commands in the file header must appear in this order: part description, name, author, LDRAW_ORG, LICENSE, HELP, BFC, CATEGORY, KEYWORDS, CMDLINE, PREVIEW, and HISTORY."

Requirement: "No other commands are allowed in the header."

Requirement: "There must not be multiple part description, name, author, LDRAW_ORG, LICENSE, BFC, or PREVIEW META commands."
There may be multiple HELP, CATEGORY, KEYWORDS, and HISTORY meta commands.

Requirement: "Part description, name, author, LDRAW_ORG, LICENSE, BFC, and CATEGORY are mandatory."
HELP, KEYWORDS, CMDLINE, PREVIEW and HISTORY may be required in some cases.

Requirement: "All new and edited files must be licensed under CC BY 4.0."

Requirement: "All new and edited files must conform to BFC CCW."

Requirement: "!LDRAW_ORG types Part, Shortcut, Unofficial_Part, and Unofficial_Shortcut are required to have a valid !CATEGORY line"

Requirement: "The categories must be one or more from the following list: <insert list of approved categories here>"

Requirement: "The person token on HISTORY lines must be either {RealName} or [UserName]."