KB article review [draft]:
| Jira Legacy | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Our CMS contains thousands of image files, so it's important to name your file well so In our Content Management System (CMS), we house a vast repository of image files. It's imperative to follow proper naming conventions to ensure that you and your colleagues can find easily locate and reuse themthese files.
There are 2 different naming conventions to keep in mind:
...
Understanding the two naming conventions
When managing your files, it's important to distinguish between two key naming conventions:
1. Filename
The filename is what an image is saved as on your computer
...
. For instance, 'very-important-image.jpg
...
' is a filename.
2. Media Item Name
The media item name is the name you assign to an image when uploading it to the CMS media library
...
. An example is 'Shrine profiles John Lui
...
.'
Filename guidelines
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
...
When naming your filename, adhere to these guidelines:
Descriptive: Make your filename descriptive. It should clearly convey the content of the image.
No spaces: Avoid including spaces in the filename. Instead, use hyphens to separate words, enhancing readability and compatibility with various systems.
Avoid generic names: Steer clear of generic names like 'IMG_001.jpg.' Create unique and informative filenames.
For exampleinstance, if you have an image of a girl laughing should be saved , save it as 'girl-laughing.jpg' before uploading it to the CMS Media Library. If the image's filename contains spaces (e.g., 'girl laughing.jpg') you must , remember to replace the spaces with hyphens).
Media item name
...
guidelines
When naming an image in the CMS's Media Library must, follow these guidelines:
Use spaces: Unlike filenames, use spaces between words
...
in the media item name. This enhances readability.
Be meaningful and descriptive: Ensure that the name is meaningful and descriptive enough
...
to facilitate easy searching when required.
...
Include specifics: If the image
...
features a specific person, include their name and position in the media item name.
For example:
Hon Linda Dessau, Governor of Victoria
Alana Johnson, member of the Ministerial Council on Women's Equality
Example
...
In the example above example, the image's filename is "girl-laughing.jpg," so the name you would should give it for in 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 Please note that the content you enter in the "Name" field will only appear if it's part of an Image gallery component.
If you're uploading several multiple images that belong together, such as council members of a council or honour honor roll inductees, it's a good idea to put this consistently advisable to maintain consistency in the image names , for to facilitate easier searching. For exampleinstance: "Stella Young – 2017 Women's Honour Roll."
By adhering to these naming conventions, you'll contribute to better organization and accessibility of media files in our CMS.