IMatch Discussion Boards > Online Help and other Documentation

Templates explanation

(1/3) > >>

HansEverts:
I went through the explanation of metadata templates and I really think it is a bit too short or aimed at a reader who already knows what to do with templates. I am not that reader and although I feel a hint that this is a strong tool, I don't really understand how it functions and what it can achieve.

Just as a test I made a template called Length with a tag FocalLength. The red dot was put on Set and the blue dot on Clear. I selected images with a blue dot and ran the template. The blue dots disappeared, but there were no red dots.
This sounds like a silly test, but because I simply do not know what the template is supposed to do, often just playing around helps.

I think such chapters would be greatly enriched with a few examples. I had the same feeling while reading other parts of the help file. The target audience seems to be already on a relatively high level, but it would be interesting to get more opinions on this.

JohnZeman:
What I use metadata templates for is to add location metadata to the selected images.  The easy way to set that up is to first go to the metadata panel and configure one with exactly the metadata fields you want to use in your template.  Then find an image that contains the values you want to put in that template, click the button indicated in the screen shot below, and add that as a new template.  Once you do it will be visible in the list (also seen in the screen shot) so you can quickly add the location metadata including GPS coordinates, to the selected images.


[attachment deleted by admin]

Richard:

--- Quote ---I think such chapters would be greatly enriched with a few examples.
--- End quote ---

I just re-read that topic and it does contain examples. However, I can not state that I understand all that can be accomplished with metadata templates just by reading that topic. In an ideal situation one should be able to read a feature in Help and comprehend everything about that feature. There should be no need to have to experiment to learn what happens. I also know that it is nearly impossible to achieve that ideal. What may be helpful to one reader might be boring to another plus the files could become huge. So huge that folks would stop reading Help.

I would guess that when Mario finished developing a feature, he then wrote the Help file for that feature. Thus the Help author knew everything there was to know about that feature. It can be hard for a person to put aside what they know and write so that others can fully comprehend. Technical writers are specialists at doing so and get well paid.

In general, I believe that many topics could be improved with more examples but by using the Feedback link, each of us can give some specific details on any topic. I believe that Mario would need specifics rather than a general statement that Help could be improved with more examples.

While I was writing my opinions John replied with very nice example of how he uses a Template. His reply made it easy to understand that specific use but there seem to be many ways to use Templates. Can examples teach us how to do it in general or only for specific examples?

jch2103:

--- Quote from: Richard on August 19, 2013, 11:31:20 PM ---
--- Quote ---I think such chapters would be greatly enriched with a few examples.
--- End quote ---
...
While I was writing my opinions John replied with very nice example of how he uses a Template. His reply made it easy to understand that specific use but there seem to be many ways to use Templates. Can examples teach us how to do it in general or only for specific examples?

--- End quote ---

Examples can be very useful, and can provide general insights beyond the specific examples being discussed. There is certainly a limit on how much can be usefully be added to Help, however (although users should certainly submit specific suggestions for Help improvements).

https://www.photools.com/community/index.php?board=17.0 (FAQs) seems like a good place for knowledgeable users to post good examples of how to do specific things in IMatch. There's a lot of collective expertise available in the tester community that could help other users.

HansEverts:
Thanks for your responses, which give me fresh ideas to work on. I honestly do not know of many forums where a topic posted after 11 PM has already 3 answers by 1.30 AM. Congratulations! Within a few days the forum has clarified several issues I raised, not so much by explaning everything from the very bottom, but by giving just enough additional information to help me over the top of the hill. Much appreciated.
With the example from John and the one on copyright in the help file I can go a long way.
I do not think every topic would require tens of examples, but a few would be helpful. Even simple exercises could be added. This could all be in an annex, to prevent overburdening the text.
I agree this could gradually be built up from user's examples. The advantage of those is that they originate from others than the IMatch core team and illustrate therefore more how users understand the text.

Navigation

[0] Message Index

[#] Next page

Go to full version