Subversion Repositories oidinfo_new_design

Rev

Rev 2 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 daniel-mar 1
<div id="global_content">
2
 
3
        <TABLE cellspacing="0" cellpadding="0" border="0" width="100%">
4
                <TR>
5
                        <TD height="20" colspan="3" valign="top" width="100%">&nbsp;</TD>
6
                </TR>
7
                <TR>
8
                        <TD height="40" valign="top" width="440">
9
                                <span class="page_title">
10
                                        <font class="color_orange">Submit OID descriptions as XML files</font></span><br>
11
                        </TD>
12
                        <TD height="40" valign="top" width="20">&nbsp;</TD>
13
                        <TD width="150" height="40" valign="middle">
14
                        </TD>
15
                </TR>
16
        </TABLE>
17
 
18
        <TABLE cellspacing="0" cellpadding="0" border="0" width="100%">
19
                <TR>
20
                        <TD width="10" valign="top"></TD>
21
                        <TD valign="top" width="430">
22
                                <P align="justify">
23
                                        The form below provides for the submission of XML
24
                                        files containing OID descriptions conforming to the <a href="oid.xsd">XML
25
                                                schema</a> of the OID repository.
26
                                </P>
27
                                <ul>
28
                                        <li>
29
                                                if the OID does not yet exist in the OID repository but its parent
30
                                                OID is described in the Repository, it is added but the description
31
                                                will not be visible until it is validated by the Repository administrator
32
                                                (a notification will be sent to you by email once this is done);<br></li>
33
                                        <li>
34
                                                if the parent OID of the OID to be added does not yet exist in the
35
                                                OID repository, the OID is said to be &quot;<a href="faq.htm#orphan">orphan</a>,&quot;
36
                                                it will be added to the OID repository (after validation by the Repository
37
                                                administrator) but will not be accessible for display to users who
38
                                                walk down the OID tree; <br></li>
39
                                        <li>
40
                                                If the description corresponds to an OID which is already described
41
                                                in the OID repository, it is ignored.<br></li>
42
                                </ul>
43
                                <p>
44
                                        Please note that, if you submit a lot of XML descriptions, the time-out
45
                                        of your browser may be reached before the results are displayed on your
46
                                        screen. In any case, the results will be sent to the email address indicated
47
                                        in the <tt>&lt;submitter&gt;</tt> part of the XML file. <br><br><font size="-1">
48
                                                Note 1: Daniel Marschall has developed an <a href="https://www.viathinksoft.de/%7Edaniel-marschall/oid-repository/api/">Application
49
                                                        Programming Interface (API) in PHP</a> which can help developers in
50
                                                creating such XML files.<br></font><font size="-1">
51
                                                Note 2: If you have a text file gathering objects
52
                                                in a <a href="http://en.wikipedia.org/wiki/Management_information_base">Management
53
                                                        Information Base</a> (MIB), you can send it to the <a href="mailto:admin&oid-info.com">OID
54
                                                        repository administrator</a> who has a tool to automatically extract
55
                                                OIDs from such files. Please make sure that the top OID of your MIB
56
                                                is defined in the file.
57
                                        </font>
58
                                </p>
59
                        </TD>
60
                        <TD width="20" valign="top">&nbsp;</TD>
61
                        <TD width="150" valign="top">
62
                                <p>
63
                                        <img src="images/bullet.gif" width="10" height="8" border="0" align="bottom"><a href="oid.xsd">XML schema</a> for OID descriptions
64
                                </p>
65
                                <p>
66
                                        <a href="xhtml-light.xsd"><img src="images/bullet.gif" width="10" height="8" border="0" align="bottom">XML schema</a> for the allowed subset of XHTML
67
                                </p>
68
                        </TD>
69
                </TR>
70
        </TABLE>
71
 
72
        <FORM method="post" action="/cgi-bin/submit" enctype="multipart/form-data" name="submit">
73
                <TABLE cellspacing="0" cellpadding="0" border="0" width="600">
74
                        <TR>
75
                                <TD valign="middle" width="390">
76
                                        <FONT face="Arial, Helvetica, sans-serif" size="2">
77
                                                <B>File
78
                                                        name</B>(a single XML file containing all the OID descriptions, or
79
                                                a zipped archive of XML files):
80
                                        </FONT><FONT face="Arial, Helvetica, sans-serif" size="2">
81
                                                <BR><INPUT type="file" name="fichier" size="50">&nbsp;&nbsp;&nbsp;
82
                                                <INPUT type="submit" name="submit" value="Submit"></FONT><BR></TR>
83
                </TABLE>
84
 
85
                <TABLE border=0 cellspacing=0 cellpadding=0 width="600" dwcopytype="CopyTableRow">
86
                        <!--  <tr>
87
                                        <td>&nbsp;</td>
88
                                        <td>&nbsp;</td>
89
                                  </tr>
90
                                  <tr>
91
                                        <td valign=top height="39" bgcolor="#CCCCCC">
92
                                          <input type="text" name="submit-email"><font face="Arial, Helvetica, sans-serif" size="-1">&nbsp;</font></td>
93
                                        <td valign=CENTER width="454" height="19" bgcolor="#CCCCCC"> <font face="Arial, Helvetica, sans-serif" size="-1">Give
94
                                          your email address if you want to receive an email with the results
95
                                          of your submission (when the submitted XML file is big, the time-out
96
                                          of your browser can be reached before the resulting webpage is produced
97
                                          and you would then miss the resulting messages)</font></td>
98
                                  </tr>
99
                        -->
100
                        <TR>
101
                                <TD>&nbsp;</TD>
102
                                <TD>&nbsp;</TD>
103
                        </TR>
104
                        <tr>
105
                                <td align=middle valign=top height="39" bgcolor="#CCCCCC">
106
                                        <input type="checkbox" name="ignoreNL" value="true"><font face="Arial, Helvetica, sans-serif" size="-1">&nbsp;<tt>-ignoreNL</tt></font>
107
                                </td>
108
                                <td valign=CENTER width="454" height="19" bgcolor="#CCCCCC">
109
                                        <font face="Arial, Helvetica, sans-serif" size="-1">
110
                                                Ignore
111
                                                all newline characters used in text descriptions between XML tags. By
112
                                                default, newline characters are turned into <tt>&lt;br&gt;</tt> elements
113
                                                when displayed in HTML. When this box is checked, newline characters
114
                                                are replaced with a whitespace.
115
                                        </font>
116
                                </td>
117
                        </tr>
118
                </TABLE>
119
        </FORM>
120
 
121
 
122
<p><a href="javascript: switchInfoPerso('xml_explanations');"><img src="images/Info.png" alt="" width="15" height="15">&nbsp;See more detailed explanations</a></p>
123
 
124
        <TABLE cellspacing="0" cellpadding="0" border="0" width="100%" id="xml_explanations" style="display:none;">
125
                <TR>
126
                        <TD width="10" valign="top"></TD>
127
 
128
                        <TD valign="top" colspan="3">
129
                                <p>
130
                                        The example below is an XML document that conforms to our <a href="oid.xsd">XML
131
                                                schema</a> and contains the description of one OID (namely, <tt>
132
                                                {joint-iso-itu-t(2)
133
                                                example(999) xml-submission(777)}
134
                                        </tt>).
135
                                </p>
136
                                <ul>
137
                                        <li>
138
                                                There can be more than one <tt>&lt;<b>oid</b>&gt;</tt> block per
139
                                                <tt>&lt;<b>oid-database</b>&gt;</tt> but only one <tt>&lt;<b>oid-database</b>&gt;</tt>
140
                                                per XML file.
141
                                        </li>
142
                                        <li>
143
                                                A father OID does not need to be described in the file prior to
144
                                                its child OIDs because the tool will sort the blocks before adding
145
                                                information to the OID repository.
146
                                        </li>
147
                                        <li>
148
                                                The <tt><font color="#009933">&lt;submitter&gt;</font></tt> part
149
                                                contains information about you. This information will not be displayed
150
                                                when people will query the OID repository. It is at that email address
151
                                                that you will receive the result of your XML submission. That email
152
                                                address will also be used to keep you informed if the OID descriptions
153
                                                you submitted are updated in the future.
154
                                        </li>
155
                                        <li>
156
                                                Note that a <a href="xhtml-light.xsd">subset</a> of <font color="#FF9933">XHTML</font>
157
                                                is allowed inside plain text for the <tt>&lt;description&gt;</tt>,
158
                                                <tt>&lt;information&gt;</tt> and <tt>&lt;address&gt;</tt> elements.
159
                                        </li>
160
                                        <li>
161
                                                HTML entity references (such as &quot;<tt>&amp;eacute;</tt>&quot;)
162
                                                are not supported by default, so please use decimal codes (such as
163
                                                &quot;<tt>&amp;#233;</tt>&quot;) or include the needed <a href="http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent">XHTML
164
                                                        entity references</a> in a <tt>&lt;!DOCTYPE...&gt;</tt> block at the
165
                                                beginning of your XML document as follows:<br><font size="-1">
166
                                                        <tt>
167
                                                                &lt;!DOCTYPE oid-database[<br>&nbsp;&nbsp;&lt;!ENTITY eacute "&amp;#233;"> &lt;!-- <i>latin small
168
                                                                        letter e with acute</i> --&gt; <br>&nbsp;&nbsp;&lt;!-- <i>please add <a href="http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent">XHTML
169
                                                                                entity references</a> as needed</i> --&gt;]&gt;
170
                                                        </tt>
171
                                                </font>.
172
                                        </li>
173
                                        <li>
174
                                                More detail about what is allowed for each XML tag is given as
175
                                                <tt>&lt;documentation&gt;</tt> tags in the <a href="oid.xsd">XML schema</a>.
176
                                                Please have a look at it.<br></li>
177
                                </ul>
178
                                <font size="-1">
179
                                        <tt>
180
                                                &lt;<b>oid-database</b>&gt;<br><font color="#009933">
181
                                                        &nbsp;&nbsp;&lt;submitter&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;first-name&gt;John&lt;/first-name&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;last-name&gt;Smith&lt;/last-name&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;email&gt;john.smith@myhost.com&lt;/email&gt;<br>&nbsp;&nbsp;&lt;/submitter&gt;
182
                                                </font><br>&nbsp;&nbsp;&lt;<b>oid</b>&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;asn1-notation&gt;{joint-iso-itu-t(2) example(999)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xml-submission(777)}&lt;/asn1-notation&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;identifier&gt;oid-repository&lt;/identifier&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;description&gt;Example of a description conforming
183
                                                to the<br><font color="#FF9933">
184
                                                        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;a
185
                                                        href=&quot;http://oid-info.com/oid.xsd&quot;&gt;
186
                                                </font>XML Schema of the
187
                                                OID repository<font color="#FF9933">&lt;/a&gt;</font><br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/description&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;information&gt;More information can be found
188
                                                in<br><font color="#FF9933">
189
                                                        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;a
18 daniel-mar 190
                                                        href="https://itu.int/ITU-T/X.660"&gt;
2 daniel-mar 191
                                                </font>Rec. ITU-T X.660<font color="#FF9933">&lt;/a&gt;</font>.<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/information&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;current-registrant&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;first-name&gt;John&lt;/first-name&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;last-name&gt;Doe&lt;/last-name&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;email&gt;john.doe@dummy.com&lt;/email&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;address&gt;Street Name<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Town<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Country<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/address&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;modification-date&gt;2002-05-25&lt;/modification-date&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/current-registrant&gt;<br>&nbsp;&nbsp;&lt;/<b>oid</b>&gt;<br>&lt;/<b>oid-database</b>&gt;<br><br></tt>
18 daniel-mar 192
                                </font>
2 daniel-mar 193
                        </TD>
194
                </TR>
195
        </TABLE>
196
        <p>Once added to the OID repository, the above description
197
                                will be displayed as shown on the <a href="display-example.htm">display
18 daniel-mar 198
                                        example</a>.</p>
2 daniel-mar 199
 
200
 
201
</div>