Skip to content

Commit ec67956

Browse files
committed
[IMP] guidelines: add media filenames section in content guidelines
1 parent a6b3f03 commit ec67956

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

contributing/documentation/content_guidelines.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,30 @@ A few tips to improve your screenshots:
160160
Resizing the window's width is the most important step to do as Odoo's responsive design
161161
automatically resizes all fields to match the window's width.
162162

163+
.. _contributing/media-filenames:
164+
165+
Media filenames
166+
---------------
167+
168+
A **media filename** is written in **lower-case letters** and is composed of three parts:
169+
170+
1. A **prefix** which is the same name as the *RST filename* in which the media is referenced. E.g.,
171+
``content-guidelines``.
172+
2. An **identifying name** relevant to the media's content. E.g., ``filename``.
173+
3. The **file extension**, which is ``.png`` for most images.
174+
175+
Use a **hyphen** ``-`` to separate the words in the media filename. E.g.,
176+
``content-guidelines-filename.png``.
177+
178+
.. note::
179+
**RST** filenames use **underscores** ``_`` to separate words. Replace them with hyphens for the
180+
media filenames.
181+
182+
.. important::
183+
Previously, image filenames would mostly be named with numbers (e.g., ``feature01.png``). While
184+
it is advised not to name your *new* images in that fashion, it is also important not to rename
185+
unchanged files. They will eventually all be replaced with new content.
186+
163187
.. _contributing/alt-tags:
164188

165189
ALT tags

0 commit comments

Comments
 (0)