Image Naming Convention

Publishing Tasks: Phase 1 Submission

Image Naming Convention

An image file naming convention has been established for the following reasons:

• Images in ph-submissions Preview will always display
• Managing Editors will not be confused/make mistakes when they are identifying which images to move over to Jekyll
• Lesson Maintenance will be simpler because images will be named consistently

Image file names will consist of 4 parts:

• a prefix which indicates the language (en, es, fr, pt)
• an infix which indicates whether the image is an original or a translation (or, tr)
• the lesson-file-name (matching the lesson's slug:)
• a two-digit suffix number to indicate the sequence (01, 02, 03 ...)

Here's an example for an original Spanish lesson:

es-or-lesson-file-name-01.png
es-or-lesson-file-name-02.png
es-or-lesson-file-name-03.png
es-or-lesson-file-name-04.png

And for a Portuguese translation of that lesson which uses all new images:

pt-tr-lesson-file-name-01.png
pt-tr-lesson-file-name-02.png
pt-tr-lesson-file-name-03.png
pt-tr-lesson-file-name-04.png

For a Portuguese translation which creates some new images but keeps others as original:

es-or-lesson-file-name-01.png
es-or-lesson-file-name-02.png
pt-tr-lesson-file-name-02.png
es-or-lesson-file-name-03.png
es-or-lesson-file-name-04.png
pt-tr-lesson-file-name-04.png

If you were the Portuguese Managing Editor preparing to move the files (above) over to Jekyll for publication, you would only need to move those with the pt-tr prefix.

--

Here's an example of how that file list might look if the lesson is later translated into French. Again, this translation creates some new images but keeps others as they were in the Spanish original:

es-or-lesson-file-name-01.png
es-or-lesson-file-name-02.png
pt-tr-lesson-file-name-02.png
fr-tr-lesson-file-name-02.png
es-or-lesson-file-name-03.png
fr-tr-lesson-file-name-03.png
es-or-lesson-file-name-04.png
pt-tr-lesson-file-name-04.png
fr-tr-lesson-file-name-04.png

If you were the French Managing Editor preparing to move the files (above) over to Jekyll for publication, you would only need to move those with the fr-tr prefix.

--