cvs: peardoc /ja/guide/developers documentation.xml
| From: | Haruki Setoyama | Date: | Wed, 07 Jul 2004 13:49:06 +0000 |
| Subject: | cvs: peardoc /ja/guide/developers documentation.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-4573@lists.php.net to get a copy of this message | ||
haruki Wed Jul 7 09:49:06 2004 EDT
Modified files:
/peardoc/ja/guide/developers documentation.xml
Log:
sync with en
http://cvs.php.net/diff.php/peardoc/ja/guide/developers/documentation.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/ja/guide/developers/documentation.xml diff -u peardoc/ja/guide/developers/documentation.xml:1.3 peardoc/ja/guide/developers/documentation.xml:1.4 --- peardoc/ja/guide/developers/documentation.xml:1.3 Thu May 20 06:03:29 2004 +++ peardoc/ja/guide/developers/documentation.xml Wed Jul 7 09:49:05 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- EN-Revision: 1.19 Maintainer: haruki Status: working --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING @@ -9,77 +9,136 @@ <chapterinfo> <author> + <firstname>Daniel</firstname> + <surname>Convissor</surname> + </author> + <author> <firstname>Martin</firstname> <surname>Jansen</surname> </author> </chapterinfo> <title>ããã¥ã¡ã³ãã®ä½æ</title> + <titleabbrev>ããã¥ã¡ã³ã</titleabbrev> <para> - This chapter provides a detailed description how to write - documentation using one of the supported formats. It is aimed at both - PEAR developers that are already maintaining packages in PEAR and at - people who are planning to contribute a new package. + ããã§ã¯ãPEARã«ãããµãã¼ããããå½¢å¼ã§ã®ããã¥ã¡ã³ãã®ä½ææ¹æ³ã«ã¤ã㦠+ 詳細ã«èª¬æãã¾ãããã§ã«ããã±ã¼ã¸ãã¡ã³ããã³ã¹ãã¦ãã PEAR éçºè ã«å ãã + ããããæ°ããããã±ã¼ã¸ãå¯ä¸ãããã¨èãã¦ããæ¹ã ã対象ã¨ãã¦ãã¾ãã </para> <sect1 id="developers.documentation.docbook"> - <title>The DocBook XML format</title> + <title>DocBook XML å½¢å¼</title> <titleabbrev>DocBook XML</titleabbrev> <para> - <ulink url="&url.docbook.xml;">DocBook</ulink> is an XML dialect - that is used by a wide range of projects to maintain their - documentation. Examples for DocBook usage in OpenSource projects are - the documentations of <ulink url="&url.kde;">KDE</ulink> and - <ulink url="&url.php;">PHP</ulink>. PEAR has opted for using - DocBook, because we believe that it provides a solid foundation for - the technical documentation for PEAR packages. + <ulink url="&url.docbook.xml;">DocBook</ulink> 㯠XML ã®æ¹è¨ã§ã + æ§ã ãªããã¸ã§ã¯ãã§ããã¥ã¡ã³ãã®ç®¡çã«ä½¿ç¨ããã¦ãã¾ãã + ãªã¼ãã³ã½ã¼ã¹ã®ããã¸ã§ã¯ãã§ã® DocBook ã®ä½¿ç¨ä¾ã¨ãã¦ã¯ã + <ulink url="&url.kde;">KDE</ulink> ã <ulink url="&url.php;">PHP</ulink> + ã®ããã¥ã¡ã³ããããã¾ãã + PEAR ãã¾ã DocBook ã使ããã¨ã¨ãã¾ãããDocBook ã«ããã + PEAR ããã±ã¼ã¸ã®æè¡ææ¸ã®ããã®å¼·åºãªåºç¤ãå¾ããããã®ã¨èãã¦ããããã§ãã </para> <para> - The trade-off for using DocBook is that it is relatively hard to - use. Testing documentation requires a number of tools to be - installed and one needs to learn a (not very complicated) XML - dialect. Once one is familiar with how DocBook works, they will - enjoy writing documentation with it though. + DocBook ã使ããã¨ã®ãã¬ã¼ããªãã¯ããã®ä½¿ç¨ãæ¯è¼çé£ããã¨ãããã¨ã + æãããã¾ããããã¥ã¡ã³ãããã¹ãããã«ãããã¼ã«ãããã¤ãã¤ã³ã¹ãã¼ã«ãã + å¿ è¦ãããã¾ãããï¼ããã»ã©è¤éã§ãªãã«ãã¦ãï¼XML ã®æ¹è¨ãè¦ããå¿ è¦ã + ããã¾ãããããããã£ãã DocBook ã®åãã«æ £ããã¨ã + DocBook ã«ããããã¥ã¡ã³ãä½æãæ¥½ãããããã«ãªãã¾ãã </para> <para> - The book <ulink url="&url.docbook.book;"><citation>DocBook: The - Definitive Guide</citation></ulink>, written by Norman Walsh and - Leonard Muellner and published by <ulink - url="&url.oreilly;">O'Reilly & Associates, Inc.</ulink>, is - <ulink url="&url.docbook.book.read;">available online</ulink> and it - makes up a great resource for people interested in learning DocBook. + ã¾ããNorman Walsh, Leonard Muellner èã<ulink + url="&url.oreilly;">O'Reilly & Associates, Inc.</ulink> åºçã®æ¸ç±ã + <ulink url="&url.docbook.book;"><citation>DocBook: The + Definitive Guide</citation></ulink> ã + <ulink url="&url.docbook.book.read;">ãªã³ã©ã¤ã³ã§</ulink> + èªããã¨ãã§ãã¾ãã + DocBook ãå¦ã¼ãã¨ãã人ã ã«ã¨ã£ã¦ããã®æ¸ç±ã¯è²´éãªè³æã§ãã </para> <para> - Definitely check out the book's - <ulink url="&url.docbook.book.reference;"> - <quote>DocBook Element Reference</quote></ulink> section. - This portion provides detailed information about - <emphasis>each</emphasis> element, including which elements - can (and must) be used as parents and children. + æ¯éã¨ããã®æ¸ç±ã®<ulink url="&url.docbook.book.reference;"> + <quote>DocBook Element Reference</quote></ulink> ã®ç« ãèªãã§ãã ããã + <emphasis>ãã¹ã¦ã®</emphasis> è¦ç´ ã«ã¤ãã¦ã + ã©ã®è¦ç´ ã親ã«ãªããã¾ãåã«ãªããããªã©ã + è©³ç´°ãªæ å ±ãè¨è¼ããã¦ãã¾ãã </para> <sect2> - <title>Required software</title> + <title>å¿ è¦ãªã½ããã¦ã¨ã¢</title> <para> - Even if DocBook XML can (like any other XML file) be written using - a normal text editor, one needs to install some software on their - machine in order to test the validity of the documenting - efforts. A list of the required software and a installation - instruction can be found in the + DocBook XML ã¯ï¼ä»ã® XML ãã¡ã¤ã«ã¨åæ§ã«ï¼é常ã®ããã¹ãã¨ãã£ã¿ã§ + ç·¨éã§ãã¾ããã使ããããã¥ã¡ã³ãã®å¦¥å½æ§ãæ¤è¨¼ããããã« + ã½ãããå¹¾ã¤ãã¤ã³ã¹ãã¼ã«ããã¨è¯ãã§ãããã + å¿ è¦ãªã½ããã¦ã¨ã¢ã¨ãã®ã¤ã³ã¹ãã¼ã«æ¹æ³ã¯ã <ulink url="&url.php.manual.howto;">PHP Documentation - HOWTO</ulink>. Apart from providing information about the software, - this HOWTO also provides a ton of other useful - information that goes far beyond this chapter. One is encouraged to - completely read it. (Chapter II can be skipped, because it only - contains information that is very PHP specific.) + HOWTO</ulink> ãåç §ãã¦ãã ããã + ã½ããã¦ã¨ã¢ã«ã¤ãã¦ä»¥å¤ã«ããæ¬ææ¸ä»¥ä¸ã«å½¹ã«ç«ã¤æ å ±ãæ°å¤ã + è¨ããã¦ãã¾ãï¼ç¬¬2ç« ã¯ PHP ç¹æã®äºé ã«ã¤ãã¦ã®æ å ±ãæ±ã£ã¦ããã®ã§ã + é£ã°ããã¨ãã§ãã¾ãï¼ã </para> + <para> - Once the necessary software is in place, one has to get the latest - version of the XML sources from PEAR's CVS repository: + æ®å¿µãªãããç¹å®ã®ç°å¢ã§ã¯ã½ããã¦ã¨ã¢ã®ã¤ã³ã¹ãã¼ã«ã + é£ããå ´åããããã¾ãã + ããããã½ããã¦ã¨ã¢ãé©åã«åä½ããããã¨ãåºæ¥ãªãããã¨ãã£ã¦ã + ããã¥ã¡ã³ããæ¸ããªããã¨ã®è¨ã訳ã«ã¯ãªãã¾ããã + 2æéãã¨ã«èªåã§ peardoc ã CVS ãããã¦ã³ãã¼ãããã«ãããã + 2æ©ã®ãã¹ããµã¼ããããã¾ãã + ããªãã夿´ãå ãããã¨ã«ãããã¼ã¹ã¨ã©ã¼ã¯ã + ãã«ãå¾ã®ãã°ã«ã¦è¦ããã¨ãã§ãã¾ãã + <simplelist> + <member> + <ulink url="&url.doc.test.build.1.log;"> + &url.doc.test.build.1.log;</ulink> + (time zone: EET = UTC+2, EEST = UTC+3) + </member> + <member> + <ulink url="&url.doc.test.build.2.log;"> + &url.doc.test.build.2.log;</ulink> + (time zone: CET = UTC+1, CEST = UTC+2) + </member> + <member> + <ulink url="&url.doc.test.build.2.errlog;"> + &url.doc.test.build.2.errlog;</ulink> + </member> + </simplelist> + + PEAR ã® WEB ãµã¤ãã«ã¢ãããããããã¥ã¢ã«ã¯ã + é±ã«ä¸åº¦ï¼æ¥æã® ~12:00 UTCï¼ã ããã«ãããã¾ãã + ã§ãã®ã§ããã®èªåãã«ãã«ãã£ã¦ãå ãã夿´ãå®éã®ããã¥ã¢ã«ã§ + ã©ã®ããã«è¦ãããããã§ãã¯ããã®ãè¯ãã§ãããã + <simplelist> + <member> + <ulink url="&url.doc.test.build.1;"> + &url.doc.test.build.1;</ulink> + </member> + <member> + <ulink url="&url.doc.test.build.2;"> + &url.doc.test.build.2;</ulink> + </member> + </simplelist> + + <warning> + <para> + PEAR ã® WEB ãµã¤ãã«ã¢ãããããããã¥ã¢ã«ã¯ã + é±ã«ä¸åº¦ãã«ãããã¾ãã + XML ã®å¦¥å½æ§ãã§ãã¯æã«ã¨ã©ã¼ãèµ·ããã¨ããã«ãã失æãã¾ãã + ãã«ãã失æããã¨ãå¤ããã¼ã¸ã§ã³ã®ã¾ã¾ã¨ãªãã¾ããã¤ã¾ãã + ããã¥ã¢ã«ãå¤ãã¾ã¾ã¨ãªã£ã¦ãã¾ãã¾ãã + ã§ãããã<emphasis>常ã«</emphasis> ãã¹ããã«ãã®ãã°ããã§ãã¯ãã + 夿´ã妥å½ã§ãããã¨ã確èªããããã«ãã¦ãã ããã + ããã«ãã¡ã¤ã³ãã«ããè¡ããã(æ¥æ ~12:00 UTC) + ç´åã®ã³ããã㯠<emphasis>æ§ãã¦ãã ããã</emphasis> + </para> + </warning> + </para> + + <para> + å¿ è¦ãªã½ãããæã£ãããæ¬¡ã«ãPEAR ã® CVS ãªãã¸ããªããããã¥ã¢ã«ã® XML ã½ã¼ã¹ã + åã£ã¦æ¥ãå¿ è¦ãããã¾ãã </para> <screen> <userinput> @@ -94,44 +153,41 @@ </screen> <para> - If you do not own an account for cvs.php.net, please choose - <userinput>cvsread</userinput> as the username. When asked for the - password, type <userinput>phpfi</userinput>. + cvs.php.net ã®ã¢ã«ã¦ã³ããæã£ã¦ããªãå ´åã¯ãã¦ã¼ã¶åã¨ã㦠+ <userinput>cvsread</userinput> ã使ç¨ãã + ãã¹ã¯ã¼ããèããããã<userinput>phpfi</userinput> ã¨å ¥åãã¦ãã ããã </para> <para> - After that the directory <filename>./peardoc</filename> will - contain a local copy (<quote>sandbox</quote>) of the latest - sources. If you are not yet familiar with CVS, then the online - book <ulink url="&url.cvs.book;"><quote>Open Source Development - with CVS</quote></ulink> will provide you with all the necessary - information. + ä¸è¨ãå®è¡ããã¨ã<filename>./peardoc</filename> ãã£ã¬ã¯ããªå ã« + ææ°ã®ã½ã¼ã¹ã®ãã¼ã«ã«ã³ãã¼ (<quote>sandbox</quote>) ãå¾ããã¾ãã + ããªãããCVS ã«è©³ããç¡ããã°ããªã³ã©ã¤ã³ãã㯠+ <ulink url="&url.cvs.book;"><quote>Open Source Development with CVS</quote></ulink> + ãåç §ããã¨ãå¿ è¦ãªæ å ±ãå¾ãããã§ãããã </para> </sect2> <sect2> - <title>Directory structure</title> + <title>ãã£ã¬ã¯ããªæ§é </title> <para> - This chapter will not describe all the details about the directory - structure, because one can find out the essentials about it by - browsing the previously created directory - <filename>peardoc</filename>. As a starting point for package - documentors <filename>peardoc/en/package/</filename> fits well. If - one has further questions concerning the directory structure, they - can ask on the <ulink url="mailto:&email.pear.doc;">documentation - mailinglist</ulink>. + 使ããããã£ã¬ã¯ã㪠<filename>peardoc</filename> ãè¦ãã°æ¦è¦ã + å¤ãã¨æãã¾ãã®ã§ãããã§ã¯ããã£ã¬ã¯ããªæ§é ã®å®å ¨ãªè©³ç´°ã«ã¤ãã¦ã¯è¿°ã¹ã¾ããã + ããã±ã¼ã¸ã«é¢ããææ¸ã使ããå ´åã«ã¯ãã¯ããã«ã + <filename>peardoc/en/package/</filename> ãã£ã¬ã¯ããªãè¦ãã¨è¯ãã§ãããã + ãã£ã¬ã¯ããªæ§é ã«ã¤ãã¦ããã®ä»ã®è³ªåãããå ´åã¯ã + <ulink url="mailto:&email.pear.doc;">ææ¸é¢é£ã¡ã¼ãªã³ã°ãªã¹ã + (documentation list)</ulink> ã§ãããã¦ãã ããã </para> </sect2> <sect2> - <title>Writing documentation</title> + <title>ããã¥ã¡ã³ãã®ä½æ</title> <para> - Instead of a long and boring description for writing documentation - using DocBook, we would like to point you to a bunch of - <quote>reference documents</quote>, from which you should be - able to learn quickly: + DocBook ã«ããããã¥ã¡ã³ãã®ä½æã«ã¤ãã¦ãã©ãã©ã¨è¿°ã¹ã代ããã«ã + ãã°ããçè§£ãã§ããããã + <quote>åèæç®</quote> ãå¹¾ã¤ã示ãã¾ãã <itemizedlist> <listitem> @@ -140,16 +196,14 @@ url="&url.php.cvs.peardoc.authoring;">peardoc/authoring</ulink> </simpara> <simpara> - The CVS tree has a complete set of DocBook XML templates. - These files provide the standard of how PEAR - documentation should look. + PEAR ã® CVS ããªã¼ã«ã¯ DocBook XML ã®ãã³ãã¬ã¼ããå«ã¾ãã¦ãã¾ãã + PEAR ããã¥ã¡ã³ããã©ã®ããã«è¦ãããã®æ¨æºãæä¾ãã¦ãã¾ãã </simpara> <simpara> - The simplest way to utilize them is to copy them to - your working directory, rename them accordingly, edit - the contents to match the reality of your program and - then upload them to your package's directory in the - repository. + ãã®ãã³ãã¬ã¼ããå©ç¨ããæãç°¡åãªæ¹æ³ã¯ã + ã¯ã¼ãã³ã°ãã£ã¬ã¯ããªã«ã³ãã¼ããé©åã«ãªãã¼ã ãã + ããã±ã¼ã¸ã®ããã°ã©ã ã®å®éã«åãæ§ã«å 容ãç·¨éãã + ãªãã¸ããªã®ããã±ã¼ã¸ã®ãã£ã¬ã¯ããªã«ã¢ãããã¼ããããã¨ã§ãã </simpara> </listitem> <listitem> @@ -159,12 +213,12 @@ Request</ulink> </simpara> <simpara> - The documentation for <classname>HTTP_Request</classname>, which - is a relatively small package, only consists of a bunch of - end-user documentation, which describes all of the basic - features of the package. Each feature description includes at - least one example. For small packages with only a handful of - methods this documentation type is absolutely enough. + <classname>HTTP_Request</classname> ã¯æ¯è¼çå°ããããã±ã¼ã¸ã§ã + ãã®ããã¥ã¡ã³ãã¯ãããã±ã¼ã¸ã®åºæ¬çæ©è½ã解説ãããã¨ã³ãã¦ã¼ã¶åãã® + ããã¥ã¡ã³ã群ããæ§æããã¦ãã¾ãã + åæ©è½ã®èª¬æã«ããã¦ã¯ããããªãã¨ã1ã¤ã®ãµã³ãã«ã示ããã¦ãã¾ãã + æ°åã®ã¡ã½ãããããªãå°ããªããã±ã¼ã¸ã¯ããã®ã¿ã¤ãã®ããã¥ã¡ã³ãã + 使ããã°ååã§ãã </simpara> </listitem> <listitem> @@ -174,12 +228,11 @@ Beautifier</ulink> </simpara> <simpara> - <classname>XML_Beautifier</classname> is a package that is also - relatively compact, but which supports different configuration - options. These options are described in the documentation - Additionally the documentation gives usage examples and - (unlike <classname>HTTP_Request</classname>) also - includes API documentation for its methods. + <classname>XML_Beautifier</classname> ãæ¯è¼çå°ããããã±ã¼ã¸ã§ããã + ãã¾ãã¾ãªãªãã·ã§ã³ãè¨å®ãããã¨ãå¯è½ã§ãã + ãããã®ãªãã·ã§ã³ã¯ããã¥ã¡ã³ãä¸ã§è§£èª¬ããã¦ãã¾ãã + å ãã¦ã>(<classname>HTTP_Request</classname> ã¨ç°ãªã) + ã¡ã½ããã® API ããã¥ã¡ã³ãã®ä»ã«ããããã¤ãã®ãµã³ãã«ã示ããã¦ãã¾ãã </simpara> </listitem> <listitem> @@ -188,43 +241,38 @@ url="&url.pear.cvs.peardoc;en/package/database/db/">DB</ulink> </simpara> <simpara> - <classname>DB</classname> is a large PEAR package and has - excellent documentation, including usage examples. - The <classname>DB</classname> docs carefully adhere - to the formatting specified in peardoc/authoring. - The link above goes to the DocBook source code in - the CVS repository. It might be helpful to examine - <link - linkend="package.database.db">the HTML generated therefrom</link>. + <classname>DB</classname> ã¯ãå¤§è¦æ¨¡ãªããã±ã¼ã¸ã§ã + ãã®ããã¥ã¡ã³ããããµã³ãã«ãå«ããè¯ãã§ãã¦ãã¾ãã + <classname>DB</classname> ã®ããã¥ã¡ã³ãã¯ãpeardoc/authoring + ã«ç¤ºãããå½¢å¼ã«å ¥å¿µã«å¾ã£ã¦ãã¾ããä¸ã®ãªã³ã¯ã¯ã CVS ãªãã¸ããªå ã® + XML ã½ã¼ã¹ã¸ã®ãã®ã§ãã<link linkend="package.database.db"> + HTML 夿ããããã®</link> ã調ã¹ã¦è¦ãã®ãæç¨ã§ãããã </simpara> </listitem> </itemizedlist> </para> <para> - In addition to the examples above, you will find much more - documenation examples by browsing the <filename>peardoc</filename> - directory, which contains your local version of the CVS - tree. Especially the directory - <filename>peardoc/en/packages/</filename> should be of interest for - you. You can also browse the CVS module using the <ulink - url="&url.pear.cvs.peardoc;">web interface</ulink>, including the - <ulink - url="&url.pear.cvs.peardoc;en/guide/developers/documentation.xml">raw - XML for the file you are presently reading</ulink>. + ä¸è¨ã®ä¾ã®ä»ã«ãããã¼ã«ã«ã® CVS ããªã¼ã® <filename>peardoc</filename> + ãã£ã¬ã¯ããªã«ã¯ãããã¥ã¡ã³ãã®ä¾ãããã«è©°ã¾ã£ã¦ãã¾ãã + ç¹ã«ã<filename>peardoc/en/packages/</filename> ãã£ã¬ã¯ããªãè峿·±ãã§ãããã + ã¾ããCVS ã¢ã¸ã¥ã¼ã«ã¯<ulink url="&url.pear.cvs.peardoc;">web ã§è¦ã</ulink> + ãã¨ãã§ãã¾ããããªãããä»èªãã§ãããã®ãã¡ã¤ã«ã®ç XML 㯠+ <ulink url="&url.pear.cvs.peardoc;en/guide/developers/documentation.xml"> + ãã¡ã</ulink> ã§ãã </para> </sect2> <sect2> - <title>Translating documentation</title> + <title>ããã¥ã¡ã³ãã®ç¿»è¨³</title> <para> - Translating documentation is another important task. - Not only does new documentation need to be translated - into the existing languages, additional languages are - welcome. Also, existing translations need to be brought - up to date because the English versions have been changed. - Help on how to perform the translation process is in the <link - linkend="faq.translators-revision-tracking">Revision Tracking</link> - section of the manual. + ããã¥ã¡ã³ãã®ç¿»è¨³ãéè¦ãªä»äºã§ãã + ããã¾ã§ç¿»è¨³ãè¡ããã¦ããªãè¨èªã¸ã®ç¿»è¨³ãæ°ãã«è¡ããã¨ãæè¿ã§ããã + æ°ããããã¥ã¡ã³ããå ãã£ãæã«ãããã翻訳ãããã¨ãå¿ è¦ã§ãã + ã¾ãã翻訳æ¸ã¿ã®ããã¥ã¡ã³ãããè±èªçã«å¤æ´ãå ããããã¨ã + ã¢ãããã¼ããå¿ è¦ã¨ãªãã¾ãã + 翻訳ãè¡ãæµãã¯ãæ¬ããã¥ã¢ã«ã®<link + linkend="faq.translators-revision-tracking">ãªãã¸ã§ã³ã®è¿½è·¡</link> + ã®ã»ã¯ã·ã§ã³ãåç §ãã¦ãã ããã </para> </sect2> @@ -232,13 +280,14 @@ <title>Questions?</title> <simpara> - We are well aware that we cannot cover all questions about writing - DocBook documentation in this chapter. If you have more questions - or problems, do not hesitate to get in touch with the documentation - team at <ulink - url="mailto:&email.pear.doc;">&email.pear.doc;</ulink>. - To join the pear-doc list send an email to <ulink - url="mailto:&email.pear.doc-subscribe;">&email.pear.doc-subscribe;</ulink>. + æ¬ç« ã§ãDocBook ããã¥ã¡ã³ãã®ä½æã«ã¤ãã¦ã®ãã¹ã¦ã®è³ªåã«çãããã¦ã¯ + ããªãããç¥ãã¾ããã質åãåé¡ãããå ´åã¯ã<ulink + url="mailto:&email.pear.doc;">&email.pear.doc;</ulink> ã«ã¦ã + ããã¥ã¡ã³ããã¼ã ã«æ°è»½ã«é£çµ¡ãã¨ã£ã¦ãã ããã + ææ¸é¢é£ã¡ã¼ãªã³ã°ãªã¹ã (documentation list)ã«åå ããã«ã¯ã + <ulink + url="mailto:&email.pear.doc-subscribe;">&email.pear.doc-subscribe;</ulink> + ã¸ã¡ã¼ã«ãã¦ãã ããã </simpara> </sect2> @@ -246,13 +295,13 @@ <sect1 id="developers.documentation.tips"> - <title>Tips for good documentation</title> - <titleabbrev>Documentation Tips</titleabbrev> + <title>è¯ãããã¥ã¡ã³ããæ¸ãã³ã</title> + <titleabbrev>ããã¥ã¡ã³ãã®ã³ã</titleabbrev> <para> ãã®ã»ã¯ã·ã§ã³ã§ã¯ã - ããã¥ã¡ã³ããè«ççã«æ§æããæ¹æ³ã¤ãã¦è¿°ã¹ã¾ãã - <literal>peardoc</literal> æ¨æºã«ãã + ããã¥ã¡ã³ããè«ççã«è¨è¿°ããæ¹æ³ã¤ãã¦è¿°ã¹ã¾ãã + <literal>peardoc</literal> ã®æ¨æºã«å¾ã£ã ããã¥ã¡ã³ãæ§æã®ä»æ§ãæ±ããã®ã§ã¯ããã¾ããã </para> @@ -262,61 +311,54 @@ <para> ããã±ã¼ã¸ã¯ãããåé¡ã解決ãã¾ãã ãã®åé¡ã¨ã¯ããã£ããä½ã§ãããã?ã - ããã¦ããã®åé¡ã«ã¤ãã¦ãã¨ã³ãã¦ã¼ã¶ãçè§£ãã¦ããªã - åæäºé ã¯ä½ããèãã¦ãã ããã - ï¼ã¨ã³ãã¦ã¼ã¶ã¯ããã®åé¡ã解決ãã¹ããã¨ã ã¨ãã - èãã¦ããªãããããã¾ãããï¼ + ããã¦ããã®åé¡ã«ã¤ãã¦ãã¨ã³ãã¦ã¼ã¶ãçè§£ãã¦ããªããããããªã + åæäºé ã¯ä½ããèãã¦ãã ãã + ï¼ã¨ã³ãã¦ã¼ã¶ã¯ããã®åé¡ã解決ãã¹ãäºã ã¨ããèãã¦ããªãããããã¾ããï¼ã ä¾ãã°ããã³ãã¬ã¼ãã®ããã±ã¼ã¸ã¯ãã³ã¼ãããã®ãã¶ã¤ã³ã®åé¢ã - ãã¸ãã¹ãã¸ãã¯ããã® - ãã£ã¹ãã¬ã¤ãã¸ãã¯ã®åé¢ã¨ããåé¡ã解決ãããã®ã§ãã - å¯è½ãªãã°ãåå¿ã®ããã°ã©ããçè§£ã§ãããããªç¨èªã§èª¬æãã¦ãã ããã + ãã¸ãã¹ãã¸ãã¯ããã®ãã£ã¹ãã¬ã¤ãã¸ãã¯ã®åé¢ã¨ããåé¡ã解決ãããã®ã§ãã + ãã®ã¨ãå¯è½ãªãã°ãåå¿ã®ããã°ã©ããçè§£ã§ãããããªç¨èªã§èª¬æãã¦ãã ããã </para> </listitem> <listitem> <para> ããã±ã¼ã¸ã¯ã ã©ã®ãããªç¬èªã®æ¹æ³ã§åé¡ã解決ãã¦ãã¾ããã - ã»ã¨ãã©ã®ããã¥ã¡ã³ãããæ¹æ³ã«ã¤ãã¦è¨è¿°ãã¦ãã¾ããã + å¤ãã®ããã¥ã¡ã³ããè¨è¿°ãã¦ããªãã®ããåé¡è§£æ±ºã®æ¹æ³ã«ã¤ãã¦ã§ãã ãã¨ãã°ãæ°å¤ãã®ãã³ãã¬ã¼ãã¨ã³ã¸ã³ãåå¨ãã - ãããããåãåé¡ã解決ãããã¨ãã¦ãã¾ããã - åãæ¹æ³ã§ã¯è¡ã£ã¦ãã¾ããã - ãããã¯ãã¼ã¹ã®ãã³ãã¬ã¼ãã¨ã³ã¸ã³ã¯ - ãã¸ãã¯ãã¾ã£ããæã£ã¦ãã¾ãããã - Smarty ã®ãããªãã³ãã¬ã¼ã㯠- ã¾ã£ããæ°ãããã³ãã¬ã¼ãè¨èªãå®ç¾©ãã¦ãã¾ãã - ãã³ãã¬ã¼ããã³ã³ãã¤ã«ãããã®ãããã¾ããã - è¡ããªããã®ãããã¾ãã + ãããããåãåé¡ã解決ãããã¨ãã¦ãã¾ãããåãæ¹æ³ã§ã¯è¡ã£ã¦ãã¾ããã + ãããã¯ãã¼ã¹ã®ãã³ãã¬ã¼ãã¨ã³ã¸ã³ã¯ãã¸ãã¯ãã¾ã£ããæã£ã¦ãã¾ãããã + Smarty ã®ãããªãã³ãã¬ã¼ãã¯ã¾ã£ããæ°ãããã³ãã¬ã¼ãè¨èªãå®ç¾©ãã¦ãã¾ãã + ãã³ãã¬ã¼ããã³ã³ãã¤ã«ãããã®ãããã¾ãããããªããã®ãããã¾ãã ä½ããããã±ã¼ã¸ã®ç¹å¾´ã§ãããã? - ã³ã¼ããã¾ã£ããèªãã§ããªã人ã§ããåé¡ã®è§£æ±ºã®æ¹æ³ã«ã¤ã㦠- è¯ãçè§£ã§ãã¾ãã? + ã³ã¼ããèªãã§ããªãã¦ã¼ã¶ããåé¡è§£æ±ºã®æ¹æ³ã«ã¤ãã¦è¯ãçè§£ã§ããã§ãããã? </para> </listitem> <listitem> <para> ãµã³ãã«ãããã¤ã示ãã¦ãã ããã åºæ¬çãªæ©è½ã示ãã·ã³ãã«ãªä¾ããå§ãã¦ãã ããã - ã¦ã¼ã¶ã«å¯¾ãã¦ãããã±ã¼ã¸ããã°ãã使ãå§ããæ¹æ³ã示ããã¨ã«ãªãã¾ãã - ã¾ããããè¤éãªä¾ã«ãã£ã¦ãã¦ã¼ã¶ã¯ããã±ã¼ã¸ã®ããé«åº¦ãªä½¿ç¨æ¹æ³ã - çè§£ã§ããããã«ãªãã¾ãã + ã¦ã¼ã¶ã«å¯¾ãã¦ãããã±ã¼ã¸ããã°ãã使ãå§ããæ¹æ³ã示ããã¨ãã§ãã¾ãã + ããã«ãããè¤éãªä¾ã示ããã¨ã«ãã£ã¦ã + ã¦ã¼ã¶ã¯ããé«åº¦ãªä½¿ç¨æ¹æ³ãçè§£ã§ããããã«ãªãã¾ãã </para> </listitem> <listitem> <para> ãããï¼ãããããã¨ã§ããï¼ ããã±ã¼ã¸ã®ã¤ã³ã¿ã¼ãã§ã¤ã¹ãè¤éã ã£ããã - å¤ãã®å®æ°ããã£ãããã¦ã1ã2ã®ãµã³ãã«ã§ã¯å®å ¨ã«èª¬æã§ããªãå ´åã - ããããããã¥ã¡ã³ãä¸ã§ãã¹ã¦èª¬æãã¦ãã ããã - ã¦ã¼ã¶ãå¿ ã使ããªããã°ãªããªãã¤ã³ã¿ã¼ãã§ã¤ã¹ãä¾ãã°ã + å¤ãã®å®æ°ããã£ãããã¦ã1ã2ã®ãµã³ãã«ã§ã¯å®å ¨ã«èª¬æãã§ããªãå ´åã + ãããã¤ã³ã¿ã¼ãã§ã¤ã¹ã宿°ããããã¥ã¡ã³ãä¸ã§ãã¹ã¦èª¬æãã¦ãã ããã + ã¦ã¼ã¶ãå¿ ã使ããã¨ã«ãªãã¤ã³ã¿ã¼ãã§ã¤ã¹ãä¾ãã°ã ãã¼ã¿ãã¼ã¹DSNãã¢ããªã±ã¼ã·ã§ã³ã®ã³ãã³ãã©ã¤ã³å¼æ°ã - è¨å®ãã¡ã¤ã«ã®å®æ°ããã®ä»ãã¹ã¦ã®éã³ã¼ããªè¦ç´ ã«ã¤ãã¦ã + è¨å®ãã¡ã¤ã«ã®å®æ°ããã®ä»ãã¹ã¦ã®éã³ã¼ãçãªè¦ç´ ã«ã¤ã㦠ããã¥ã¡ã³ãã使ãã¦ãã ããã </para> </listitem> <listitem> <para> æå¾ã«ãããã¥ã¡ã³ããæ ¡æ£ãã¦ãã ããã - å¯è½ãªããããªãã®ããã¸ã§ã¯ããçç¥ãã¦ããªã誰ãã«ã - ããã¥ã¡ã³ããè¦ã¦ããã£ã¦ãã ããã + ã§ãããªããããªãã®ããã¸ã§ã¯ããè¯ãç¥ããªã誰ãã« + ããã¥ã¡ã³ããèªãã§ããã£ã¦ãã ããã ããªããè¦è½ã¨ãã¦ããåæäºé ãæããã¦ãããããããã¾ããã </para> </listitem>
http://cvs.php.net/diff.php/peardoc/ja/guide/developers/documentation.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/ja/guide/developers/documentation.xml diff -u peardoc/ja/guide/developers/documentation.xml:1.3 peardoc/ja/guide/developers/documentation.xml:1.4 --- peardoc/ja/guide/developers/documentation.xml:1.3 Thu May 20 06:03:29 2004 +++ peardoc/ja/guide/developers/documentation.xml Wed Jul 7 09:49:05 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- EN-Revision: 1.19 Maintainer: haruki Status: working --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING @@ -9,77 +9,136 @@ <chapterinfo> <author> + <firstname>Daniel</firstname> + <surname>Convissor</surname> + </author> + <author> <firstname>Martin</firstname> <surname>Jansen</surname> </author> </chapterinfo> <title>ããã¥ã¡ã³ãã®ä½æ</title> + <titleabbrev>ããã¥ã¡ã³ã</titleabbrev> <para> - This chapter provides a detailed description how to write - documentation using one of the supported formats. It is aimed at both - PEAR developers that are already maintaining packages in PEAR and at - people who are planning to contribute a new package. + ããã§ã¯ãPEARã«ãããµãã¼ããããå½¢å¼ã§ã®ããã¥ã¡ã³ãã®ä½ææ¹æ³ã«ã¤ã㦠+ 詳細ã«èª¬æãã¾ãããã§ã«ããã±ã¼ã¸ãã¡ã³ããã³ã¹ãã¦ãã PEAR éçºè ã«å ãã + ããããæ°ããããã±ã¼ã¸ãå¯ä¸ãããã¨èãã¦ããæ¹ã ã対象ã¨ãã¦ãã¾ãã </para> <sect1 id="developers.documentation.docbook"> - <title>The DocBook XML format</title> + <title>DocBook XML å½¢å¼</title> <titleabbrev>DocBook XML</titleabbrev> <para> - <ulink url="&url.docbook.xml;">DocBook</ulink> is an XML dialect - that is used by a wide range of projects to maintain their - documentation. Examples for DocBook usage in OpenSource projects are - the documentations of <ulink url="&url.kde;">KDE</ulink> and - <ulink url="&url.php;">PHP</ulink>. PEAR has opted for using - DocBook, because we believe that it provides a solid foundation for - the technical documentation for PEAR packages. + <ulink url="&url.docbook.xml;">DocBook</ulink> 㯠XML ã®æ¹è¨ã§ã + æ§ã ãªããã¸ã§ã¯ãã§ããã¥ã¡ã³ãã®ç®¡çã«ä½¿ç¨ããã¦ãã¾ãã + ãªã¼ãã³ã½ã¼ã¹ã®ããã¸ã§ã¯ãã§ã® DocBook ã®ä½¿ç¨ä¾ã¨ãã¦ã¯ã + <ulink url="&url.kde;">KDE</ulink> ã <ulink url="&url.php;">PHP</ulink> + ã®ããã¥ã¡ã³ããããã¾ãã + PEAR ãã¾ã DocBook ã使ããã¨ã¨ãã¾ãããDocBook ã«ããã + PEAR ããã±ã¼ã¸ã®æè¡ææ¸ã®ããã®å¼·åºãªåºç¤ãå¾ããããã®ã¨èãã¦ããããã§ãã </para> <para> - The trade-off for using DocBook is that it is relatively hard to - use. Testing documentation requires a number of tools to be - installed and one needs to learn a (not very complicated) XML - dialect. Once one is familiar with how DocBook works, they will - enjoy writing documentation with it though. + DocBook ã使ããã¨ã®ãã¬ã¼ããªãã¯ããã®ä½¿ç¨ãæ¯è¼çé£ããã¨ãããã¨ã + æãããã¾ããããã¥ã¡ã³ãããã¹ãããã«ãããã¼ã«ãããã¤ãã¤ã³ã¹ãã¼ã«ãã + å¿ è¦ãããã¾ãããï¼ããã»ã©è¤éã§ãªãã«ãã¦ãï¼XML ã®æ¹è¨ãè¦ããå¿ è¦ã + ããã¾ãããããããã£ãã DocBook ã®åãã«æ £ããã¨ã + DocBook ã«ããããã¥ã¡ã³ãä½æãæ¥½ãããããã«ãªãã¾ãã </para> <para> - The book <ulink url="&url.docbook.book;"><citation>DocBook: The - Definitive Guide</citation></ulink>, written by Norman Walsh and - Leonard Muellner and published by <ulink - url="&url.oreilly;">O'Reilly & Associates, Inc.</ulink>, is - <ulink url="&url.docbook.book.read;">available online</ulink> and it - makes up a great resource for people interested in learning DocBook. + ã¾ããNorman Walsh, Leonard Muellner èã<ulink + url="&url.oreilly;">O'Reilly & Associates, Inc.</ulink> åºçã®æ¸ç±ã + <ulink url="&url.docbook.book;"><citation>DocBook: The + Definitive Guide</citation></ulink> ã + <ulink url="&url.docbook.book.read;">ãªã³ã©ã¤ã³ã§</ulink> + èªããã¨ãã§ãã¾ãã + DocBook ãå¦ã¼ãã¨ãã人ã ã«ã¨ã£ã¦ããã®æ¸ç±ã¯è²´éãªè³æã§ãã </para> <para> - Definitely check out the book's - <ulink url="&url.docbook.book.reference;"> - <quote>DocBook Element Reference</quote></ulink> section. - This portion provides detailed information about - <emphasis>each</emphasis> element, including which elements - can (and must) be used as parents and children. + æ¯éã¨ããã®æ¸ç±ã®<ulink url="&url.docbook.book.reference;"> + <quote>DocBook Element Reference</quote></ulink> ã®ç« ãèªãã§ãã ããã + <emphasis>ãã¹ã¦ã®</emphasis> è¦ç´ ã«ã¤ãã¦ã + ã©ã®è¦ç´ ã親ã«ãªããã¾ãåã«ãªããããªã©ã + è©³ç´°ãªæ å ±ãè¨è¼ããã¦ãã¾ãã </para> <sect2> - <title>Required software</title> + <title>å¿ è¦ãªã½ããã¦ã¨ã¢</title> <para> - Even if DocBook XML can (like any other XML file) be written using - a normal text editor, one needs to install some software on their - machine in order to test the validity of the documenting - efforts. A list of the required software and a installation - instruction can be found in the + DocBook XML ã¯ï¼ä»ã® XML ãã¡ã¤ã«ã¨åæ§ã«ï¼é常ã®ããã¹ãã¨ãã£ã¿ã§ + ç·¨éã§ãã¾ããã使ããããã¥ã¡ã³ãã®å¦¥å½æ§ãæ¤è¨¼ããããã« + ã½ãããå¹¾ã¤ãã¤ã³ã¹ãã¼ã«ããã¨è¯ãã§ãããã + å¿ è¦ãªã½ããã¦ã¨ã¢ã¨ãã®ã¤ã³ã¹ãã¼ã«æ¹æ³ã¯ã <ulink url="&url.php.manual.howto;">PHP Documentation - HOWTO</ulink>. Apart from providing information about the software, - this HOWTO also provides a ton of other useful - information that goes far beyond this chapter. One is encouraged to - completely read it. (Chapter II can be skipped, because it only - contains information that is very PHP specific.) + HOWTO</ulink> ãåç §ãã¦ãã ããã + ã½ããã¦ã¨ã¢ã«ã¤ãã¦ä»¥å¤ã«ããæ¬ææ¸ä»¥ä¸ã«å½¹ã«ç«ã¤æ å ±ãæ°å¤ã + è¨ããã¦ãã¾ãï¼ç¬¬2ç« ã¯ PHP ç¹æã®äºé ã«ã¤ãã¦ã®æ å ±ãæ±ã£ã¦ããã®ã§ã + é£ã°ããã¨ãã§ãã¾ãï¼ã </para> + <para> - Once the necessary software is in place, one has to get the latest - version of the XML sources from PEAR's CVS repository: + æ®å¿µãªãããç¹å®ã®ç°å¢ã§ã¯ã½ããã¦ã¨ã¢ã®ã¤ã³ã¹ãã¼ã«ã + é£ããå ´åããããã¾ãã + ããããã½ããã¦ã¨ã¢ãé©åã«åä½ããããã¨ãåºæ¥ãªãããã¨ãã£ã¦ã + ããã¥ã¡ã³ããæ¸ããªããã¨ã®è¨ã訳ã«ã¯ãªãã¾ããã + 2æéãã¨ã«èªåã§ peardoc ã CVS ãããã¦ã³ãã¼ãããã«ãããã + 2æ©ã®ãã¹ããµã¼ããããã¾ãã + ããªãã夿´ãå ãããã¨ã«ãããã¼ã¹ã¨ã©ã¼ã¯ã + ãã«ãå¾ã®ãã°ã«ã¦è¦ããã¨ãã§ãã¾ãã + <simplelist> + <member> + <ulink url="&url.doc.test.build.1.log;"> + &url.doc.test.build.1.log;</ulink> + (time zone: EET = UTC+2, EEST = UTC+3) + </member> + <member> + <ulink url="&url.doc.test.build.2.log;"> + &url.doc.test.build.2.log;</ulink> + (time zone: CET = UTC+1, CEST = UTC+2) + </member> + <member> + <ulink url="&url.doc.test.build.2.errlog;"> + &url.doc.test.build.2.errlog;</ulink> + </member> + </simplelist> + + PEAR ã® WEB ãµã¤ãã«ã¢ãããããããã¥ã¢ã«ã¯ã + é±ã«ä¸åº¦ï¼æ¥æã® ~12:00 UTCï¼ã ããã«ãããã¾ãã + ã§ãã®ã§ããã®èªåãã«ãã«ãã£ã¦ãå ãã夿´ãå®éã®ããã¥ã¢ã«ã§ + ã©ã®ããã«è¦ãããããã§ãã¯ããã®ãè¯ãã§ãããã + <simplelist> + <member> + <ulink url="&url.doc.test.build.1;"> + &url.doc.test.build.1;</ulink> + </member> + <member> + <ulink url="&url.doc.test.build.2;"> + &url.doc.test.build.2;</ulink> + </member> + </simplelist> + + <warning> + <para> + PEAR ã® WEB ãµã¤ãã«ã¢ãããããããã¥ã¢ã«ã¯ã + é±ã«ä¸åº¦ãã«ãããã¾ãã + XML ã®å¦¥å½æ§ãã§ãã¯æã«ã¨ã©ã¼ãèµ·ããã¨ããã«ãã失æãã¾ãã + ãã«ãã失æããã¨ãå¤ããã¼ã¸ã§ã³ã®ã¾ã¾ã¨ãªãã¾ããã¤ã¾ãã + ããã¥ã¢ã«ãå¤ãã¾ã¾ã¨ãªã£ã¦ãã¾ãã¾ãã + ã§ãããã<emphasis>常ã«</emphasis> ãã¹ããã«ãã®ãã°ããã§ãã¯ãã + 夿´ã妥å½ã§ãããã¨ã確èªããããã«ãã¦ãã ããã + ããã«ãã¡ã¤ã³ãã«ããè¡ããã(æ¥æ ~12:00 UTC) + ç´åã®ã³ããã㯠<emphasis>æ§ãã¦ãã ããã</emphasis> + </para> + </warning> + </para> + + <para> + å¿ è¦ãªã½ãããæã£ãããæ¬¡ã«ãPEAR ã® CVS ãªãã¸ããªããããã¥ã¢ã«ã® XML ã½ã¼ã¹ã + åã£ã¦æ¥ãå¿ è¦ãããã¾ãã </para> <screen> <userinput> @@ -94,44 +153,41 @@ </screen> <para> - If you do not own an account for cvs.php.net, please choose - <userinput>cvsread</userinput> as the username. When asked for the - password, type <userinput>phpfi</userinput>. + cvs.php.net ã®ã¢ã«ã¦ã³ããæã£ã¦ããªãå ´åã¯ãã¦ã¼ã¶åã¨ã㦠+ <userinput>cvsread</userinput> ã使ç¨ãã + ãã¹ã¯ã¼ããèããããã<userinput>phpfi</userinput> ã¨å ¥åãã¦ãã ããã </para> <para> - After that the directory <filename>./peardoc</filename> will - contain a local copy (<quote>sandbox</quote>) of the latest - sources. If you are not yet familiar with CVS, then the online - book <ulink url="&url.cvs.book;"><quote>Open Source Development - with CVS</quote></ulink> will provide you with all the necessary - information. + ä¸è¨ãå®è¡ããã¨ã<filename>./peardoc</filename> ãã£ã¬ã¯ããªå ã« + ææ°ã®ã½ã¼ã¹ã®ãã¼ã«ã«ã³ãã¼ (<quote>sandbox</quote>) ãå¾ããã¾ãã + ããªãããCVS ã«è©³ããç¡ããã°ããªã³ã©ã¤ã³ãã㯠+ <ulink url="&url.cvs.book;"><quote>Open Source Development with CVS</quote></ulink> + ãåç §ããã¨ãå¿ è¦ãªæ å ±ãå¾ãããã§ãããã </para> </sect2> <sect2> - <title>Directory structure</title> + <title>ãã£ã¬ã¯ããªæ§é </title> <para> - This chapter will not describe all the details about the directory - structure, because one can find out the essentials about it by - browsing the previously created directory - <filename>peardoc</filename>. As a starting point for package - documentors <filename>peardoc/en/package/</filename> fits well. If - one has further questions concerning the directory structure, they - can ask on the <ulink url="mailto:&email.pear.doc;">documentation - mailinglist</ulink>. + 使ããããã£ã¬ã¯ã㪠<filename>peardoc</filename> ãè¦ãã°æ¦è¦ã + å¤ãã¨æãã¾ãã®ã§ãããã§ã¯ããã£ã¬ã¯ããªæ§é ã®å®å ¨ãªè©³ç´°ã«ã¤ãã¦ã¯è¿°ã¹ã¾ããã + ããã±ã¼ã¸ã«é¢ããææ¸ã使ããå ´åã«ã¯ãã¯ããã«ã + <filename>peardoc/en/package/</filename> ãã£ã¬ã¯ããªãè¦ãã¨è¯ãã§ãããã + ãã£ã¬ã¯ããªæ§é ã«ã¤ãã¦ããã®ä»ã®è³ªåãããå ´åã¯ã + <ulink url="mailto:&email.pear.doc;">ææ¸é¢é£ã¡ã¼ãªã³ã°ãªã¹ã + (documentation list)</ulink> ã§ãããã¦ãã ããã </para> </sect2> <sect2> - <title>Writing documentation</title> + <title>ããã¥ã¡ã³ãã®ä½æ</title> <para> - Instead of a long and boring description for writing documentation - using DocBook, we would like to point you to a bunch of - <quote>reference documents</quote>, from which you should be - able to learn quickly: + DocBook ã«ããããã¥ã¡ã³ãã®ä½æã«ã¤ãã¦ãã©ãã©ã¨è¿°ã¹ã代ããã«ã + ãã°ããçè§£ãã§ããããã + <quote>åèæç®</quote> ãå¹¾ã¤ã示ãã¾ãã <itemizedlist> <listitem> @@ -140,16 +196,14 @@ url="&url.php.cvs.peardoc.authoring;">peardoc/authoring</ulink> </simpara> <simpara> - The CVS tree has a complete set of DocBook XML templates. - These files provide the standard of how PEAR - documentation should look. + PEAR ã® CVS ããªã¼ã«ã¯ DocBook XML ã®ãã³ãã¬ã¼ããå«ã¾ãã¦ãã¾ãã + PEAR ããã¥ã¡ã³ããã©ã®ããã«è¦ãããã®æ¨æºãæä¾ãã¦ãã¾ãã </simpara> <simpara> - The simplest way to utilize them is to copy them to - your working directory, rename them accordingly, edit - the contents to match the reality of your program and - then upload them to your package's directory in the - repository. + ãã®ãã³ãã¬ã¼ããå©ç¨ããæãç°¡åãªæ¹æ³ã¯ã + ã¯ã¼ãã³ã°ãã£ã¬ã¯ããªã«ã³ãã¼ããé©åã«ãªãã¼ã ãã + ããã±ã¼ã¸ã®ããã°ã©ã ã®å®éã«åãæ§ã«å 容ãç·¨éãã + ãªãã¸ããªã®ããã±ã¼ã¸ã®ãã£ã¬ã¯ããªã«ã¢ãããã¼ããããã¨ã§ãã </simpara> </listitem> <listitem> @@ -159,12 +213,12 @@ Request</ulink> </simpara> <simpara> - The documentation for <classname>HTTP_Request</classname>, which - is a relatively small package, only consists of a bunch of - end-user documentation, which describes all of the basic - features of the package. Each feature description includes at - least one example. For small packages with only a handful of - methods this documentation type is absolutely enough. + <classname>HTTP_Request</classname> ã¯æ¯è¼çå°ããããã±ã¼ã¸ã§ã + ãã®ããã¥ã¡ã³ãã¯ãããã±ã¼ã¸ã®åºæ¬çæ©è½ã解説ãããã¨ã³ãã¦ã¼ã¶åãã® + ããã¥ã¡ã³ã群ããæ§æããã¦ãã¾ãã + åæ©è½ã®èª¬æã«ããã¦ã¯ããããªãã¨ã1ã¤ã®ãµã³ãã«ã示ããã¦ãã¾ãã + æ°åã®ã¡ã½ãããããªãå°ããªããã±ã¼ã¸ã¯ããã®ã¿ã¤ãã®ããã¥ã¡ã³ãã + 使ããã°ååã§ãã </simpara> </listitem> <listitem> @@ -174,12 +228,11 @@ Beautifier</ulink> </simpara> <simpara> - <classname>XML_Beautifier</classname> is a package that is also - relatively compact, but which supports different configuration - options. These options are described in the documentation - Additionally the documentation gives usage examples and - (unlike <classname>HTTP_Request</classname>) also - includes API documentation for its methods. + <classname>XML_Beautifier</classname> ãæ¯è¼çå°ããããã±ã¼ã¸ã§ããã + ãã¾ãã¾ãªãªãã·ã§ã³ãè¨å®ãããã¨ãå¯è½ã§ãã + ãããã®ãªãã·ã§ã³ã¯ããã¥ã¡ã³ãä¸ã§è§£èª¬ããã¦ãã¾ãã + å ãã¦ã>(<classname>HTTP_Request</classname> ã¨ç°ãªã) + ã¡ã½ããã® API ããã¥ã¡ã³ãã®ä»ã«ããããã¤ãã®ãµã³ãã«ã示ããã¦ãã¾ãã </simpara> </listitem> <listitem> @@ -188,43 +241,38 @@ url="&url.pear.cvs.peardoc;en/package/database/db/">DB</ulink> </simpara> <simpara> - <classname>DB</classname> is a large PEAR package and has - excellent documentation, including usage examples. - The <classname>DB</classname> docs carefully adhere - to the formatting specified in peardoc/authoring. - The link above goes to the DocBook source code in - the CVS repository. It might be helpful to examine - <link - linkend="package.database.db">the HTML generated therefrom</link>. + <classname>DB</classname> ã¯ãå¤§è¦æ¨¡ãªããã±ã¼ã¸ã§ã + ãã®ããã¥ã¡ã³ããããµã³ãã«ãå«ããè¯ãã§ãã¦ãã¾ãã + <classname>DB</classname> ã®ããã¥ã¡ã³ãã¯ãpeardoc/authoring + ã«ç¤ºãããå½¢å¼ã«å ¥å¿µã«å¾ã£ã¦ãã¾ããä¸ã®ãªã³ã¯ã¯ã CVS ãªãã¸ããªå ã® + XML ã½ã¼ã¹ã¸ã®ãã®ã§ãã<link linkend="package.database.db"> + HTML 夿ããããã®</link> ã調ã¹ã¦è¦ãã®ãæç¨ã§ãããã </simpara> </listitem> </itemizedlist> </para> <para> - In addition to the examples above, you will find much more - documenation examples by browsing the <filename>peardoc</filename> - directory, which contains your local version of the CVS - tree. Especially the directory - <filename>peardoc/en/packages/</filename> should be of interest for - you. You can also browse the CVS module using the <ulink - url="&url.pear.cvs.peardoc;">web interface</ulink>, including the - <ulink - url="&url.pear.cvs.peardoc;en/guide/developers/documentation.xml">raw - XML for the file you are presently reading</ulink>. + ä¸è¨ã®ä¾ã®ä»ã«ãããã¼ã«ã«ã® CVS ããªã¼ã® <filename>peardoc</filename> + ãã£ã¬ã¯ããªã«ã¯ãããã¥ã¡ã³ãã®ä¾ãããã«è©°ã¾ã£ã¦ãã¾ãã + ç¹ã«ã<filename>peardoc/en/packages/</filename> ãã£ã¬ã¯ããªãè峿·±ãã§ãããã + ã¾ããCVS ã¢ã¸ã¥ã¼ã«ã¯<ulink url="&url.pear.cvs.peardoc;">web ã§è¦ã</ulink> + ãã¨ãã§ãã¾ããããªãããä»èªãã§ãããã®ãã¡ã¤ã«ã®ç XML 㯠+ <ulink url="&url.pear.cvs.peardoc;en/guide/developers/documentation.xml"> + ãã¡ã</ulink> ã§ãã </para> </sect2> <sect2> - <title>Translating documentation</title> + <title>ããã¥ã¡ã³ãã®ç¿»è¨³</title> <para> - Translating documentation is another important task. - Not only does new documentation need to be translated - into the existing languages, additional languages are - welcome. Also, existing translations need to be brought - up to date because the English versions have been changed. - Help on how to perform the translation process is in the <link - linkend="faq.translators-revision-tracking">Revision Tracking</link> - section of the manual. + ããã¥ã¡ã³ãã®ç¿»è¨³ãéè¦ãªä»äºã§ãã + ããã¾ã§ç¿»è¨³ãè¡ããã¦ããªãè¨èªã¸ã®ç¿»è¨³ãæ°ãã«è¡ããã¨ãæè¿ã§ããã + æ°ããããã¥ã¡ã³ããå ãã£ãæã«ãããã翻訳ãããã¨ãå¿ è¦ã§ãã + ã¾ãã翻訳æ¸ã¿ã®ããã¥ã¡ã³ãããè±èªçã«å¤æ´ãå ããããã¨ã + ã¢ãããã¼ããå¿ è¦ã¨ãªãã¾ãã + 翻訳ãè¡ãæµãã¯ãæ¬ããã¥ã¢ã«ã®<link + linkend="faq.translators-revision-tracking">ãªãã¸ã§ã³ã®è¿½è·¡</link> + ã®ã»ã¯ã·ã§ã³ãåç §ãã¦ãã ããã </para> </sect2> @@ -232,13 +280,14 @@ <title>Questions?</title> <simpara> - We are well aware that we cannot cover all questions about writing - DocBook documentation in this chapter. If you have more questions - or problems, do not hesitate to get in touch with the documentation - team at <ulink - url="mailto:&email.pear.doc;">&email.pear.doc;</ulink>. - To join the pear-doc list send an email to <ulink - url="mailto:&email.pear.doc-subscribe;">&email.pear.doc-subscribe;</ulink>. + æ¬ç« ã§ãDocBook ããã¥ã¡ã³ãã®ä½æã«ã¤ãã¦ã®ãã¹ã¦ã®è³ªåã«çãããã¦ã¯ + ããªãããç¥ãã¾ããã質åãåé¡ãããå ´åã¯ã<ulink + url="mailto:&email.pear.doc;">&email.pear.doc;</ulink> ã«ã¦ã + ããã¥ã¡ã³ããã¼ã ã«æ°è»½ã«é£çµ¡ãã¨ã£ã¦ãã ããã + ææ¸é¢é£ã¡ã¼ãªã³ã°ãªã¹ã (documentation list)ã«åå ããã«ã¯ã + <ulink + url="mailto:&email.pear.doc-subscribe;">&email.pear.doc-subscribe;</ulink> + ã¸ã¡ã¼ã«ãã¦ãã ããã </simpara> </sect2> @@ -246,13 +295,13 @@ <sect1 id="developers.documentation.tips"> - <title>Tips for good documentation</title> - <titleabbrev>Documentation Tips</titleabbrev> + <title>è¯ãããã¥ã¡ã³ããæ¸ãã³ã</title> + <titleabbrev>ããã¥ã¡ã³ãã®ã³ã</titleabbrev> <para> ãã®ã»ã¯ã·ã§ã³ã§ã¯ã - ããã¥ã¡ã³ããè«ççã«æ§æããæ¹æ³ã¤ãã¦è¿°ã¹ã¾ãã - <literal>peardoc</literal> æ¨æºã«ãã + ããã¥ã¡ã³ããè«ççã«è¨è¿°ããæ¹æ³ã¤ãã¦è¿°ã¹ã¾ãã + <literal>peardoc</literal> ã®æ¨æºã«å¾ã£ã ããã¥ã¡ã³ãæ§æã®ä»æ§ãæ±ããã®ã§ã¯ããã¾ããã </para> @@ -262,61 +311,54 @@ <para> ããã±ã¼ã¸ã¯ãããåé¡ã解決ãã¾ãã ãã®åé¡ã¨ã¯ããã£ããä½ã§ãããã?ã - ããã¦ããã®åé¡ã«ã¤ãã¦ãã¨ã³ãã¦ã¼ã¶ãçè§£ãã¦ããªã - åæäºé ã¯ä½ããèãã¦ãã ããã - ï¼ã¨ã³ãã¦ã¼ã¶ã¯ããã®åé¡ã解決ãã¹ããã¨ã ã¨ãã - èãã¦ããªãããããã¾ãããï¼ + ããã¦ããã®åé¡ã«ã¤ãã¦ãã¨ã³ãã¦ã¼ã¶ãçè§£ãã¦ããªããããããªã + åæäºé ã¯ä½ããèãã¦ãã ãã + ï¼ã¨ã³ãã¦ã¼ã¶ã¯ããã®åé¡ã解決ãã¹ãäºã ã¨ããèãã¦ããªãããããã¾ããï¼ã ä¾ãã°ããã³ãã¬ã¼ãã®ããã±ã¼ã¸ã¯ãã³ã¼ãããã®ãã¶ã¤ã³ã®åé¢ã - ãã¸ãã¹ãã¸ãã¯ããã® - ãã£ã¹ãã¬ã¤ãã¸ãã¯ã®åé¢ã¨ããåé¡ã解決ãããã®ã§ãã - å¯è½ãªãã°ãåå¿ã®ããã°ã©ããçè§£ã§ãããããªç¨èªã§èª¬æãã¦ãã ããã + ãã¸ãã¹ãã¸ãã¯ããã®ãã£ã¹ãã¬ã¤ãã¸ãã¯ã®åé¢ã¨ããåé¡ã解決ãããã®ã§ãã + ãã®ã¨ãå¯è½ãªãã°ãåå¿ã®ããã°ã©ããçè§£ã§ãããããªç¨èªã§èª¬æãã¦ãã ããã </para> </listitem> <listitem> <para> ããã±ã¼ã¸ã¯ã ã©ã®ãããªç¬èªã®æ¹æ³ã§åé¡ã解決ãã¦ãã¾ããã - ã»ã¨ãã©ã®ããã¥ã¡ã³ãããæ¹æ³ã«ã¤ãã¦è¨è¿°ãã¦ãã¾ããã + å¤ãã®ããã¥ã¡ã³ããè¨è¿°ãã¦ããªãã®ããåé¡è§£æ±ºã®æ¹æ³ã«ã¤ãã¦ã§ãã ãã¨ãã°ãæ°å¤ãã®ãã³ãã¬ã¼ãã¨ã³ã¸ã³ãåå¨ãã - ãããããåãåé¡ã解決ãããã¨ãã¦ãã¾ããã - åãæ¹æ³ã§ã¯è¡ã£ã¦ãã¾ããã - ãããã¯ãã¼ã¹ã®ãã³ãã¬ã¼ãã¨ã³ã¸ã³ã¯ - ãã¸ãã¯ãã¾ã£ããæã£ã¦ãã¾ãããã - Smarty ã®ãããªãã³ãã¬ã¼ã㯠- ã¾ã£ããæ°ãããã³ãã¬ã¼ãè¨èªãå®ç¾©ãã¦ãã¾ãã - ãã³ãã¬ã¼ããã³ã³ãã¤ã«ãããã®ãããã¾ããã - è¡ããªããã®ãããã¾ãã + ãããããåãåé¡ã解決ãããã¨ãã¦ãã¾ãããåãæ¹æ³ã§ã¯è¡ã£ã¦ãã¾ããã + ãããã¯ãã¼ã¹ã®ãã³ãã¬ã¼ãã¨ã³ã¸ã³ã¯ãã¸ãã¯ãã¾ã£ããæã£ã¦ãã¾ãããã + Smarty ã®ãããªãã³ãã¬ã¼ãã¯ã¾ã£ããæ°ãããã³ãã¬ã¼ãè¨èªãå®ç¾©ãã¦ãã¾ãã + ãã³ãã¬ã¼ããã³ã³ãã¤ã«ãããã®ãããã¾ãããããªããã®ãããã¾ãã ä½ããããã±ã¼ã¸ã®ç¹å¾´ã§ãããã? - ã³ã¼ããã¾ã£ããèªãã§ããªã人ã§ããåé¡ã®è§£æ±ºã®æ¹æ³ã«ã¤ã㦠- è¯ãçè§£ã§ãã¾ãã? + ã³ã¼ããèªãã§ããªãã¦ã¼ã¶ããåé¡è§£æ±ºã®æ¹æ³ã«ã¤ãã¦è¯ãçè§£ã§ããã§ãããã? </para> </listitem> <listitem> <para> ãµã³ãã«ãããã¤ã示ãã¦ãã ããã åºæ¬çãªæ©è½ã示ãã·ã³ãã«ãªä¾ããå§ãã¦ãã ããã - ã¦ã¼ã¶ã«å¯¾ãã¦ãããã±ã¼ã¸ããã°ãã使ãå§ããæ¹æ³ã示ããã¨ã«ãªãã¾ãã - ã¾ããããè¤éãªä¾ã«ãã£ã¦ãã¦ã¼ã¶ã¯ããã±ã¼ã¸ã®ããé«åº¦ãªä½¿ç¨æ¹æ³ã - çè§£ã§ããããã«ãªãã¾ãã + ã¦ã¼ã¶ã«å¯¾ãã¦ãããã±ã¼ã¸ããã°ãã使ãå§ããæ¹æ³ã示ããã¨ãã§ãã¾ãã + ããã«ãããè¤éãªä¾ã示ããã¨ã«ãã£ã¦ã + ã¦ã¼ã¶ã¯ããé«åº¦ãªä½¿ç¨æ¹æ³ãçè§£ã§ããããã«ãªãã¾ãã </para> </listitem> <listitem> <para> ãããï¼ãããããã¨ã§ããï¼ ããã±ã¼ã¸ã®ã¤ã³ã¿ã¼ãã§ã¤ã¹ãè¤éã ã£ããã - å¤ãã®å®æ°ããã£ãããã¦ã1ã2ã®ãµã³ãã«ã§ã¯å®å ¨ã«èª¬æã§ããªãå ´åã - ããããããã¥ã¡ã³ãä¸ã§ãã¹ã¦èª¬æãã¦ãã ããã - ã¦ã¼ã¶ãå¿ ã使ããªããã°ãªããªãã¤ã³ã¿ã¼ãã§ã¤ã¹ãä¾ãã°ã + å¤ãã®å®æ°ããã£ãããã¦ã1ã2ã®ãµã³ãã«ã§ã¯å®å ¨ã«èª¬æãã§ããªãå ´åã + ãããã¤ã³ã¿ã¼ãã§ã¤ã¹ã宿°ããããã¥ã¡ã³ãä¸ã§ãã¹ã¦èª¬æãã¦ãã ããã + ã¦ã¼ã¶ãå¿ ã使ããã¨ã«ãªãã¤ã³ã¿ã¼ãã§ã¤ã¹ãä¾ãã°ã ãã¼ã¿ãã¼ã¹DSNãã¢ããªã±ã¼ã·ã§ã³ã®ã³ãã³ãã©ã¤ã³å¼æ°ã - è¨å®ãã¡ã¤ã«ã®å®æ°ããã®ä»ãã¹ã¦ã®éã³ã¼ããªè¦ç´ ã«ã¤ãã¦ã + è¨å®ãã¡ã¤ã«ã®å®æ°ããã®ä»ãã¹ã¦ã®éã³ã¼ãçãªè¦ç´ ã«ã¤ã㦠ããã¥ã¡ã³ãã使ãã¦ãã ããã </para> </listitem> <listitem> <para> æå¾ã«ãããã¥ã¡ã³ããæ ¡æ£ãã¦ãã ããã - å¯è½ãªããããªãã®ããã¸ã§ã¯ããçç¥ãã¦ããªã誰ãã«ã - ããã¥ã¡ã³ããè¦ã¦ããã£ã¦ãã ããã + ã§ãããªããããªãã®ããã¸ã§ã¯ããè¯ãç¥ããªã誰ãã« + ããã¥ã¡ã³ããèªãã§ããã£ã¦ãã ããã ããªããè¦è½ã¨ãã¦ããåæäºé ãæããã¦ãããããããã¾ããã </para> </listitem>