Making the example commands easier to read

Started by StarGeek, December 20, 2024, 11:23:05 AM

Previous topic - Next topic

StarGeek

One problem I've always had with all the example commands on the docs page is that they don't stand out too much against the rest of the text.

Would it be possible to highlight them differently, the same way the example commands on the Writing "FileName" and "Directory" tags are highlighted?
"It didn't work" isn't helpful. What was the exact command used and the output.
Read FAQ #3 and use that cmd
Please use the Code button for exiftool output

Please include your OS/Exiftool version/filetype

Phil Harvey

Thanks for the suggestion.  I'll look into this, but likely the best I can do is change them to bold type because I don't have full control over the formatting of this page -- it is a pod2html conversion of the exiftool pod documentation.

- Phil
...where DIR is the name of a directory/folder containing the images.  On Mac/Linux/PowerShell, use single quotes (') instead of double quotes (") around arguments containing a dollar sign ($).

Phil Harvey

I think I have been successful in implementing your suggestion.

It just required changing all of the examples to "code" type, and changing the css "code" style.  The change affected other "code" elements as well, but I think maybe for the best.

Here is the new version.

If you like it then I will update the old exiftool_pod.html with this version.

- Phil
...where DIR is the name of a directory/folder containing the images.  On Mac/Linux/PowerShell, use single quotes (') instead of double quotes (") around arguments containing a dollar sign ($).

StarGeek

Looks good to me! Thanks for looking into this.
"It didn't work" isn't helpful. What was the exact command used and the output.
Read FAQ #3 and use that cmd
Please use the Code button for exiftool output

Please include your OS/Exiftool version/filetype

Phil Harvey

Great.

I've updated the page with this new look.

Thanks for the suggestion.

- Phil
...where DIR is the name of a directory/folder containing the images.  On Mac/Linux/PowerShell, use single quotes (') instead of double quotes (") around arguments containing a dollar sign ($).