KB article review [draft]:
| Jira Legacy | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Our CMS contains thousands of image files, so it's important to name your file well so that you and your colleagues can find and reuse themThoughtful naming practices will help you to find and manage your media items.
There are 2 different naming conventions to keep in mind:
...
two naming considerations:
...
File name - what your image or document is saved as on your computer , (e.g. very-important-image.jpg)
The media item name you give the image when you upload it to the CMS media library (e.g. Shrine profiles John Lui).
Filename
Your filename should:
be descriptive
contain no spaces
use hyphens (not underscores) to separate the words and make the filename as easy to read as possible
not be a generic file name like IMG_001.jpg.
For example, an image of a girl laughing should be saved as 'girl-laughing.jpg' before uploading to the CMS Media Library.
If the image's filename contains spaces (e.g. 'girl laughing.jpg') you must replace the spaces with hyphens).
Media item name
The name you give your image when you upload it to the CMS's Media Library must:
use spaces between words (not hyphens or underscores)
be meaningful and descriptive enough that you can search for it when required
. premier-headshot12345.jpg or annual-report-2024-final-version.docx). Users will see this name when they download a PDF, Word doc or Zip file onto their device. Ideally the file name gives a clear indication of the content and version or date.
Media item name - what you assign to the CMS ‘item’. Media items contain a file as well as other information, such as the alt text, copyright and what site and department the file belongs to.
Media item name guidelines
When adding an item in the media library:
Use spaces: Unlike file names, use spaces between words in the media item name.
Be detailed but concise: Ensure that the name is descriptive enough for easy searching when you need to locate items. Your items will be tagged to site sections and departments, and thus you can use these filters on the Media screen, but additional owner or project information can be helpful.
Include important specifics:
If an image features a specific person, include their name and relevance position
...
For example:
Hon Linda Dessau, Governor of Victoria
Alana Johnson, member of the Ministerial Council on Women's Equality
Example
...
In the above example, the image's filename is "girl-laughing.jpg" so the name you would give it for the Media Library is "Girl laughing".
Keep in mind that what you put in the Name field doesn't appear unless it is part of an Image gallery component.
...
in the media item name (e.g. 'Associate Professor Jun Yang - Women's Honour Roll 2024').
If your images belong together in a series, such as council members or honor roll inductees, give consistent names to all items in the series.
Note on media item naming for images
The only place a media item name is visible to the public is when an image is used in an image gallery.
...