-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstructions.html
143 lines (114 loc) · 4.47 KB
/
instructions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Instructions</title>
<style type="text/css">
@namespace oxy "http://www.oxygenxml.com/extensions/author";
@namespace "http://www.w3.org/1999/xhtml";
html{
-oxy-editable: false;
}
oxy|processing-instruction, oxy|comment {
display:none !important;
}
*{
-oxy-display-tags: none;
}
head{
display: none;
}
body{
line-height: 1.2;
font-family: verdana sans-serif;
font-size: 12pt;
text-align: center;
}
div{
margin: 1em 20% 1em 20%;
}
body, div, section, h1¸ h2, h3, p, ul, ol{
display: block;
}
h1, h2, h3{
text-align: center;
margin: 0.5em;
}
h1{
font-size: 200%;
}
h2{
font-size: 150%;
}
h3{
font-size: 120%;
}
p, ul, ol{
text-align: left;
}
ul, ol{
margin-left: 1em;
}
li{
display: list-item;
}
ol{
list-style-type: decimal;
}
b{
font-weight: bold;
}
img{
display: inline-block;
content: attr(src, url);
}
br{
display: block;
content: "";
}
</style>
</head>
<body>
<div>
<h1>Instructions</h1>
<p>Before you do anything, make sure you have a local copy of the
diagnostics project. You can either clone it from the GitHub
repository, or you can just download a release. You will also
need to know the location of your own project's TEI XML files
on your computer.</p>
<section>
<h2>How to run diagnostics on your project in Oxygen</h2>
<p>To run diagnostics against a TEI XML encoding project, you will need:</p>
<ul>
<li>A project folder which contains all of your TEI XML files. They
can be nested in subfolders or organized in any way.</li>
<li>A single file of any kind in that root folder.</li>
</ul>
<ol>
<li>In Oxygen, choose <b>Project / Open Project</b>, and choose the <b>diagnostics.xpr</b>
file to open the diagnostics project.</li>
<li>Open this document in Oxygen.</li>
<li>Press the <b>red triangle</b> button <img src="images/btnRunScenario.png" width="34" height="29"/> on the toolbar, or choose
<b>Document / Transformation / Apply Transformation Scenario(s)</b>.</li>
<li>When prompted, choose a file in the root folder of your project directory.</li>
</ol>
<p>You will see progress messages at the bottom of the Oxygen window, and
eventually a diagnostics page will open in your web browser.</p>
</section>
<section>
<h2>How to run diagnostics at the command line</h2>
<ol>
<li>Make sure ant is installed on your computer.</li>
<li><b>cd</b> to the diagnostics project folder.</li>
<li>Run this command:<br />
<b>ant -DprojectDir=[path-to-your-project-folder]</b>
</li>
</ol>
<p>A new folder will be created inside your project folder
called <b>diagnostics_[the-date]</b>, containing a file called
<b>diagnostics.html</b>. Open this file in your browser to see
the results of the diagnostics.</p>
</section>
</div>
</body>
</html>