File tree Expand file tree Collapse file tree 1 file changed +32
-0
lines changed
contributing/documentation Expand file tree Collapse file tree 1 file changed +32
-0
lines changed Original file line number Diff line number Diff line change @@ -160,6 +160,38 @@ 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-files :
164+
165+ Media files
166+ -----------
167+
168+ A **media filename **:
169+
170+ - is written in **lower-case letters **
171+ - is **relevant ** to the media's content. (E.g., :file: `screenshot-tips.gif `.)
172+ - separates its words with a **hyphen ** ``- `` (E.g., :file: `awesome-filename.png `.)
173+
174+ Each document has its own folder in which the media files are located. The folder's name must be the
175+ same as the document's filename.
176+
177+ For example, the document :file: `doc_filename.rst ` refers to two images that are placed in the
178+ folder ``doc_filename ``.
179+
180+ ::
181+
182+ ├── section
183+ │ └── doc_filename
184+ │ │ └── screenshot-tips.gif
185+ │ │ └── awesome-filename.png
186+ │ └── doc_filename.rst
187+
188+ .. note ::
189+ Previously, image filenames would mostly be named with numbers (e.g., :file: `feature01.png `) and
190+ placed in a single ``media `` folder. While it is advised not to name your *new * images in that
191+ fashion, it is also essential **not to rename unchanged files **, as doing this would double the
192+ weight of renamed image files on the repository. They will eventually all be replaced as the
193+ content referencing those images is updated.
194+
163195.. _contributing/alt-tags :
164196
165197ALT tags
You can’t perform that action at this time.
0 commit comments