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...")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
== Naming conventions documents ==
+
== Naming conventions for files ==
−
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 possible to find them back.
+
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.
+
=== Basic Principles ===
−
* the name can be given in the upload process, but it is easier to rename them in advance.
+
 
 +
* 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 ===
−
The principle idea is that pictures should have a human recognisable file name that differentiates it from other files.
+
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_portret''' is recognisable
+
  * '''John_Doe_portrait''' is recognisable
  
−
==== Logo's ====
+
==== Logos ====
 
* naming: brand_name_logo
 
* naming: brand_name_logo
−
* additional a time span can be added  
+
* a time span can be also added  
 
  Example
 
  Example
 
  * ADB_Logo_till_1950s
 
  * ADB_Logo_till_1950s
  
−
==== Collection pieces ====
+
==== 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 26: Line 29:
  
 
==== Persons ====
 
==== Persons ====
−
For persons, we follow the naming conventions in the items.
+
For persons, we follow the naming conventions in the item:
−
* naming: Last_name_Fist_name
+
* 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
  
 
  Example
 
  Example
 
  * John_Doe
 
  * John_Doe
−
  * Jane_Doe_early 1960s
+
  * 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, look up ISO code in the country item
+
** to find the country code, search for the country in Canonbase, and find its ISO code
−
** Use the Enlish name of the city as staed in the item
+
** 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
  

Latest revision as of 06:57, 2 April 2026

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
Retrieved from "http://www.canonbase.eu:8181/w/index.php?title=Help:Naming_conventions&oldid=577850"

Wikidata