home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _feb4f340862abe5bccdcd210630942a2 < prev    next >
Text File  |  2000-03-23  |  16KB  |  389 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>XML::PPD - PPD file format and XML parsing elements</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> XML::PPD - PPD file format and XML parsing elements</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#major elements">MAJOR ELEMENTS</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#softpkg">SOFTPKG</A></LI>
  29.         <LI><A HREF="#implementation">IMPLEMENTATION</A></LI>
  30.         <LI><A HREF="#dependency">DEPENDENCY</A></LI>
  31.     </UL>
  32.  
  33.     <LI><A HREF="#minor elements">MINOR ELEMENTS</A></LI>
  34.     <UL>
  35.  
  36.         <LI><A HREF="#title">TITLE</A></LI>
  37.         <LI><A HREF="#abstract">ABSTRACT</A></LI>
  38.         <LI><A HREF="#author">AUTHOR</A></LI>
  39.         <LI><A HREF="#language">LANGUAGE</A></LI>
  40.         <LI><A HREF="#license">LICENSE</A></LI>
  41.         <LI><A HREF="#os">OS</A></LI>
  42.         <LI><A HREF="#osversion">OSVERSION</A></LI>
  43.         <LI><A HREF="#perlcore">PERLCORE</A></LI>
  44.         <LI><A HREF="#processor">PROCESSOR</A></LI>
  45.         <LI><A HREF="#codebase">CODEBASE</A></LI>
  46.         <LI><A HREF="#install">INSTALL</A></LI>
  47.         <LI><A HREF="#uninstall">UNINSTALL</A></LI>
  48.     </UL>
  49.  
  50.     <LI><A HREF="#document type definition">DOCUMENT TYPE DEFINITION</A></LI>
  51.     <LI><A HREF="#sample ppd file">SAMPLE PPD FILE</A></LI>
  52.     <LI><A HREF="#known bugs/issues">KNOWN BUGS/ISSUES</A></LI>
  53.     <LI><A HREF="#authors">AUTHORS</A></LI>
  54.     <LI><A HREF="#history">HISTORY</A></LI>
  55.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  56. </UL>
  57. <!-- INDEX END -->
  58.  
  59. <HR>
  60. <P>
  61. <H1><A NAME="name">NAME</A></H1>
  62. <P>XML::PPD - PPD file format and XML parsing elements</P>
  63. <P>
  64. <HR>
  65. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  66. <UL>
  67. <LI>Linux</LI>
  68. <LI>Solaris</LI>
  69. <LI>Windows</LI>
  70. </UL>
  71. <HR>
  72. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  73. <PRE>
  74.  use XML::Parser;
  75.  use XML::PPD;</PRE>
  76. <PRE>
  77.  $p = new XML::Parser( Style => 'Objects', Pkg => 'XML::PPD' );
  78.  ...</PRE>
  79. <P>
  80. <HR>
  81. <H1><A NAME="description">DESCRIPTION</A></H1>
  82. <P>This module provides a set of classes for parsing PPD files using the
  83. <CODE>XML::Parser</CODE> module.  Each of the classes is derived from
  84. <CODE>XML::ValidatingElement</CODE>, with optional/required attributes/children
  85. enforced.</P>
  86. <P>
  87. <HR>
  88. <H1><A NAME="major elements">MAJOR ELEMENTS</A></H1>
  89. <P>
  90. <H2><A NAME="softpkg">SOFTPKG</A></H2>
  91. <P>Defines a Perl Package.  The root of a PPD document is <STRONG>always</STRONG> a SOFTPKG
  92. element.  The SOFTPKG element allows for the following attributes:</P>
  93. <DL>
  94. <DT><STRONG><A NAME="item_NAME">NAME</A></STRONG><BR>
  95. <DD>
  96. Required attribute.  Name of the package (e.g. ``Foobar'').
  97. <P></P>
  98. <DT><STRONG><A NAME="item_VERSION">VERSION</A></STRONG><BR>
  99. <DD>
  100. Version number of the package, in comma-delimited format (e.g. ``1,0,0,0'').
  101. <P></P></DL>
  102. <P>
  103. <H2><A NAME="implementation">IMPLEMENTATION</A></H2>
  104. <P>Child of SOFTPKG, used to describe a particular implementation of the Perl
  105. Package.  Multiple instances are valid, and should be used to describe
  106. different implementations/ports for different operating systems or
  107. architectures.</P>
  108. <P>
  109. <H2><A NAME="dependency">DEPENDENCY</A></H2>
  110. <P>Child of SOFTPKG or IMPLEMENTATION, used to indicate a dependency this Perl
  111. Package has on another Perl Package.  Multiple instances are valid.  The
  112. DEPENDENCY element allows for the following attributes:</P>
  113. <DL>
  114. <DT><STRONG>NAME</STRONG><BR>
  115. <DD>
  116. Name of the package that this implementation is dependant upon.
  117. <P></P>
  118. <DT><STRONG>VERSION</STRONG><BR>
  119. <DD>
  120. Version number of the dependency, in comma-delimited format (e.g. ``1,0,0,0'').
  121. <P></P></DL>
  122. <P>
  123. <HR>
  124. <H1><A NAME="minor elements">MINOR ELEMENTS</A></H1>
  125. <P>
  126. <H2><A NAME="title">TITLE</A></H2>
  127. <P>Child of SOFTPKG, used to state the title of the Perl Package.  Only one
  128. instance should be present.</P>
  129. <P>
  130. <H2><A NAME="abstract">ABSTRACT</A></H2>
  131. <P>Child of SOFTPKG, used to provide a short description outlining the nature and
  132. purpose of the Perl Package.  Only one instance should be present.</P>
  133. <P>
  134. <H2><A NAME="author">AUTHOR</A></H2>
  135. <P>Child of SOFTPKG, used to provide information about the <CODE>author(s)</CODE> of the Perl
  136. Package.  Multiple instances are valid.</P>
  137. <P>
  138. <H2><A NAME="language">LANGUAGE</A></H2>
  139. <P>Child of IMPLEMENTATION, used to specify the language used within the given
  140. implementation of the Perl Package.  Only one instance should be present.</P>
  141. <P>
  142. <H2><A NAME="license">LICENSE</A></H2>
  143. <P>Child of SOFTPKG, indicating the location of the appropriate license agreement
  144. or copyright notice for the Perl Package.  Only one instance should be
  145. present.  The LICENSE element allows for the following attributes:</P>
  146. <DL>
  147. <DT><STRONG><A NAME="item_HREF">HREF</A></STRONG><BR>
  148. <DD>
  149. Required attribute.  A reference to the location of the license agreement or
  150. copyright notice for this package.
  151. <P></P></DL>
  152. <P>
  153. <H2><A NAME="os">OS</A></H2>
  154. <P>Child of IMPLEMENTATION, used to outline the operating system required for this
  155. implementation of the Perl Package.  Multiple instances are valid.  Valid
  156. values can be taken from the OSD Specification and it's OS element.  The OS
  157. element allows for the following attributes:</P>
  158. <DL>
  159. <DT><STRONG><A NAME="item_VALUE">VALUE</A></STRONG><BR>
  160. <DD>
  161. The name of the operating system required for this implementation of the Perl
  162. Package.  This value should be obtained from Config.pm as 'osname'.
  163. <P></P></DL>
  164. <P>Note that previous versions of the PPD format used a 'NAME' attribute.  It's
  165. use has been deprecated in preference of the 'VALUE' attribute.  Also note that
  166. during validation, this element will automatically convert any existing 'NAME'
  167. attribute to be a 'VALUE' attribute.</P>
  168. <P>
  169. <H2><A NAME="osversion">OSVERSION</A></H2>
  170. <P>Child of IMPLEMENTATION, used to outline the required version of the operating
  171. system required for this implementation of the Perl Package.  Only one instance
  172. should be present.  The OSVERSION element allows for the following attributes:</P>
  173. <DL>
  174. <DT><STRONG>VALUE</STRONG><BR>
  175. <DD>
  176. The version of the operating system required for installation of this
  177. implementation of the package, in a comma-delimited format (e.g. ``3,1,0,0'').
  178. <P></P></DL>
  179. <P>Note that previous versions of the PPD format used a 'NAME' attribute.  It's
  180. use has been deprecated in preference of the 'VALUE' attribute.  Also note that
  181. during validation, this element will automatically convert any existing 'NAME'
  182. attribute to be a 'VALUE' attribute.</P>
  183. <P>
  184. <H2><A NAME="perlcore">PERLCORE</A></H2>
  185. <P>Child of IMPLEMENTATION, used to specify the minimum version of the Perl core
  186. distribution that this Perl Package is to be used with.  Only one instance
  187. should be present.  The PERLCORE element allows for the following attributes:</P>
  188. <DL>
  189. <DT><STRONG>VERSION</STRONG><BR>
  190. <DD>
  191. Version of the Perl core that is required for this implementation of the Perl
  192. Package.
  193. <P></P></DL>
  194. <P>
  195. <H2><A NAME="processor">PROCESSOR</A></H2>
  196. <P>Child of IMPLEMENTATION, outlining the cpu required for this implementation
  197. of the Perl Package.  Only one instance should be present.  The PROCESSOR
  198. element allows for the following attributes:</P>
  199. <DL>
  200. <DT><STRONG>VALUE</STRONG><BR>
  201. <DD>
  202. CPU required for the installation of this implementation of the Perl Package.
  203. The following values are all valid according to the OSD Specification:
  204. <PRE>
  205.  x86 alpha mips sparc 680x0</PRE>
  206. <P></P></DL>
  207. <P>Note that previous versions of the PPD format used a 'NAME' attribute.  It's
  208. use has been deprecated in preference of the 'VALUE' attribute.  Also note that
  209. during validation, this element will automatically convert any existing 'NAME'
  210. attribute to be a 'VALUE' attribute.</P>
  211. <P>
  212. <H2><A NAME="codebase">CODEBASE</A></H2>
  213. <P>Child of IMPLEMENTATION, indicating a location where an archive of the Perl
  214. Package can be retrieved.  Multiple instances are valid, and can be used to
  215. indicate multiple possible locations where the same version of the Perl Package
  216. can be retrieved.  The CODEBASE element allows for the following attributes:</P>
  217. <DL>
  218. <DT><STRONG><A NAME="item_FILENAME">FILENAME</A></STRONG><BR>
  219. <DD>
  220. ???
  221. <P></P>
  222. <DT><STRONG>HREF</STRONG><BR>
  223. <DD>
  224. Required attribute.  A reference to the location of the Perl Package
  225. distribution.
  226. <P></P></DL>
  227. <P>
  228. <H2><A NAME="install">INSTALL</A></H2>
  229. <P>Child of IMPLEMENTATION, used to provide either a reference to an
  230. installation script or a series of commands which can be used to install
  231. the Perl Package once it has been retrieved.  If the EXEC attribute is not
  232. specified, the value is assumed to be one or more commands, separated by
  233. `;;'.  Each such command will be executed by the Perl `system()' function.
  234. Only one instance should be present.  The INSTALL element allows for
  235. the following attributes:</P>
  236. <DL>
  237. <DT><STRONG>HREF</STRONG><BR>
  238. <DD>
  239. Reference to an external script which should be retrieved and run as part
  240. of the installation process.  Both filenames and URLs should be considered
  241. valid.
  242. <P></P>
  243. <DT><STRONG><A NAME="item_EXEC">EXEC</A></STRONG><BR>
  244. <DD>
  245. Name of interpreter/shell used to execute the installation script.
  246. If the value of EXEC is `PPM_PERL', the copy of Perl that is executing
  247. PPM itself ($^X) is used to execute the install script.
  248. <P></P></DL>
  249. <P>
  250. <H2><A NAME="uninstall">UNINSTALL</A></H2>
  251. <P>Child of IMPLEMENTATION, used to provide either a reference to an
  252. uninstallation script or a raw Perl script which can be used to uninstall the
  253. Perl Package at a later point.  Only one instance should be present.  The
  254. UNINSTALL element allows for the following attributs:</P>
  255. <DL>
  256. <DT><STRONG>HREF</STRONG><BR>
  257. <DD>
  258. Reference to an external script which should be retrieved and run as part of
  259. the removal process.  Both filenames and URLs should be considered valid.
  260. <P></P>
  261. <DT><STRONG>EXEC</STRONG><BR>
  262. <DD>
  263. Name of interpreter/shell used to execute the uninstallation script.
  264. If the value of EXEC is `PPM_PERL', the copy of Perl that is executing
  265. PPM itself ($^X) is used to execute the install script.
  266. <P></P></DL>
  267. <P>
  268. <HR>
  269. <H1><A NAME="document type definition">DOCUMENT TYPE DEFINITION</A></H1>
  270. <P>The DTD for PPD documents is available from the ActiveState website and the
  271. latest version can be found at <A HREF="http://www.ActiveState.com/PPM/DTD/ppd.dtd">http://www.ActiveState.com/PPM/DTD/ppd.dtd</A></P>
  272. <P>This revision of the <CODE>XML::PPD</CODE> module implements the following DTD:</P>
  273. <PRE>
  274.  <!ELEMENT SOFTPKG   (ABSTRACT | AUTHOR | IMPLEMENTATION | LICENSE | TITLE)*>
  275.  <!ATTLIST SOFTPKG   NAME    CDATA #REQUIRED
  276.                      VERSION CDATA #IMPLIED></PRE>
  277. <PRE>
  278.  <!ELEMENT TITLE     (#PCDATA)></PRE>
  279. <PRE>
  280.  <!ELEMENT ABSTRACT  (#PCDATA)></PRE>
  281. <PRE>
  282.  <!ELEMENT AUTHOR    (#PCDATA)></PRE>
  283. <PRE>
  284.  <!ELEMENT LICENSE   EMPTY>
  285.  <!ATTLIST LICENSE   HREF     CDATA #REQUIRED></PRE>
  286. <PRE>
  287.  <!ELEMENT IMPLEMENTATION    (CODEBASE | DEPENDENCY | LANGUAGE | OS |
  288.                               OSVERSION | PERLCORE | PROCESSOR | INSTALL |
  289.                               UNINSTALL) *></PRE>
  290. <PRE>
  291.  <!ELEMENT CODEBASE  EMPTY>
  292.  <!ATTLIST CODEBASE  FILENAME CDATA #IMPLIED
  293.                      HREF     CDATA #REQUIRED></PRE>
  294. <PRE>
  295.  <!ELEMENT DEPENDENCY EMPTY>
  296.  <!ATTLIST DEPENDENCY VERSION CDATA #IMPLIED
  297.                       NAME CDATA #REQUIRED></PRE>
  298. <PRE>
  299.  <!ELEMENT LANGUAGE  EMPTY>
  300.  <!ATTLIST LANGUAGE  VALUE CDATA #REQUIRED></PRE>
  301. <PRE>
  302.  <!ELEMENT OS        EMPTY>
  303.  <!ATTLIST OS        VALUE CDATA #REQUIRED></PRE>
  304. <PRE>
  305.  <!ELEMENT OSVERSION EMPTY>
  306.  <!ATTLIST OSVERSION VALUE CDATA #REQUIRED></PRE>
  307. <PRE>
  308.  <!ELEMENT PERLCORE  EMPTY>
  309.  <!ATTLIST PERLCORE  VERSION CDATA #REQUIRED></PRE>
  310. <PRE>
  311.  <!ELEMENT PROCESSOR EMPTY>
  312.  <!ATTLIST PROCESSOR VALUE CDATA #REQUIRED></PRE>
  313. <PRE>
  314.  <!ELEMENT INSTALL   (#PCDATA)>
  315.  <!ATTLIST INSTALL   HREF  CDATA #IMPLIED
  316.                      EXEC  CDATA #IMPLIED></PRE>
  317. <PRE>
  318.  <!ELEMENT UNINSTALL (#PCDATA)>
  319.  <!ATTLIST UNINSTALL HREF  CDATA #IMPLIED
  320.                      EXEC  CDATA #IMPLIED></PRE>
  321. <P>
  322. <HR>
  323. <H1><A NAME="sample ppd file">SAMPLE PPD FILE</A></H1>
  324. <P>The following is a sample PPD file describing the <CODE>Math-MatrixBool</CODE> module.
  325. Note that this may <STRONG>not</STRONG> be a current/proper description of this module and is
  326. for sample purposes only.</P>
  327. <PRE>
  328.  <SOFTPKG NAME="Math-MatrixBool" VERSION="4,2,0,0">
  329.      <TITLE>Math-MatrixBool</TITLE>
  330.      <ABSTRACT>Easy manipulation of matrices of booleans (Boolean Algebra)</ABSTRACT>
  331.      <AUTHOR>Steffen Beyer (sb@sdm.de)</AUTHOR>
  332.      <LICENSE HREF="<A HREF="http://www.ActiveState.com/packages/Math-MatrixBool/license.html"">http://www.ActiveState.com/packages/Math-MatrixBool/license.html"</A>; />
  333.      <IMPLEMENTATION>
  334.          <OS VALUE="WinNT" />
  335.          <OS VALUE="Win95" />
  336.          <PROCESSOR VALUE="x86" />
  337.          <CODEBASE HREF="<A HREF="http://www.ActiveState.com/packages/Math-MatrixBool/Math-MatrixBool-4.2-bin-1-Win32.tar.gz"">http://www.ActiveState.com/packages/Math-MatrixBool/Math-MatrixBool-4.2-bin-1-Win32.tar.gz"</A>; />
  338.          <DEPENDENCY NAME="Bit-Vector" />
  339.          <INSTALL>
  340.          </INSTALL>
  341.          <UNINSTALL>
  342.          </UNINSTALL>
  343.      </IMPLEMENTATION></PRE>
  344. <PRE>
  345.      <IMPLEMENTATION>
  346.          <DEPENDENCY NAME="Bit-Vector" />
  347.          <CODEBASE HREF="&CPAN;/CPAN/modules/by-module/Math/Math-MatrixBool-4.2.tar.gz" />
  348.          <INSTALL>
  349.              system("make"); ;;
  350.              system("make test"); ;;
  351.              system("make install"); ;;
  352.          </INSTALL>
  353.      </IMPLEMENTATION>
  354.  </SOFTPKG></PRE>
  355. <P>
  356. <HR>
  357. <H1><A NAME="known bugs/issues">KNOWN BUGS/ISSUES</A></H1>
  358. <P>Elements which are required to be empty (e.g. LICENSE) are not enforced as
  359. such.</P>
  360. <P>Notations above about elements for which ``only one instance'' or ``multiple
  361. instances'' are valid are not enforced; this primarily a guideline for
  362. generating your own PPD files.</P>
  363. <P>
  364. <HR>
  365. <H1><A NAME="authors">AUTHORS</A></H1>
  366. <P>Graham TerMarsch <<A HREF="mailto:grahamt@activestate.com">grahamt@activestate.com</A>></P>
  367. <P>Murray Nesbitt <<A HREF="mailto:murrayn@activestate.com">murrayn@activestate.com</A>></P>
  368. <P>Dick Hardt <<A HREF="mailto:dick_hardt@activestate.com">dick_hardt@activestate.com</A>></P>
  369. <P>
  370. <HR>
  371. <H1><A NAME="history">HISTORY</A></H1>
  372. <P>v0.1 - Initial release</P>
  373. <P>
  374. <HR>
  375. <H1><A NAME="see also">SEE ALSO</A></H1>
  376. <P><A HREF="../../../site/lib/XML/ValidatingElement.html">the XML::ValidatingElement manpage</A>,
  377. <A HREF="../../../site/lib/XML/Element.html">the XML::Element manpage</A>,
  378. <A HREF="../../../site/lib/XML/Parser.html">the XML::Parser manpage</A>,
  379. OSD Specification (http://www.microsoft.com/standards/osd/)</P>
  380. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  381. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  382. <STRONG><P CLASS=block> XML::PPD - PPD file format and XML parsing elements</P></STRONG>
  383. </TD></TR>
  384. </TABLE>
  385.  
  386. </BODY>
  387.  
  388. </HTML>
  389.