Feature #1061

Exiv2 manpage overhaul

Added by Robin Mills almost 2 years ago. Updated 9 months ago.

Status:AssignedStart date:22 Apr 2015
Priority:NormalDue date:
Assignee:Robin Mills% Done:

20%

Category:documentationEstimated time:20.00 hours
Target version:0.27

Description

This is an "umbrella" feature.

Here are my immediate thoughts. When work is performed on the man pages, more ideas will come to light.

  1. A general section about MetaData and the types (Exif, IPTC, Xmp)
  2. Explain/illustrate all XMP keys XmpText, XmpAlt, XmpBag and XmpSeq
  3. Explain how to use XMP namespace registration
  4. Explain/illustrate charsets for Comment
  5. Have another man page exiv2examples (5)
  6. Have another man page exiv2tests (5)
  7. Consider moving/duplication the information in metadata.html in the man page

It would be a good idea to add a new test "manpages.sh" that executes code to ensure that all example commands in the man pages work!

The build (autotools and CMake) should install the new manpages into the correct locations.

I'd like to make a distinction between sample applications, such as exiv2json and test programs such as error-test.cpp. Both can reside in the directory "samples" and the code is available to developers. However the purpose of sample applications is to illustrate use of the Exiv2 API. The purpose of test programs is to be executed from our test suite.

I'm going to assign this to Alan. Alan, if you don't want to pursue this at the moment, please assign it to me. You are also welcome to defer this for v0.26.


Related issues

Related to Exiv2 - Feature #608: list of supported formats Closed 24 Jan 2009
Related to Exiv2 - Feature #1165: Exiv2 man page structural enhancements Assigned 02 Mar 2016

Associated revisions

Revision 3741
Added by Alan Pater almost 2 years ago

#1061 manpage: reg namespace example, description amplification

Revision 4156
Added by Robin Mills about 1 year ago

#1061. Added exiv2samples.1 and associate autotools and CMake installer support. Work in progress.

History

#1 Updated by Alan Pater almost 2 years ago

  • Target version changed from 0.25 to 0.26
  • % Done changed from 0 to 10

I'd like to defer the larger changes to 0.26.

Putting examples, tests and a perhaps a few other things in separate man pages is a good idea, I think.

#2 Updated by Robin Mills about 1 year ago

  • Assignee changed from Alan Pater to Robin Mills
  • % Done changed from 10 to 20
  • Estimated time set to 20.00

r4156 I've started working on samples/exiv2samples.1

Alan's busy with his new business. I'll take this over.

I've been progress every other Sunday on the 'News' page. Showing progress on this issue will boost the our project % estimates. http://dev.exiv2.org/projects/exiv2/news

I believe the project will complete on time. I put my hands around the project in September at 30% done. We're now about 60% after 3 months. We'll be complete about April.

#3 Updated by Robin Mills 9 months ago

  • Target version changed from 0.26 to 0.27

Deferred to v0.27 to make the schedule for v0.26.

Also available in: Atom PDF

Redmine Appliance - Powered by TurnKey Linux