Difference between revisions of "Help:Naming conventions"
From CanonBase
(Created page with "== Naming conventions documents == All documents are placed in a repositery that so they can be used in multiple places. Therefore we need to give a unique name that makes it...") |
|||
| Line 1: | Line 1: | ||
| − | == Naming conventions | + | == Naming conventions for files == |
| − | All documents are placed in | + | All files such as images or digital documents are placed in the Canon repository that so they can be used in multiple places in the database and elsewhere. Therefore we need to give each one a unique name that makes it possible to find it again. |
| − | * name has to be a title without spaces, therefore we use underscores to fill the spaces. | + | * the name has to be a title without spaces, therefore we use underscores to fill the spaces. |
| − | * the name can be given | + | * the name can be given during the file upload process, but it is easier to rename them in advance. |
=== Images === | === Images === | ||
| − | The | + | The principal idea is that image files should have a human recognisable file name that differentiates it from other files. |
* '''IMG1234''' is hard to read or understand | * '''IMG1234''' is hard to read or understand | ||
| − | * ''' | + | * '''John_Doe_portrait''' is recognisable |
| − | ==== | + | ==== Logos ==== |
* naming: brand_name_logo | * naming: brand_name_logo | ||
| − | * | + | * a time span can be also added |
Example | Example | ||
* ADB_Logo_till_1950s | * ADB_Logo_till_1950s | ||
| Line 26: | Line 26: | ||
==== Persons ==== | ==== Persons ==== | ||
| − | For persons, we follow the naming conventions in the | + | For persons, we follow the naming conventions in the item: |
| − | * naming: | + | * naming: Last_name_First_name |
* when there are multiple pictures, a reference to the exact content or a number can be added | * when there are multiple pictures, a reference to the exact content or a number can be added | ||
Example | Example | ||
* John_Doe | * John_Doe | ||
| − | * | + | * Jane_Doe_early_1960s |
* Louis_Inconue_1 | * Louis_Inconue_1 | ||
==== Buildings ==== | ==== Buildings ==== | ||
| − | For pictures of buildings we follow the conventions of the item | + | For pictures of buildings we follow the conventions of the item: |
* naming: Country code_city_building | * naming: Country code_city_building | ||
| − | ** to find the country code, | + | ** to find the country code, search for the country in Canonbase, and find its ISO code |
| − | ** Use the | + | ** Use the English name of the city as stated in the item's Canonbase entry |
* when there are multiple pictures, a reference to the exact content or a number can be added | * when there are multiple pictures, a reference to the exact content or a number can be added | ||
Revision as of 12:23, 23 March 2026
Contents
Naming conventions for files
All files such as images or digital documents are placed in the Canon repository that so they can be used in multiple places in the database and elsewhere. Therefore we need to give each one a unique name that makes it possible to find it again.
- the name has to be a title without spaces, therefore we use underscores to fill the spaces.
- the name can be given during the file upload process, but it is easier to rename them in advance.
Images
The principal idea is that image files should have a human recognisable file name that differentiates it from other files.
* IMG1234 is hard to read or understand * John_Doe_portrait is recognisable
Logos
- naming: brand_name_logo
- a time span can be also added
Example * ADB_Logo_till_1950s
Collection pieces
- naming: Collection_collection_number
- when there are multiple pictures, a reference to the exact content can be added
- _top, _back, _front, _detail, _logo, _type_plate, …
Example * TEAD_0123_front * KSB_0386
Persons
For persons, we follow the naming conventions in the item:
- naming: Last_name_First_name
- when there are multiple pictures, a reference to the exact content or a number can be added
Example * John_Doe * Jane_Doe_early_1960s * Louis_Inconue_1
Buildings
For pictures of buildings we follow the conventions of the item:
- naming: Country code_city_building
- to find the country code, search for the country in Canonbase, and find its ISO code
- Use the English name of the city as stated in the item's Canonbase entry
- when there are multiple pictures, a reference to the exact content or a number can be added
Example * BE_Antwerp_Bourla_theatre * BE_Antwerp_Bourla_theatre_House