Skip to content
jpgerdeman edited this page Jul 24, 2012 · 1 revision

#RFC 00003 - Naming ##Overview A coherent naming scheme will make automatic processing easier and will allow people to determine the contents of a file.

##Motivation Though we have spoken of naming schemes before, we have never put it in the wiki. Also some of us need a reminder from time to time ;)

Automatic generation of our github pages has shown that the naming schemes used vary and sometimes are overly long. Through a more concide and hopefully clearer naming scheme we may achieve extra goodness for github pages, as well as for people reading the names.

##Proposal Currently we have the following two standards:

A tlg-segment is added in the name. Parts of the name are delimeted by a dot. Empty spaces are replace by underscore. Valid names are NAME_OF_FIGURE.tlg.svg tlg.NAME_OF_FIGURE.svg

A partnumber-segment is added. Like before parts of a name are delimeted by a dot and space become underscores. But a part number, set number or part description is added as last segment to the name. Valid names from this scheme:

NAME_OF_PART.(LEGO SET NUMBER).svg
NAME_OF_PART.(LEGO PART NUMBER).svg 
NAME_OF_PART.(LEGO PART FROM THIS LINE).svg 

Let's standardize this by using the following scheme

NAME.ATTRIBUTES.(BRICKLINK PART NUMBER).svg

The following is already possible, but a common coherent naming scheme might bring more benefits.

During page generation the name can be split into sections. If present a tlg section is removed from the title and a tlg class is added to the generated HTML-markup. Also a section enclosed in parences is removed from the title, but the enclosed information is added as reference information. A tlg class is added to the generated HTML-markup as well. The reference information could be displayed underneath the title. The tlg class can be used to add a special format, like a Lego logo overlay, to the decal.

##Limitations The current naming schemes should be replaced by a new one, or in the very least not further altered.

Comments

jpgerdeman:

A common naming scheme is important of course. Knowing which exact part it belongs to is as well. But at the moment it is something that just adds hassle. We should leave it as is at the moment. Finding the Bricklink or Lego number takes time and how would you handle exclusives, etc.?

Clone this wiki locally