← Back to branch summary

~vcs-imports/xena/trunk

« back to all changes in this revision

Viewing changes to doc/content/normdirectory.html

  • Committer: matthewoliver
  • Date: 2009-12-10 03:18:07 UTC
  • Revision ID: vcs-imports@canonical.com-20091210031807-l086qguzdlljtkl9
Merged Xena Testing into Xena Stable for the Xena 5 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/content/normdirectory.html
1
 
<html>
2
 
<head>
3
 
<link rel="stylesheet" href="../theme/styles.css" type="text/css">
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
2
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
4
 
 
5
<head>
 
6
  <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
 
7
  <title>Normalising a directory</title>
 
8
  <link rel="stylesheet" href="../theme/styles.css" type="text/css" />
4
9
</head>
5
10
<body>
6
 
<h1>Normalise a Group of Files</h1>
7
 
<p>To normalise a complete directory of files, click <b>Add Directory</b> from the main Xena window.
8
 
</p>
9
 
<p><img src="../images/01-frontscreen.png"></img></p>
10
 
<br>
11
 
<p>
12
 
Use the file browser to select the directory containing the files to be normalised.
13
 
</p>
14
 
<p><img src="../images/13-add-directory.png"></img></p>
15
 
<br>
16
 
<p>
17
 
Back at the main screen, click the <b>Normalise</b> button to begin the process.
18
 
</p>
19
 
<p>During processing, the <b>Pause</b> and <b>Stop</b> buttons will become available. Please note that rather than halting the process immediately, either of these will interrupt processing once the current file has been processed. If the current file is large or complex, there may be some delay before either of these buttons come into effect.
20
 
</p>
21
 
<p>
22
 
Once processing is completed, the results are presented. Click <b>OK</b>.
23
 
</p>
24
 
<p><img src="../images/14-normalise-complete-directory.png"></img></p>
25
 
<br>
26
 
<p>
27
 
Upon completion, the <b>Cancel</b> button may be used to delete the resulting Xena file(s) and start again. This may be useful if the wrong file was accidentally normalised. The <b>New Session</b> button may be used after completion to continue processing files without altering any existing results.
28
 
</p>
29
 
<p>If a file is malformed then the normalising process may fail. Failures are indicated in the results table with a brief explanation of the cause. If any failures occur, the <b>Binary Normalise Failures</b> button then becomes active and may be used to preserve failed files as text with embedded metadata. If a file is of a type unknown to Xena, then the process will automatically fall back to binary normalisation.
30
 
</p><br>
 
11
<h1>Normalising a directory</h1>
 
12
<hr />
 
13
 
 
14
<p>To normalise a directory of files:</p>
 
15
 
 
16
<ol>
 
17
<li>In the <a href="normopt.html">Normalisation Options</a> section of the main Xena window ensure that <b>Guess Type for All Files</b> is selected.</li>
 
18
 
 
19
<li>Click the <b>Add Directory</b> button.
 
20
<p><b>Result: </b> The file browser window is displayed.</p>
 
21
<p><img src="../images/13-add-directory.png" alt="File browser window" /></p>
 
22
</li>
 
23
<li>Select the directory containing the files to be normalised.</li>
 
24
<li>Click <b>Open</b>.
 
25
<p><b>Result: </b> The directory selected is displayed in the <i>Items to Normalise</i> section of the main Xena window.</p>
 
26
<p><img src="../images/directorytonormalise.png" alt="Directory in main window" /></p>
 
27
</li>
 
28
 
 
29
<p>This process can be repeated for as many files as required.</p>
 
30
 
 
31
<li>Click <b>Normalise</b>.
 
32
<p><b>Note: </b>During processing, the <b>Pause</b> and <b>Stop</b> buttons will become available. 
 
33
Clicking either of these buttons will interrupt processing <em>after the current file has been processed</em>. 
 
34
If the current file is large or complex, there may be some delay before either of these buttons come into effect.
 
35
</p>
 
36
<p><b>Result:</b> Once processing is completed, the results are presented in the <i>Normalisation Results</i> section.</p>
 
37
<p><img src="../images/14-normalise-complete-directory.png" alt="Normalisation complete dialog" /></p>
 
38
<br/>
 
39
</li>
 
40
<li>Click <b>OK</b>.</li>
 
41
<li>To complete the normalisation process, do one of the following:
 
42
<ul>
 
43
<li>To save the resulting preserved Xena files and start a new session, click <b>Done</b>.</li>
 
44
<li>To delete the resulting preserved Xena files and <em>continue the same session</em>, click <b>Cancel</b>.</li>
 
45
<li>To binary normalise files which failed normalisation and <em>continue the same session</em>, click <b>Binary Normalise Failures</b>.</li>
 
46
</ul>
 
47
</li>
 
48
</ol>
 
49
 
31
50
</body>
32
51
</html>