Difference between revisions of "PRONOM Signature Development Utility"

From COPTR
Jump to navigation Jump to search
(Use the structure provided in this template, do not change it! -> "User Experiences" added)
(Added Siegfried and User Experiences)
Line 19: Line 19:
  
 
Signature File 88 contains of 1427 different PUIDs.
 
Signature File 88 contains of 1427 different PUIDs.
 +
 +
== Using its Output ==
 +
 +
=== DROID ===
 +
 +
The signature development utility output can be directly uploaded to DROID via its 'Install Signature File' mechanism. Be sure to then select the new file from 'Preferences'.
 +
 +
=== Siegfried ===
 +
 +
[http://coptr.digipres.org/Siegfried Siegfried] is a useful tool for testing because it can combine a new signature file from this utility with all the other signatures in the PRONOM corpus, plus its many others.
 +
 +
==== Instructions for Linux ====
 +
 +
We use a utility called Roy to extend signature files. This is installed alongside Siegfried.
 +
 +
To extend a signature file to include a custom signature file, we need to make sure that there is a 'custom' folder, where Roy can find it. We will need our signature to be on a path that looks as follows:
 +
 +
<pre>/home/{username}/siegfried/custom/{custom-dev-sig}.xml</pre>
 +
 +
Extending the signature file can then be completed in two stages:
 +
 +
<pre>1) Roy -harvest</pre>
 +
 +
This will download PRONOM signature file reports. This is the most accurate way to run Siegfried. An alternative is to let Siegfried parse the DROID signature file, but this has shown to lead to some inconsistencies where PRONOM and DROID do not reflect each other entirely.
 +
 +
<pre>2) Roy build -extend {custom-dev-sig}.xml</pre>
 +
 +
Try Siegfried on a single file of the format we have created the signature for:
 +
 +
<pre>3) sf {custom-dev-format}.{ext}</pre>
 +
 +
The result will be:
 +
 +
<pre>---
 +
siegfried  : 1.7.6
 +
scandate    : 2017-10-25T23:35:31+13:00
 +
signature  : default.sig
 +
created    : 2017-10-25T23:23:59+13:00
 +
identifiers :
 +
  - name    : 'pronom'
 +
    details : 'DROID_SignatureFile_V91.xml; container-signature-20170330.xml; extensions: {custom-dev-sig}.xml'
 +
---
 +
filename : '{custom-dev-format}.{ext}'
 +
filesize : 1492992
 +
modified : 2017-10-22T16:02:13+13:00
 +
errors  :
 +
matches  :
 +
  - ns      : 'pronom'
 +
    id      : 'dev/1'
 +
    format  : '{custom-dev-format}'
 +
    version : '1.0'
 +
    mime    : 'application/{custom-dev-format}'
 +
    basis  : 'extension match img; byte match at 1024, 32'
 +
    warning : </pre>
  
 
== User Experiences ==
 
== User Experiences ==
 
<!-- Add hotlinks to user experiences with the tool (eg. blog posts). These should illustrate the effectiveness (or otherwise) of the tool. Use a bullet list. -->
 
<!-- Add hotlinks to user experiences with the tool (eg. blog posts). These should illustrate the effectiveness (or otherwise) of the tool. Use a bullet list. -->
  
 +
* [http://digital-archiving.blogspot.co.nz/2016/08/my-first-file-format-signature.html Jenny Mitcham creates her first signature using the Signature Development Utility]
 +
* [http://openpreservation.org/blog/2016/09/08/making-the-switch-from-user-to-user-and-contributor-my-first-file-format-signature/ Andrea K. Byrne creates her first signature using the Signature Development Utility]
  
 
== Development Activity ==
 
== Development Activity ==

Revision as of 23:21, 2 November 2017


Output DROID compatible file format signature files using PRONOM syntax
Homepage:https://github.com/exponential-decay/signature-development-utility
License:Open source (see URL above)
Platforms:PHP + JQuery + Javascript + text/html


Description

Utility to enable the creation of DROID compatible signature files using PRONOM regular expression syntax. The tool outputs in an XML format compatible with DROID 4 upwards (including DROID 5 and 6). Three sequences can be combined to create a single file format signature. Signature files can be concatenated manually if more complex collections are required for testing.

Signature File 88 contains of 1427 different PUIDs.

Using its Output

DROID

The signature development utility output can be directly uploaded to DROID via its 'Install Signature File' mechanism. Be sure to then select the new file from 'Preferences'.

Siegfried

Siegfried is a useful tool for testing because it can combine a new signature file from this utility with all the other signatures in the PRONOM corpus, plus its many others.

Instructions for Linux

We use a utility called Roy to extend signature files. This is installed alongside Siegfried.

To extend a signature file to include a custom signature file, we need to make sure that there is a 'custom' folder, where Roy can find it. We will need our signature to be on a path that looks as follows: 

/home/{username}/siegfried/custom/{custom-dev-sig}.xml

Extending the signature file can then be completed in two stages: 

1) Roy -harvest

This will download PRONOM signature file reports. This is the most accurate way to run Siegfried. An alternative is to let Siegfried parse the DROID signature file, but this has shown to lead to some inconsistencies where PRONOM and DROID do not reflect each other entirely. 

2) Roy build -extend {custom-dev-sig}.xml

Try Siegfried on a single file of the format we have created the signature for: 

3) sf {custom-dev-format}.{ext}

The result will be: 

---
siegfried   : 1.7.6
scandate    : 2017-10-25T23:35:31+13:00
signature   : default.sig
created     : 2017-10-25T23:23:59+13:00
identifiers : 
  - name    : 'pronom'
    details : 'DROID_SignatureFile_V91.xml; container-signature-20170330.xml; extensions: {custom-dev-sig}.xml'
---
filename : '{custom-dev-format}.{ext}'
filesize : 1492992
modified : 2017-10-22T16:02:13+13:00
errors   : 
matches  :
  - ns      : 'pronom'
    id      : 'dev/1'
    format  : '{custom-dev-format}'
    version : '1.0'
    mime    : 'application/{custom-dev-format}'
    basis   : 'extension match img; byte match at 1024, 32'
    warning :

User Experiences

Development Activity

All development activity is visible on GitHub: https://github.com/exponential-decay/signature-development-utility/commits

Activity Feed

Below the last 5 commits: Failed to load RSS feed from https://github.com/exponential-decay/signature-development-utility/commits/master.atom: There was a problem during the HTTP request: 404 Not Found



Retrieved from ‘https://coptr.digipres.org/index.php?title=PRONOM_Signature_Development_Utility&oldid=3060’