LDraw.org Discussion Forums

Full Version: Official Library File Format Restictions
You're currently viewing a stripped down version of our content. View the full version with proper formatting.
Pages: 1 2 3 4 5 6 7
I want to remove this paragraph completely. We don't follow it consistently and it really is no value added:

Quote:  The word (Complete), parenthesis included, should placed at the end of the part
  description name for all shortcuts.
  Use 'Shortcut' when the file is provided for convenience of use
  (example: Minifig files like <979.dat).
  Use 'Complete' when the file represents a composite part, as purchased
  (example: Shock Absorber, 75348.dat).
  [Notice that neither of the example files follow this shortcut/complete standard,
  and the minifig file doesn't follow the file-naming standard,
  either.]
(2020-06-05, 19:15)Orion Pobursky Wrote: [ -> ]I think we need to rename this document. How about:

Official Library Part Guidelines

or

Official Library Policies and Procedures

Any other thoughts on this?
(2020-06-06, 14:07)Willy Tschager Wrote: [ -> ]What I'm talking about is this:

https://forums.ldraw.org/thread-23171.html

and:

https://forums.ldraw.org/thread-23089.html

I think as for sticker, we should somehow formalize them. We have
  • Sheet Cardboard
  • Sheet Fabric
  • Sheet Plastic
As category but nothing about proper naming and we still have:

https://www.ldraw.org/cgi-bin/ptscan.cgi...escription
https://www.ldraw.org/cgi-bin/ptscan.cgi...escription
https://www.ldraw.org/cgi-bin/ptscan.cgi...escription

all over the library along with:

https://www.ldraw.org/cgi-bin/ptscan.cgi...escription

w.

I've added some text about flexible parts under the appropriately named "Flexible Parts" section.
More edits:

I renamed the document to LDraw.org Official Library Specifications
I read through the entire document and reformatted/rewrite for clarity
I added the sticker shortcut stuff that was previously discussed in private forum
I added more of flexible parts

I'm sure I forgot some suggestions. Please read and comment. 

I think we're in the end game. Let's knock this out.
I have some comments on this.

Quote:While both upper and lower case letters are permitted in filenames, filenames are case-insensitive. Currently, all official parts are issued with upper-case only names.

I dont understand this:  "all official parts are issued with upper-case only names."

 AFAIK there are no files in the library with a upper case file ending.
Some dat-files may contain references to primitives using .DAT as a file ending, but it is considered an error and are auto-corrected by LDPE, if you tell it to do that, changing the ending to lower case .dat.
DATHeader ignore this, and accept a file using .DAT in the code.
In some files there is a comment about the use of .DAT on stud primitves to please LEdit. I have ignored that and change any old file I edit and replace .DAT with .dat.

I think it needs a clarification.


Quote:All files in the LDraw Parts Library are required to carry the .DAT extension.

Same here. What is this wording trying to explain? Why .DAT? Why upper case?


Quote:[*]The shortcut may not include more than one part, although that part may be a composite part (one with a "c" in the filename).
[*]The shortcut may not be a flat sticker on the flat surface of the part unless unless that surface is not parallel with one of the 3 cardinal ...

We have lots of composite parts without the "c" in the filename.
"Unless" is duplicated in the second sentence.


Quote:0 !KEYWORDS Set 10442-1, Bricklink 973pb0042

The suffix "-1" on set numbers are not needed, unless there are more than one known sets with the same set number.
(2020-06-18, 8:52)Magnus Forsberg Wrote: [ -> ]
Quote:While both upper and lower case letters are permitted in filenames, filenames are case-insensitive. Currently, all official parts are issued with upper-case only names.

I dont understand this:  "all official parts are issued with upper-case only names."

 AFAIK there are no files in the library with a upper case file ending.
Some dat-files may contain references to primitives using .DAT as a file ending, but it is considered an error and are auto-corrected by LDPE, if you tell it to do that, changing the ending to lower case .dat.
DATHeader ignore this, and accept a file using .DAT in the code.
In some files there is a comment about the use of .DAT on stud primitves to please LEdit. I have ignored that and change any old file I edit and replace .DAT with .dat.

I think it needs a clarification.

I agree. Unless I am misunderstanding, complete.zip has for a long time used all lower case letters for 8.3 files. So, the files are actually all lower case, not all upper case. The parts with longer filenames also use all lower case letters, as far as I know. I personally feel that this should be required for parts.


(2020-06-18, 8:52)Magnus Forsberg Wrote: [ -> ]
Quote:All files in the LDraw Parts Library are required to carry the .DAT extension.

Same here. What is this wording trying to explain? Why .DAT? Why upper case?

I have two things to say here. First, now that textures are allowed, I think it should specify "All part files", not "All files". Secondly, whether this is .DAT or .dat will depend on whether or not the "all upper case" text is change. I think that goes without saying, though.
So is the consensus all lower case? Ive confirmed that is the de-facto way we a doing things. 

I'll make the change on the dat extension.
(2020-06-18, 20:19)Orion Pobursky Wrote: [ -> ]So is the consensus all lower case? Ive confirmed that is the de-facto way we a doing things. 

I'll make the change on the dat extension.

Given that the actual files all have lower case names, and in all cases but 2 they reference each other with lower case names, I definitely feel that the document should indicate this.

FYI, the 2 DAT instances are as follows:

Code:
ldraw travis$ find . -name \*.dat -exec grep -H DAT$ {} \;
./parts/6567c01.dat:1 47 0 0 0 1 0 0 0 1 0 0 0 1 s\6567s01.DAT
./parts/6567c02.dat:1 40 0 0 0 1 0 0 0 1 0 0 0 1 s\6567s01.DAT
(2020-06-19, 1:42)Travis Cobbs Wrote: [ -> ]Given that the actual files all have lower case names, and in all cases but 2 they reference each other with lower case names, I definitely feel that the document should indicate this.

FYI, the 2 DAT instances are as follows:

Code:
ldraw travis$ find . -name \*.dat -exec grep -H DAT$ {} \;
./parts/6567c01.dat:1 47 0 0 0 1 0 0 0 1 0 0 0 1 s\6567s01.DAT
./parts/6567c02.dat:1 40 0 0 0 1 0 0 0 1 0 0 0 1 s\6567s01.DAT

Just to confirm the parts library is published with all lower-case file names. There are way more than 2 examples of upper-case usage on type 1 lines in the official library. Some even have mixed case (e.g. 6104).

I have a vague recollection that in the days of ldraw.exe upper-case STUD.DAT (or maybe all primitive) references on type 1 lines had a special meaning, but cannot remember what. It might have been to do with over-riding lo-res substitution in fast render mode.
I made the change to required all lower case. This involve removing the option for A-Z from the allowed characters and changing the note at the end of the paragraph. 

I also changed the extension portion and added a section about texture files.
Pages: 1 2 3 4 5 6 7