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
As part of our meeting last year in Billund, we expressed a desired to make the learning curve for authoring parts a little less steep. As part of that, I'm working on clarifying the rules for the Official Library. Recently we've had a discussion about complete assemblies and disallowing sticker shortcuts for stickers applied to single, flat parts. As a result of those discussion, I made a draft revision to the File Format Restrictions for the Official Library. Proposed changes in red:
https://www.ldraw.org/hidden-content/dra...brary.html

I also posted about my concerns about documentation fragmentation. I personally feel that the File Format Restrictions for the Official Library document should one single source for all the rules for parts in the official library. With that reasoning in mind, I think "Official Library Policy On Embedding POV-Ray Code" should be cancelled since those METAs are already disallowed. Also, the "Parts numbering scheme for parts with unknown numbers" and "Official Library Specification for Sticker Parts" should be folded into the main document. There are also some pages on the PT that can be added as well.

Basically, I'm opening the entire "File Format Restrictions for the Official Library" document up for revision. How should this document be laid out? What else should be included? I have the ability to separate sections in to tabs and other formatting tricks. I also think a downloadable PDF for quick, offline reference might be a good idea. Maybe even a Quick Reference One Sheet for commonly used info.

I'd like to have a full and frank discussion about this. Remember, if you have a problem, propose a solution. Also, we're not going to break backwards compatibility. Aside from those 2 rules almost anything goes.
(2020-05-28, 21:48)Orion Pobursky Wrote: [ -> ]Also, the "Parts numbering scheme for parts with unknown numbers" and "Official Library Specification for Sticker Parts" should be folded into the main document. There are also some pages on the PT that can be added as well.

Fine with this.

(2020-05-28, 21:48)Orion Pobursky Wrote: [ -> ]Basically, I'm opening the entire "File Format Restrictions for the Official Library" document up for revision. How should this document be laid out? What else should be included? I have the ability to separate sections in to tabs and other formatting tricks. I also think a downloadable PDF for quick, offline reference might be a good idea. Maybe even a Quick Reference One Sheet for commonly used info.

No tabs. Would just be the same thing in blue. I'd say one long document with a content table at the top or side as it is now.

w.
Nice work on the sticker format rules, see I need to do some re-work on formed stickers Smile

What about sticker sheets with more than 26 stickers? Continue with aa, ab, ac etc?
I agree with Willy, just wanted to add to the numbering scheme, that we should add also the patterned part references.

Edit:

Section Duplicates:


Identical lines of type 1, 2, 3, 4 and 5 are not permitted.

The order of end points is not considered when checking for identical lines of line types 2 and 5.

The ordering of vertex points for triangles and quads is not considered when checking for identical polygons (line types 3 and 4).

Control points are not considered when checking for identical conditional lines, line type 5

Section Overlapping:
Overlapping Cond-Lines are not permitted, however this is sometimes unavoidable when e.g. two cylinder sections are joined as the condlines are present in the sub-files.
IMHO this also speak against complementary cond-lines that we need.

Section Colors:
This part along with the two sub-items shall be removed as it is outdated:
"There are two cases where use of colour 16 for lines is acceptable:"
Using Lines (type 2) to simulate patterns or grip lines shall not be allowed.

Assemblies:
I think we shall add two samples

May be also add samples here for dual-molded parts or marbled injections?

Unknown Parts:
Shall this still refer to Peeron.com?
Blanks in description
One thing that is a constant issue for newbies at the PT is the blank in the front of numbers in the description and I couldn't find the specs for it. (This would obviously go into header).

T-Junk
https://wiki.ldraw.org/wiki/T-Junction

Category
https://www.ldraw.org/article/340.html could be integrated into https://www.ldraw.org/article/398.html

Parts that are assemblies
The description on the PT is much clearer and should be copied over from: https://www.ldraw.org/library/tracker/ref/numberfaq/

Sticker numbers
Same applies for sticker numbers: https://www.ldraw.org/library/tracker/ref/numberfaq/ which should be integrated with Sticker Parts Standard
(2020-05-29, 19:25)Evert-Jan Boer Wrote: [ -> ]What about sticker sheets with more than 26 stickers? Continue with aa, ab, ac etc?

If there are stickers with mirror image versions, then I suggest using a letter-number suffix for the mirror image pairs for example, a1, a2. This may help to keep within the 26 alpha characters - see here for a specific example. Then aa, ab, et seq.
(2020-05-28, 21:48)Orion Pobursky Wrote: [ -> ]As part of our meeting last year in Billund, we expressed a desired to make the learning curve for authoring parts a little less steep. As part of that, I'm working on clarifying the rules for the Official Library. Recently we've had a discussion about complete assemblies and disallowing sticker shortcuts for stickers applied to single, flat parts. As a result of those discussion, I made a draft revision to the File Format Restrictions for the Official Library. Proposed changes in red:
https://www.ldraw.org/hidden-content/dra...brary.html

I also posted about my concerns about documentation fragmentation. I personally feel that the File Format Restrictions for the Official Library document should one single source for all the rules for parts in the official library. With that reasoning in mind, I think "Official Library Policy On Embedding POV-Ray Code" should be cancelled since those METAs are already disallowed. Also, the "Parts numbering scheme for parts with unknown numbers" and "Official Library Specification for Sticker Parts" should be folded into the main document. There are also some pages on the PT that can be added as well.

Basically, I'm opening the entire "File Format Restrictions for the Official Library" document up for revision. How should this document be laid out? What else should be included? I have the ability to separate sections in to tabs and other formatting tricks. I also think a downloadable PDF for quick, offline reference might be a good idea. Maybe even a Quick Reference One Sheet for commonly used info.

I'd like to have a full and frank discussion about this. Remember, if you have a problem, propose a solution. Also, we're not going to break backwards compatibility. Aside from those 2 rules almost anything goes.

I would prefer to separate the rules about the content of the files from those about naming the files.
(2020-05-30, 17:39)Chris Dee Wrote: [ -> ]I would prefer to separate the rules about the content of the files from those about naming the files.

That's fair a request. I'm in the middle of reformatting the document. It'll be fairly easy to peel off that part into a new document once the text is finalized and ratified.
We need to work on this:
https://www.ldraw.org/hidden-content/dra...unknownnum

Now that Peeron is in legacy mode, we should remove references to it.
(2020-05-30, 7:24)Willy Tschager Wrote: [ -> ]T-Junk
https://wiki.ldraw.org/wiki/T-Junction

T-Junctions are already disallowed (in most cases) in the base spec.
Pages: 1 2 3 4 5 6 7