Difference between revisions of "Help:Naming conventions"
From CanonBase
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
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. | 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 | + | === Basic Principles === |
| − | * the name | + | |
| + | * File names in the repository cannot have spaces in them. The Repository will automatically replace any spaces with underscores. | ||
| + | * You can change the file name during the uploading process, but it is easier to rename files in advance. | ||
| + | * Avoid using special characters with accents in the file names, as they can cause issues. | ||
=== Images === | === Images === | ||
| Line 16: | Line 19: | ||
* ADB_Logo_till_1950s | * ADB_Logo_till_1950s | ||
| − | ==== | + | ==== Items from collections ==== |
* naming: Collection_collection_number | * naming: Collection_collection_number | ||
* when there are multiple pictures, a reference to the exact content can be added | * when there are multiple pictures, a reference to the exact content can be added | ||
| Line 27: | Line 30: | ||
==== Persons ==== | ==== Persons ==== | ||
For persons, we follow the naming conventions in the item: | For persons, we follow the naming conventions in the item: | ||
| − | * naming: | + | * naming: First name_Last 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 | ||
Latest revision as of 06:57, 2 April 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.
Basic Principles
- File names in the repository cannot have spaces in them. The Repository will automatically replace any spaces with underscores.
- You can change the file name during the uploading process, but it is easier to rename files in advance.
- Avoid using special characters with accents in the file names, as they can cause issues.
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
Items from collections
- 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: First name_Last 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