Hi All
We need to address a subject which is long past overdue, image naming conventions on docs. Take a look at
http://docs.joomla.org/JDOC:Image_naming_convention and I would appreciate some input in planning an easier naming system. My thought is the easier it is, the more likely someone will stumble on an existing image. Then can make the decision, update it, use it as is, or create another with a more finite specifics.
Help screens will be a different structure, the actual images are automated now(thanks Mark D.) and the naming convention is too. So this is just for images someone adds to other articles.
Some of my thoughts Joomla specific screenshots.
- Screenshot in the image name is a bit redundant. Aren't 99.999% a screenshot? I usually just add the word Screenshot to the "Summary" section on upload page which will add this information to the image's page.
- Date, redundant again. The file page contains the date an image was uploaded, by who, size, and other details.
- Version info needed. j25 or j32 prefixed at the beginning, prep for j4.x.
- Lang code at the end(lot more to it, but that's another email) So in preparation for localisation of docs, -en for English or -es for español, etc... as the suffix.
- admin or site in the name
Ok, putting this together.
Screenshot of "Article Manager: Edit Article" in admin view.
j32-admin-article-manager-edit-article-en.png or
<version>-<view>-<view page title>-<lang>.<ext type>
What if someone wants to show a piece of the "Article Manager: Edit Article" in a screenshot.
<version>-<view>-<view page title>-<what>-<lang>.<ext type>
j32-admin-article-manager-edit-article-publishing-tab-en.png
I don't want to be the "image upload police" nor do I want this to be complicated. Are we going to stop duplication, in a word, no. I would hope with an easy, more common naming pattern, we can catch more of them.
Ideas, thoughts, suggestions welcomed so we can formulate an easy to learn, easy to use system.
Also, ideas on non-Joomla images. A screenshot of github or an image of eclipse. These will be harder and we should just push for the use of common sense.
github-pull-request.png
eclipse-editor-window.png
Thanks
Tom
--
----
Tom Hutchison
Joomla! Production Leadership Team