WebSVN – oidinfo_new_design – /trunk/submit.raw.htm

<div id="global_content">
<TABLE cellspacing="0" cellpadding="0" border="0" width="100%">
<TR>
<TD height="20" colspan="3" valign="top" width="100%"> </TD>
</TR>
<TR>
<TD height="40" valign="top" width="440">
Submit OID descriptions as XML files
</TD>
<TD height="40" valign="top" width="20"> </TD>
<TD width="150" height="40" valign="middle">
</TD>
</TR>
</TABLE>
<TABLE cellspacing="0" cellpadding="0" border="0" width="100%">
<TR>
<TD width="10" valign="top"></TD>
<TD valign="top" width="430">
The form below provides for the submission of XML
files containing OID descriptions conforming to the <a href="oid.xsd">XML
schema</a> of the OID repository.
<ul>
<li>
if the OID does not yet exist in the OID repository but its parent
OID is described in the Repository, it is added but the description
will not be visible until it is validated by the Repository administrator
(a notification will be sent to you by email once this is done); </li>
<li>
if the parent OID of the OID to be added does not yet exist in the
OID repository, the OID is said to be "<a href="faq.htm#orphan">orphan</a>,"
it will be added to the OID repository (after validation by the Repository
administrator) but will not be accessible for display to users who
walk down the OID tree; </li>
<li>
If the description corresponds to an OID which is already described
in the OID repository, it is ignored. </li>
</ul>
Please note that, if you submit a lot of XML descriptions, the time-out
of your browser may be reached before the results are displayed on your
screen. In any case, the results will be sent to the email address indicated
in the <tt><submitter></tt> part of the XML file.
Note 1: Daniel Marschall has developed an <a href="https://www.viathinksoft.de/%7Edaniel-marschall/oid-repository/api/">Application
Programming Interface (API) in PHP</a> which can help developers in
creating such XML files.
Note 2: If you have a text file gathering objects
in a <a href="http://en.wikipedia.org/wiki/Management_information_base">Management
Information Base</a> (MIB), you can send it to the <a href="mailto:admin&oid-info.com">OID
repository administrator</a> who has a tool to automatically extract
OIDs from such files. Please make sure that the top OID of your MIB
is defined in the file.
</TD>
<TD width="20" valign="top"> </TD>
<TD width="150" valign="top">
<img src="images/bullet.gif" width="10" height="8" border="0" align="bottom"><a href="oid.xsd">XML schema</a> for OID descriptions
<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
</TD>
</TR>
</TABLE>
<FORM method="post" action="/cgi-bin/submit" enctype="multipart/form-data" name="submit">
<TABLE cellspacing="0" cellpadding="0" border="0" width="600">
<TR>
<TD valign="middle" width="390">
File
name(a single XML file containing all the OID descriptions, or
a zipped archive of XML files):
<INPUT type="file" name="fichier" size="50">
<INPUT type="submit" name="submit" value="Submit"> </TR>
</TABLE>
<TABLE border=0 cellspacing=0 cellpadding=0 width="600" dwcopytype="CopyTableRow">
<!-- <tr>
<td> </td>
<td> </td>
</tr>
<tr>
<td valign=top height="39" bgcolor="#CCCCCC">
<input type="text" name="submit-email"> </td>
<td valign=CENTER width="454" height="19" bgcolor="#CCCCCC"> Give
your email address if you want to receive an email with the results
of your submission (when the submitted XML file is big, the time-out
of your browser can be reached before the resulting webpage is produced
and you would then miss the resulting messages)</td>
</tr>
-->
<TR>
<TD> </TD>
<TD> </TD>
</TR>
<tr>
<td align=middle valign=top height="39" bgcolor="#CCCCCC">
<input type="checkbox" name="ignoreNL" value="true"> <tt>-ignoreNL</tt>
</td>
<td valign=CENTER width="454" height="19" bgcolor="#CCCCCC">
Ignore
all newline characters used in text descriptions between XML tags. By
default, newline characters are turned into <tt> </tt> elements
when displayed in HTML. When this box is checked, newline characters
are replaced with a whitespace.
</td>
</tr>
</TABLE>
</FORM>
<a href="javascript: switchInfoPerso('xml_explanations');"><img src="images/Info.png" alt="" width="15" height="15"> See more detailed explanations</a>
<TABLE cellspacing="0" cellpadding="0" border="0" width="100%" id="xml_explanations" style="display:none;">
<TR>
<TD width="10" valign="top"></TD>
<TD valign="top" colspan="3">
The example below is an XML document that conforms to our <a href="oid.xsd">XML
schema</a> and contains the description of one OID (namely, <tt>
{joint-iso-itu-t(2)
example(999) xml-submission(777)}
</tt>).
<ul>
<li>
There can be more than one <tt><oid></tt> block per
<tt><oid-database></tt> but only one <tt><oid-database></tt>
per XML file.
</li>
<li>
A father OID does not need to be described in the file prior to
its child OIDs because the tool will sort the blocks before adding
information to the OID repository.
</li>
<li>
The <tt><submitter></tt> part
contains information about you. This information will not be displayed
when people will query the OID repository. It is at that email address
that you will receive the result of your XML submission. That email
address will also be used to keep you informed if the OID descriptions
you submitted are updated in the future.
</li>
<li>
Note that a <a href="xhtml-light.xsd">subset</a> of XHTML
is allowed inside plain text for the <tt><description></tt>,
<tt><information></tt> and <tt><address></tt> elements.
</li>
<li>
HTML entity references (such as "<tt>&eacute;</tt>")
are not supported by default, so please use decimal codes (such as
"<tt>&#233;</tt>") or include the needed <a href="http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent">XHTML
entity references</a> in a <tt><!DOCTYPE...></tt> block at the
beginning of your XML document as follows:
<tt>
<!DOCTYPE oid-database[   <!ENTITY eacute "&#233;"> <!-- latin small
letter e with acute -->   <!-- please add <a href="http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent">XHTML
entity references</a> as needed -->]>
</tt>
.
</li>
<li>
More detail about what is allowed for each XML tag is given as
<tt><documentation></tt> tags in the <a href="oid.xsd">XML schema</a>.
Please have a look at it. </li>
</ul>
<tt>
<oid-database>
<submitter>     <first-name>John</first-name>     <last-name>Smith</last-name>     <email>john.smith@myhost.com</email>   </submitter>
<oid>     <asn1-notation>{joint-iso-itu-t(2) example(999)                     xml-submission(777)}</asn1-notation>     <identifier>oid-repository</identifier>     <description>Example of a description conforming
to the
<a
href="http://oid-info.com/oid.xsd">
XML Schema of the
OID repository</a>     </description>     <information>More information can be found
in
<a
href="https://itu.int/ITU-T/X.660">
Rec. ITU-T X.660</a>.     </information>     <current-registrant>        <first-name>John</first-name>        <last-name>Doe</last-name>        <email>john.doe@dummy.com</email>        <address>Street Name           Town           Country        </address>        <modification-date>2002-05-25</modification-date>     </current-registrant>   </oid> </oid-database> </tt>
</TD>
</TR>
</TABLE>
Once added to the OID repository, the above description
will be displayed as shown on the <a href="display-example.htm">display
example</a>.
</div>

Subversion Repositories oidinfo_new_design

oidinfo_new_design/trunk/submit.raw.htm – Rev 18