cvs: peardoc /hu language-defs.ent language-snippets.ent preface.xml /hu/chapters contributing.xml installation.xml intro.xml standards.xml
support.xml /hu/guide/developers intro.xml /hu/package/database/db db.ent /hu/package/database/mdb mdb.ent
| From: | Norbert Mocsnik | Date: | Fri, 14 May 2004 21:10:47 +0000 |
| Subject: | cvs: peardoc /hu language-defs.ent language-snippets.ent preface.xml /hu/chapters contributing.xml installation.xml intro.xml standards.xml support.xml /hu/guide/developers intro.xml /hu/package/database/db db.ent /hu/package/database/mdb mdb.ent |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3978@lists.php.net to get a copy of this message | ||
norbert_m Fri May 14 17:10:47 2004 EDT
Modified files:
/peardoc/hu language-defs.ent language-snippets.ent preface.xml
/peardoc/hu/chapters contributing.xml installation.xml intro.xml
standards.xml support.xml
/peardoc/hu/guide/developers intro.xml
/peardoc/hu/package/database/db db.ent
/peardoc/hu/package/database/mdb mdb.ent
Log:
sync to up-to-date english files + added revision tags
http://cvs.php.net/diff.php/peardoc/hu/language-defs.ent?r1=1.4&r2=1.5&ty=u Index: peardoc/hu/language-defs.ent diff -u peardoc/hu/language-defs.ent:1.4 peardoc/hu/language-defs.ent:1.5 --- peardoc/hu/language-defs.ent:1.4 Sat Feb 28 10:27:13 2004 +++ peardoc/hu/language-defs.ent Fri May 14 17:10:46 2004 @@ -1,4 +1,4 @@ -<!-- Sync: 1.1 --> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <!ENTITY PEARManual "PEAR Kézikönyv"> <!ENTITY Date "Dátum:"> http://cvs.php.net/diff.php/peardoc/hu/language-snippets.ent?r1=1.4&r2=1.5&ty=u Index: peardoc/hu/language-snippets.ent diff -u peardoc/hu/language-snippets.ent:1.4 peardoc/hu/language-snippets.ent:1.5 --- peardoc/hu/language-snippets.ent:1.4 Wed Apr 14 12:27:05 2004 +++ peardoc/hu/language-snippets.ent Fri May 14 17:10:46 2004 @@ -1,4 +1,4 @@ -<!-- Sync: 1.1 --> +<!-- EN-Revision: 1.11 Maintainer: norbert_m Status: ready --> <!ENTITY warn.experimental '<warning><simpara>Ez a modul jelenleg <emphasis>kísérleti jellegû</emphasis>. Ez azt jelenti, hogy a függvények @@ -37,7 +37,7 @@ függvény visszatérési értékének vizsgálatára!</simpara></warning>'> <!ENTITY link.coding-standards 'PEAR <link linkend="standards">kódolási -szabványok.</link>'> +szabályok.</link>'> <!ENTITY note.canstatic '<simpara>Ez a függvény meghívható statikusan. </simpara>'> @@ -45,11 +45,11 @@ <!ENTITY note.shouldstatic '<simpara>Ez a függvény statikus meghívásra van felkészítve!</simpara>'> -<!ENTITY note.notstatic '<simpara>Ez a függvény nem hívható meg +<!ENTITY note.notstatic '<simpara>Ez a függvény nem hívható statikusan.</simpara>'> -<!ENTITY note.deprecated '<warning><para>Ez a függvény többé -<emphasis>nem érvényes</emphasis>. Ez azt jelenti, hogy a csomag jövõbeli +<!ENTITY note.deprecated '<warning><para>Ez a függvény <emphasis>érvénytelenítve +</emphasis> lett. Ez azt jelenti, hogy a csomag jövõbeli verziói lehetséges, hogy nem fogják támogatni.</para></warning>'> <!ENTITY title.desc '<title>Leírás</title>'> @@ -57,7 +57,7 @@ <!ENTITY title.deprecated '<title>Érvénytelenítve</title>'> <!ENTITY title.returns '<title>Visszatérési érték</title>'> <!ENTITY title.throws '<title>Lehetséges hibaértékek</title>'> -<!ENTITY title.throws.errortable 'Lehetséges PEAR_Error értékek'> +<!ENTITY title.throws.errortable 'Lehetséges PEAR_Error visszatérési értékek'> <!ENTITY title.note '<title>Megjegyzés</title>'> <!ENTITY title.example '<title>Példa</title>'> <!ENTITY title.see '<title>Lásd</title>'> http://cvs.php.net/diff.php/peardoc/hu/preface.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/hu/preface.xml diff -u peardoc/hu/preface.xml:1.2 peardoc/hu/preface.xml:1.3 --- peardoc/hu/preface.xml:1.2 Sat Feb 28 10:27:13 2004 +++ peardoc/hu/preface.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.7 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.17 Maintainer: norbert_m Status: ready --> <preface id="preface"> <title>Elõszó</title> http://cvs.php.net/diff.php/peardoc/hu/chapters/contributing.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/hu/chapters/contributing.xml diff -u peardoc/hu/chapters/contributing.xml:1.2 peardoc/hu/chapters/contributing.xml:1.3 --- peardoc/hu/chapters/contributing.xml:1.2 Mon Apr 19 11:43:47 2004 +++ peardoc/hu/chapters/contributing.xml Fri May 14 17:10:46 2004 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-2" ?> -<!-- $Revision: 1.2 $ --> -<!-- EN-Revision: 1.13 Maintainer: danielc Status: added english for doc/translate section --> +<!-- EN-Revision: 1.13 Maintainer: norbert_m Status: ready --> <chapter id="contributing"> <docinfo> <author> @@ -141,23 +140,22 @@ </sect1> <sect1 id="contributing.documentation"> - <title>Writing & Translating Documentation</title> + <title>Dokumentáció írás és fordítás</title> <para> - Good documentation is essential for users to fully understand any - software. Several PEAR packages lack documentation or have docs which - need improvement. <link - linkend="developers.documentation">Writing documentation</link> - provides more information about helping out on this front. - </para> - <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. + A jó dokumentáció az alapja, hogy a felhasználók megfelelõen megértsenek + egy szoftvert. Néhány PEAR csomag még nem rendelkezik dokumentációval, + vagy dokumentációja fejlesztésre szorul. + Ezzel kapcsolatban a <link + linkend="developers.documentation">Dokumentáció írása</link> + fejezet nyújt további információt. + </para> + <para> + A dokumentáció fordítása a másik fontos feladat. Nem csak az új anyagokat + kell meglévõ nyelvekre fordítani, további nyelveket is szívesen fogad a + közösség. Továbbá a meglévõ dokumentációt is frissíteni kell, mivel az + eredeti angol nyelvû változat is változik. A fordítási folyamatról bõvebben + a kézikönyv <link linkend="faq.translators-revision-tracking">Revízió követés + </link> címû fejezetében találunk. </para> </sect1> http://cvs.php.net/diff.php/peardoc/hu/chapters/installation.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/chapters/installation.xml diff -u peardoc/hu/chapters/installation.xml:1.1 peardoc/hu/chapters/installation.xml:1.2 --- peardoc/hu/chapters/installation.xml:1.1 Sat Feb 21 16:57:59 2004 +++ peardoc/hu/chapters/installation.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.14 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.14 Maintainer: norbert_m Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. http://cvs.php.net/diff.php/peardoc/hu/chapters/intro.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/chapters/intro.xml diff -u peardoc/hu/chapters/intro.xml:1.1 peardoc/hu/chapters/intro.xml:1.2 --- peardoc/hu/chapters/intro.xml:1.1 Sat Feb 21 16:57:59 2004 +++ peardoc/hu/chapters/intro.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.5 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.5 Maintainer: norbert_m Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. http://cvs.php.net/diff.php/peardoc/hu/chapters/standards.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/hu/chapters/standards.xml diff -u peardoc/hu/chapters/standards.xml:1.4 peardoc/hu/chapters/standards.xml:1.5 --- peardoc/hu/chapters/standards.xml:1.4 Sat Feb 28 01:21:39 2004 +++ peardoc/hu/chapters/standards.xml Fri May 14 17:10:46 2004 @@ -1,7 +1,7 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.9 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.22 Maintainer: norbert_m Status: partial --> <chapter id="standards"> - <title>Kódolási szabványok</title> + <title>Kódolási szabályok</title> <note> <simpara> A PEAR Kódolási Szabványok arra a kódra érvényesek, melyek részei a @@ -17,6 +17,7 @@ nil-re. Példa az Emacs konfigurálására a fentieknek megfelelõen (gyõzõdjünk meg róla, hogy ez van érvényben PHP fájlok szerkesztésekor): <programlisting role="elisp"> + <![CDATA[ (defun php-mode-hook () (setq tab-width 4 c-basic-offset 4 @@ -25,20 +26,24 @@ (not (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name)) (string-match "\.php$" (buffer-file-name)))))) + ]]> </programlisting> </para> <para>A vim megfelelõ beállításai: <programlisting role="vim"> + <![CDATA[ set expandtab set shiftwidth=4 set softtabstop=4 set tabstop=4 + ]]> </programlisting> </para> <para> Ajánlott a sorokat kb. 75-85 karakter szélességben megtörni. Nincs szabály a sorok megfelelõ törésére, használjuk saját ítélõképességünket. - Ha kérdéseink vannak, érdeklõdjünk a PEAR QA levelezõlistán. + Ha kérdéseink vannak, érdeklõdjünk a + <ulink url="mailto:&email.pear.qa;">PEAR QA</ulink> levelezõlistán. </para> </sect1> @@ -48,13 +53,15 @@ Vezérlõszerkezetek alatt az if, for, while, switch stb. szerkezeteket értjük. Példa az if utasításra (a legbonyolultabb közülük): <programlisting role="php"> + <![CDATA[ if ((feltetel1) || (feltetel2)) { muvelet1; -} elseif ((feltetel3) && (feltetel4)) { +} elseif ((feltetel3) && (feltetel4)) { muvelet2; } else { defaultmuvelet; } + ]]> </programlisting> </para> <simpara> @@ -70,6 +77,7 @@ <para> Switch utasításoknál: <programlisting role="php"> + <![CDATA[ switch (feltetel) { case 1: muvelet1; @@ -82,8 +90,8 @@ default: defaultmuvelet; break; - } + ]]> </programlisting> </para> </sect1> @@ -97,7 +105,9 @@ használjunk szóközt az utolsó paraméter, a záró zárójel és a pontosvesszõ között. Például: <programlisting role="php"> + <![CDATA[ $var = foo($bar, $baz, $quux); + ]]> </programlisting> </para> <para> @@ -107,8 +117,10 @@ több értékadást végzünk, több szóközt szúrhatunk be az olvashatóság elõsegítése érdekében: <programlisting role="php"> + <![CDATA[ $rovid = foo($bar); $hosszu_valtozo = foo($baz); + ]]> </programlisting> </para> </sect1> @@ -116,8 +128,9 @@ <sect1 id="standards.funcdef"> <title>Függvénydefiníciók</title> <para> - A függvénydefiníciók a "one true brace" megállapodást követik: + A függvénydefiníciók a <quote>one true brace</quote> megállapodást követik: <programlisting role="php"> + <![CDATA[ function fooFunction($parameter1, $parameter2 = '') { if (feltetel) { @@ -125,6 +138,7 @@ } return $ertek; } + ]]> </programlisting> </para> <para> @@ -133,10 +147,11 @@ értékkel visszatérni egy függvénybõl, amennyiben lehetséges. Egy hosszabb példa: <programlisting role="php"> + <![CDATA[ function connect(&$dsn, $persistent = false) { if (is_array($dsn)) { - $dsninfo = &$dsn; + $dsninfo = &$dsn; } else { $dsninfo = DB::parseDSN($dsn); } @@ -147,6 +162,7 @@ return true; } + ]]> </programlisting> </para> </sect1> @@ -161,8 +177,8 @@ </para> <para> Dokumentálásnál általános szabály, hogy amirõl nem kívánunk leírást - készíteni ("Nem akarom kipróbálni és dokumentálni..."), arról épphogy - érdemes kommentet készíteni, mielõtt elfelejtjük hogyan mûködik. + készíteni (<quote>Nem akarom kipróbálni és dokumentálni...</quote>), arról + épphogy érdemes kommentet készíteni, mielõtt elfelejtjük hogyan mûködik. </para> <para> Mind a C-stílusú kommentek (/* */), mind a C++ stílusúak (//) használata @@ -195,9 +211,9 @@ <sect1 id="standards.tags"> <title>PHP tag-ek</title> <para> - <emphasis>Mindig</emphasis> használjunk <literal><?php ?></literal> + <emphasis>Mindig</emphasis> használjunk <literal><?php ?></literal> karaktersorozatot a PHP kód elválasztására, ne használjuk a - <literal><? ?></literal> rövidítést. Ez teszi leghordozhatóbbá a + <literal><? ?></literal> rövidítést. Ez teszi leghordozhatóbbá a PHP kódot a különbözõ operációs rendszerek és konfigurációk között. </para> </sect1> @@ -208,7 +224,7 @@ Minden forrásnyelvi fájlnak a PEAR core disztribúcióban a következõ fejléc komment blokkot kell tartalmaznia: <programlisting role="php"> -/* vim: set expandtab tabstop=4 shiftwidth=4: */ +/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ // +----------------------------------------------------------------------+ // | PHP version 4 | // +----------------------------------------------------------------------+ @@ -226,15 +242,15 @@ // | Your Name <you@example.com> | // +----------------------------------------------------------------------+ // -// $Id: +// $Id:$ </programlisting> </para> <para> Nincs határozott szabály annak eldöntésére, hogy mikor kerüljön sor egy új közremûködõ nevének felvételére a készítõk listájába egy adott forrásfájlban. Általánosságban azt mondhatjuk, hogy ehhez a - változtatásoknak a "jelentõs" kategóriába kell esniük (kb. 10-20% - változás a kódban). Kivételek tehetõk függvények újraírásánál, vagy + változtatásoknak a <quote>jelentõs</quote> kategóriába kell esniük (kb. + 10-20% változás a kódban). Kivételek tehetõk függvények újraírásánál, vagy új logika kialakításában történõ közremûködésnél. </para> <para> @@ -259,7 +275,7 @@ Helyezzük el a $Id$ CVS kulcsszót minden fájlban. Ahogy az egyes fájlok szerkesztésre kerülnek, adjuk hozzájuk ezt a tag-et, ha még nem szerepelnek a fájlban (vagy cseréljük a létezõ formákat, mint - például "Last Modified:" stb.) + például <quote>Last Modified:</quote> stb.) <!-- <note> <simpara> @@ -282,7 +298,7 @@ <variablelist> <varlistentry> - <term>RELEASE_<replaceable>n_n</replaceable></term> + <term>RELEASE_<replaceable>n_n_n</replaceable></term> <listitem> <simpara> (kötelezõ) Used for tagging a release. If you don't use it, @@ -292,7 +308,7 @@ </listitem> </varlistentry> <varlistentry> - <term>QA_<replaceable>n_n</replaceable></term> + <term>QA_<replaceable>n_n_n</replaceable></term> <listitem> <simpara> (branch, opcionális) If you feel you need to roll out a @@ -304,11 +320,11 @@ </listitem> </varlistentry> <varlistentry> - <term>MAINT_<replaceable>n_n</replaceable></term> + <term>MAINT_<replaceable>n_n_n</replaceable></term> <listitem> <simpara> - (branch, opcionális) If you need to make "micro-releases" (for - example 1.2.1 and so on after 1.2), you can use a branch for + (branch, opcionális) If you need to make <quote>micro-releases</quote> + (for example 1.2.1 and so on after 1.2.0), you can use a branch for that too, if your main trunk is very active and you want only minor changes between your micro-releases. </simpara> @@ -319,11 +335,11 @@ your convenience. </para> <para> - Below is an example of how to tag the 1.2 release of the - "Money_Fast" package: + Below is an example of how to tag the 1.2.0 release of the + <classname>Money_Fast</classname> package: <informalexample> <screen><prompt>$ </prompt><command>cd pear/Money_Fast</command> -<prompt>$ </prompt><command>cvs tag RELEASE_1_2</command> +<prompt>$ </prompt><command>cvs tag RELEASE_1_2_0</command> <computeroutput>T Fast.php T README T package.xml @@ -336,19 +352,19 @@ <para> Here's an example of how to create a QA branch: <informalexample> - <screen><prompt>$ </prompt><command>cvs tag QA_2_0_BP</command> + <screen><prompt>$ </prompt><command>cvs tag QA_2_0_0_BP</command> ... -<prompt>$ </prompt><command>cvs rtag -b -r QA_2_0_BP QA_2_0</command> -<prompt>$ </prompt><command>cvs update -r QA_2_0</command> -<prompt>$ </prompt><command>cvs tag RELEASE_2_0RC1</command> +<prompt>$ </prompt><command>cvs rtag -b -r QA_2_0_0_BP QA_2_0_0</command> +<prompt>$ </prompt><command>cvs update -r QA_2_0_0</command> +<prompt>$ </prompt><command>cvs tag RELEASE_2_0_0RC1</command> ...and then the actual release, from the same branch: -<prompt>$ </prompt><command>cvs tag RELEASE_2_0</command> +<prompt>$ </prompt><command>cvs tag RELEASE_2_0_0</command> </screen> </informalexample> - The "QA_2_0_BP" tag is a "branch point" tag, which is the start - point of the tag. It's always a good idea to start a CVS branch - from such branch points. MAINT branches may use the RELEASE tag - as their branch point. + The <literal>QA_2_0_0_BP</literal> tag is a <quote>branch point + </quote> tag, which is the start point of the tag. It's always + a good idea to start a CVS branch from such branch points. + MAINT branches may use the RELEASE tag as their branch point. </para> </sect1> @@ -356,9 +372,9 @@ <title>Példa URL-ek</title> <para> - Használjuk az "example.com", "example.org" és "example.net" formákat - minden példa URL-hez és e-mail címhez, az - <ulink url="&url.rfc;2606">RFC 2606</ulink> alapján. + Használjuk az <quote>example.com</quote>, <quote>example.org</quote> + és <quote>example.net</quote> formákat minden példa URL-hez és e-mail + címhez, az <ulink url="&url.rfc;2606">RFC 2606</ulink> alapján. </para> </sect1> @@ -388,12 +404,13 @@ <sect2> <title>Függvények és metódusok</title> <para> - A függvényeket és a metódusokat a "studly caps"-stílus szerint - nevezzük el (hívják még "bumpy case" és "camel caps" stílusnak is). + A függvényeket és a metódusokat a <quote>studly caps</quote> + -stílus szerint nevezzük el (hívják még <quote>bumpy case + </quote> és <quote>camel caps</quote> stílusnak is). Az elnevezés továbbá tartalmazza prefixként a csomag nevét, a csomagok közötti elnevezés-ütközések elkerülése érdekében. Az elnevezés kezdõbetûje (a prefix után) kisbetû, ezt követõen minden - új "szó" kezdõbetûje nagybetûvel írandó. Néhány példa: + új <quote>szó</quote> kezdõbetûje nagybetûvel írandó. Néhány példa: <informaltable> <tgroup cols="4"> <tbody> @@ -432,7 +449,7 @@ a szavak elhatárolására. Neveikben használjuk elõképzõként annak az osztálynak/csomagnak a végig nagybetûkkel írt nevét, amelyben használva vannak. Például a <literal>DB::</literal> csomag által használt - konstansok nevei a "<literal>DB_</literal>" karaktersorozattal kerülnek + konstansok nevei a <literal>DB_</literal> karaktersorozattal kerülnek bevezetésre. </para> </sect2> @@ -445,6 +462,235 @@ használt egyik globális változó a $_PEAR_destructor_object_list. </para> </sect2> + </sect1> + + <sect1 id="standards.sample"> + <title>Sample File</title> + <para> + The <command>Id</command> CVS keyword you see in the + example below contains the data for the file used to + create the document you are reading now. When creating + your own PEAR scripts, replace the data there with a + blank keyword: <literal>$Id:$</literal> + </para> + <para> + Please take note of the vertical and horizontal spacing. + They are part of the standard. + </para> + <para> + The <quote>fold markers</quote> (<literal>// {{{</literal> and + <literal>// }}}</literal>) are optional. If you aren't using + fold markers, remove <literal>foldmethod=marker</literal> + from the vim header. + </para> + <para> + The example contains many details about writing + Docblock Comments. Following those instructions + is important for two reasons. First, when docblocks + are easy to read, users and developers can quickly + ascertain what your code does. Second, the PEAR + website now contains the phpDocumentor generated + documentation for each release of each package, so + keeping things straight here means the API docs on + the website will be useful. + </para> + <para> + <programlisting role="php"> + <![CDATA[ + <?php + /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */ + // +----------------------------------------------------------------------+ + // | PHP version 4 | + // +----------------------------------------------------------------------+ + // | Copyright (c) 1997-2004 The PHP Group | + // +----------------------------------------------------------------------+ + // | This source file is subject to version 3.0 of the PHP license, | + // | that is bundled with this package in the file LICENSE, and is | + // | available through the world-wide-web at the following url: | + // | http://www.php.net/license/3_0.txt. | + // | If you did not receive a copy of the PHP license and are unable to | + // | obtain it through the world-wide-web, please send a note to | + // | license@php.net so we can mail you a copy immediately. | + // +----------------------------------------------------------------------+ + // | Authors: Original Author <author@example.com> | + // | Your Name <you@example.com> | + // +----------------------------------------------------------------------+ + // + // $Id: standards.xml,v 1.5 2004/05/14 21:10:46 norbert_m Exp $ + + require_once 'PEAR.php'; + + // {{{ constants + + /** + * This is a "Docblock Comment," also known as a "docblock." The class' + * docblock, below, contains a complete description of how to write these. + */ + define('NET_SAMPLE_OK', 1); + + // }}} + // {{{ Net_Sample + + /** + * An example of how to write code to PEAR's standards + * + * Docblock comments start with "/**" at the top. Notice how the "/" + * lines up with the normal indenting and the asterisks on subsequent rows + * are in line with the first asterisk. The last line of comment text + * should be immediately followed on the next line by the closing asterisk + * and slash and then the item you are commenting on should be on the next + * line below that. Don't add extra lines. Please put a blank line + * between paragraphs as well as between the end of the description and + * the start of the @tags. Wrap comments before 80 columns in order to + * ease readability for a wide variety of users. + * + * Docblocks can only be used for programming constructs which allow them + * (classes, properties, methods, defines, includes, globals). See the + * phpDocumentor documentation for more information. + * http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html + * + * The Javadoc Style Guide is an excellent resource for figuring out + * how to say what needs to be said in docblock comments. Much of what is + * written here is a summary of what is found there, though there are some + * cases where what's said here overrides what is said there. + * http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide + * + * The first line of any docblock is the summary. Make them one short + * sentence, without a period at the end. Summaries for classes, properties + * and constants should omit the subject and simply state the object, + * because they are describing things rather than actions or behaviors. + * + * Below are the tags commonly used for classes. @category through @access + * are required. The remainder should only be used when necessary. + * Please use them in the order they appear here. phpDocumentor has + * several other tags available, feel free to use them. + * + * @category categoryname + * @package packagename + * @author Original Author <author@example.com> + * @version $Id: standards.xml,v 1.5 2004/05/14 21:10:46 norbert_m Exp $ + * @access public + * @see NetOther, Net_Sample::Net_Sample() + * @since Class available since Release 1.2.0 + * @deprecated Class deprecated in Release 2.0.0 + */ + class Net_Sample + { + // {{{ properties + + /** + * The status of foo's universe + * + * Potential values are 'good', 'fair', 'poor' and 'unknown'. + * + * @var string + */ + var $foo = 'unknown'; + + // }}} + // {{{ setFoo() + + /** + * Registers the status of foo's universe + * + * Summaries for methods should use 3rd person declarative rather + * than 2nd person imperative, begining with a verb phrase. + * + * Summaries should add description beyond the method's name. The + * best method names are "self-documenting", meaning they tell you + * basically what the method does. If the summary merely repeats + * the method name in sentence form, it is not providing more + * information. + * + * Summary Examples: + * + Sets the label (preferred) + * + Set the label (avoid) + * + This method sets the label (avoid) + * + * Below are the tags commonly used for methods. A @param tag is + * required for each parameter the method has. The @return and + * @access tags are mandatory. The @throws tag is required if the + * method uses exceptions. @static is required if the method can + * be called statically. The remainder should only be used when + * necessary. Please use them in the order they appear here. + * phpDocumentor has several other tags available, feel free to use + * them. + * + * The @param tag contains the data type, then the parameter's + * name, followed by a description. By convention, the first noun in + * the description is the data type of the parameter. Articles like + * "a", "an", and "the" can precede the noun. The descriptions + * should start with a phrase. If further description is necessary, + * follow with sentences. Having two spaces between the name and the + * description aids readability. + * + * When writing a phrase, do not capitalize and do not end with a + * period: + * + the string to be tested + * + * When writing a phrase followed by a sentence, do not capitalize the + * phrase, but end it with a period to distinguish it from the start + * of the next sentence: + * + the string to be tested. Must use UTF-8 encoding. + * + * Return tags should contain the data type then a description of + * the data returned. The data type can be any of PHP's data types + * (int, float, bool, string, array, object, resource, mixed) + * and should contain the type primarily returned. For example, if + * a method returns an object when things work correctly but false + * when an error happens, say 'object' rather than 'mixed.' Use + * 'void' if nothing is returned. + * + * @param string $arg1 the string to quote + * @param int $arg2 an integer of how many problems happened. + * Indent to the description's starting point + * for long ones. + * + * @return int the integer of the set mode used. FALSE if foo + * foo could not be set. + * @throws exceptionclass [description] + * + * @access public + * @static + * @see Net_Sample::$foo, Net_Other::someMethod() + * @since Method available since Release 1.2.0 + * @deprecated Method deprecated in Release 2.0.0 + */ + function setFoo($arg1, $arg2 = 0) + { + /* + * This is a "Block Comment." The format is the same as + * Docblock Comments except there is only one asterisk at the + * top. phpDocumentor doesn't parse these. + */ + if ($arg1 == 'good' || $arg1 == 'fair') { + $this->foo = $arg1; + return 1; + } elseif ($arg1 == 'poor' && $arg2 > 1) { + $this->foo = 'poor'; + return 2; + } else { + return false; + } + } + + // }}} + } + + // }}} + + /* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * c-hanging-comment-ender-p: nil + * End: + */ + + ?> + ]]> + </programlisting> + </para> </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/hu/chapters/support.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/hu/chapters/support.xml diff -u peardoc/hu/chapters/support.xml:1.2 peardoc/hu/chapters/support.xml:1.3 --- peardoc/hu/chapters/support.xml:1.2 Sat Feb 28 01:21:39 2004 +++ peardoc/hu/chapters/support.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.1 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <chapter id="support"> <title>Támogatás</title> <simpara> http://cvs.php.net/diff.php/peardoc/hu/guide/developers/intro.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/guide/developers/intro.xml diff -u peardoc/hu/guide/developers/intro.xml:1.1 peardoc/hu/guide/developers/intro.xml:1.2 --- peardoc/hu/guide/developers/intro.xml:1.1 Sat Feb 28 10:25:04 2004 +++ peardoc/hu/guide/developers/intro.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.1.1.1 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.1.1.1 Maintainer: norbert_m Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. http://cvs.php.net/diff.php/peardoc/hu/package/database/db/db.ent?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/package/database/db/db.ent diff -u peardoc/hu/package/database/db/db.ent:1.1 peardoc/hu/package/database/db/db.ent:1.2 --- peardoc/hu/package/database/db/db.ent:1.1 Sat Feb 21 16:58:00 2004 +++ peardoc/hu/package/database/db/db.ent Fri May 14 17:10:46 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> http://cvs.php.net/diff.php/peardoc/hu/package/database/mdb/mdb.ent?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/package/database/mdb/mdb.ent diff -u peardoc/hu/package/database/mdb/mdb.ent:1.1 peardoc/hu/package/database/mdb/mdb.ent:1.2 --- peardoc/hu/package/database/mdb/mdb.ent:1.1 Sat Feb 21 16:55:15 2004 +++ peardoc/hu/package/database/mdb/mdb.ent Fri May 14 17:10:47 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <!ENTITY class.mdb '<link linkend="package.database.mdb"><classname>MDB</classname></link>'> <!ENTITY class.mdb-common '<link linkend="package.database.mdb.mdb-common"><classname>MDB_Common</classname></link>'> <!ENTITY class.mdb-error '<link linkend="package.database.mdb.mdb-error"><classname>MDB_Error</classname></link>'>
http://cvs.php.net/diff.php/peardoc/hu/language-defs.ent?r1=1.4&r2=1.5&ty=u Index: peardoc/hu/language-defs.ent diff -u peardoc/hu/language-defs.ent:1.4 peardoc/hu/language-defs.ent:1.5 --- peardoc/hu/language-defs.ent:1.4 Sat Feb 28 10:27:13 2004 +++ peardoc/hu/language-defs.ent Fri May 14 17:10:46 2004 @@ -1,4 +1,4 @@ -<!-- Sync: 1.1 --> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <!ENTITY PEARManual "PEAR Kézikönyv"> <!ENTITY Date "Dátum:"> http://cvs.php.net/diff.php/peardoc/hu/language-snippets.ent?r1=1.4&r2=1.5&ty=u Index: peardoc/hu/language-snippets.ent diff -u peardoc/hu/language-snippets.ent:1.4 peardoc/hu/language-snippets.ent:1.5 --- peardoc/hu/language-snippets.ent:1.4 Wed Apr 14 12:27:05 2004 +++ peardoc/hu/language-snippets.ent Fri May 14 17:10:46 2004 @@ -1,4 +1,4 @@ -<!-- Sync: 1.1 --> +<!-- EN-Revision: 1.11 Maintainer: norbert_m Status: ready --> <!ENTITY warn.experimental '<warning><simpara>Ez a modul jelenleg <emphasis>kísérleti jellegû</emphasis>. Ez azt jelenti, hogy a függvények @@ -37,7 +37,7 @@ függvény visszatérési értékének vizsgálatára!</simpara></warning>'> <!ENTITY link.coding-standards 'PEAR <link linkend="standards">kódolási -szabványok.</link>'> +szabályok.</link>'> <!ENTITY note.canstatic '<simpara>Ez a függvény meghívható statikusan. </simpara>'> @@ -45,11 +45,11 @@ <!ENTITY note.shouldstatic '<simpara>Ez a függvény statikus meghívásra van felkészítve!</simpara>'> -<!ENTITY note.notstatic '<simpara>Ez a függvény nem hívható meg +<!ENTITY note.notstatic '<simpara>Ez a függvény nem hívható statikusan.</simpara>'> -<!ENTITY note.deprecated '<warning><para>Ez a függvény többé -<emphasis>nem érvényes</emphasis>. Ez azt jelenti, hogy a csomag jövõbeli +<!ENTITY note.deprecated '<warning><para>Ez a függvény <emphasis>érvénytelenítve +</emphasis> lett. Ez azt jelenti, hogy a csomag jövõbeli verziói lehetséges, hogy nem fogják támogatni.</para></warning>'> <!ENTITY title.desc '<title>Leírás</title>'> @@ -57,7 +57,7 @@ <!ENTITY title.deprecated '<title>Érvénytelenítve</title>'> <!ENTITY title.returns '<title>Visszatérési érték</title>'> <!ENTITY title.throws '<title>Lehetséges hibaértékek</title>'> -<!ENTITY title.throws.errortable 'Lehetséges PEAR_Error értékek'> +<!ENTITY title.throws.errortable 'Lehetséges PEAR_Error visszatérési értékek'> <!ENTITY title.note '<title>Megjegyzés</title>'> <!ENTITY title.example '<title>Példa</title>'> <!ENTITY title.see '<title>Lásd</title>'> http://cvs.php.net/diff.php/peardoc/hu/preface.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/hu/preface.xml diff -u peardoc/hu/preface.xml:1.2 peardoc/hu/preface.xml:1.3 --- peardoc/hu/preface.xml:1.2 Sat Feb 28 10:27:13 2004 +++ peardoc/hu/preface.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.7 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.17 Maintainer: norbert_m Status: ready --> <preface id="preface"> <title>Elõszó</title> http://cvs.php.net/diff.php/peardoc/hu/chapters/contributing.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/hu/chapters/contributing.xml diff -u peardoc/hu/chapters/contributing.xml:1.2 peardoc/hu/chapters/contributing.xml:1.3 --- peardoc/hu/chapters/contributing.xml:1.2 Mon Apr 19 11:43:47 2004 +++ peardoc/hu/chapters/contributing.xml Fri May 14 17:10:46 2004 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-2" ?> -<!-- $Revision: 1.2 $ --> -<!-- EN-Revision: 1.13 Maintainer: danielc Status: added english for doc/translate section --> +<!-- EN-Revision: 1.13 Maintainer: norbert_m Status: ready --> <chapter id="contributing"> <docinfo> <author> @@ -141,23 +140,22 @@ </sect1> <sect1 id="contributing.documentation"> - <title>Writing & Translating Documentation</title> + <title>Dokumentáció írás és fordítás</title> <para> - Good documentation is essential for users to fully understand any - software. Several PEAR packages lack documentation or have docs which - need improvement. <link - linkend="developers.documentation">Writing documentation</link> - provides more information about helping out on this front. - </para> - <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. + A jó dokumentáció az alapja, hogy a felhasználók megfelelõen megértsenek + egy szoftvert. Néhány PEAR csomag még nem rendelkezik dokumentációval, + vagy dokumentációja fejlesztésre szorul. + Ezzel kapcsolatban a <link + linkend="developers.documentation">Dokumentáció írása</link> + fejezet nyújt további információt. + </para> + <para> + A dokumentáció fordítása a másik fontos feladat. Nem csak az új anyagokat + kell meglévõ nyelvekre fordítani, további nyelveket is szívesen fogad a + közösség. Továbbá a meglévõ dokumentációt is frissíteni kell, mivel az + eredeti angol nyelvû változat is változik. A fordítási folyamatról bõvebben + a kézikönyv <link linkend="faq.translators-revision-tracking">Revízió követés + </link> címû fejezetében találunk. </para> </sect1> http://cvs.php.net/diff.php/peardoc/hu/chapters/installation.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/chapters/installation.xml diff -u peardoc/hu/chapters/installation.xml:1.1 peardoc/hu/chapters/installation.xml:1.2 --- peardoc/hu/chapters/installation.xml:1.1 Sat Feb 21 16:57:59 2004 +++ peardoc/hu/chapters/installation.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.14 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.14 Maintainer: norbert_m Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. http://cvs.php.net/diff.php/peardoc/hu/chapters/intro.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/chapters/intro.xml diff -u peardoc/hu/chapters/intro.xml:1.1 peardoc/hu/chapters/intro.xml:1.2 --- peardoc/hu/chapters/intro.xml:1.1 Sat Feb 21 16:57:59 2004 +++ peardoc/hu/chapters/intro.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.5 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.5 Maintainer: norbert_m Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. http://cvs.php.net/diff.php/peardoc/hu/chapters/standards.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/hu/chapters/standards.xml diff -u peardoc/hu/chapters/standards.xml:1.4 peardoc/hu/chapters/standards.xml:1.5 --- peardoc/hu/chapters/standards.xml:1.4 Sat Feb 28 01:21:39 2004 +++ peardoc/hu/chapters/standards.xml Fri May 14 17:10:46 2004 @@ -1,7 +1,7 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.9 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.22 Maintainer: norbert_m Status: partial --> <chapter id="standards"> - <title>Kódolási szabványok</title> + <title>Kódolási szabályok</title> <note> <simpara> A PEAR Kódolási Szabványok arra a kódra érvényesek, melyek részei a @@ -17,6 +17,7 @@ nil-re. Példa az Emacs konfigurálására a fentieknek megfelelõen (gyõzõdjünk meg róla, hogy ez van érvényben PHP fájlok szerkesztésekor): <programlisting role="elisp"> + <![CDATA[ (defun php-mode-hook () (setq tab-width 4 c-basic-offset 4 @@ -25,20 +26,24 @@ (not (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name)) (string-match "\.php$" (buffer-file-name)))))) + ]]> </programlisting> </para> <para>A vim megfelelõ beállításai: <programlisting role="vim"> + <![CDATA[ set expandtab set shiftwidth=4 set softtabstop=4 set tabstop=4 + ]]> </programlisting> </para> <para> Ajánlott a sorokat kb. 75-85 karakter szélességben megtörni. Nincs szabály a sorok megfelelõ törésére, használjuk saját ítélõképességünket. - Ha kérdéseink vannak, érdeklõdjünk a PEAR QA levelezõlistán. + Ha kérdéseink vannak, érdeklõdjünk a + <ulink url="mailto:&email.pear.qa;">PEAR QA</ulink> levelezõlistán. </para> </sect1> @@ -48,13 +53,15 @@ Vezérlõszerkezetek alatt az if, for, while, switch stb. szerkezeteket értjük. Példa az if utasításra (a legbonyolultabb közülük): <programlisting role="php"> + <![CDATA[ if ((feltetel1) || (feltetel2)) { muvelet1; -} elseif ((feltetel3) && (feltetel4)) { +} elseif ((feltetel3) && (feltetel4)) { muvelet2; } else { defaultmuvelet; } + ]]> </programlisting> </para> <simpara> @@ -70,6 +77,7 @@ <para> Switch utasításoknál: <programlisting role="php"> + <![CDATA[ switch (feltetel) { case 1: muvelet1; @@ -82,8 +90,8 @@ default: defaultmuvelet; break; - } + ]]> </programlisting> </para> </sect1> @@ -97,7 +105,9 @@ használjunk szóközt az utolsó paraméter, a záró zárójel és a pontosvesszõ között. Például: <programlisting role="php"> + <![CDATA[ $var = foo($bar, $baz, $quux); + ]]> </programlisting> </para> <para> @@ -107,8 +117,10 @@ több értékadást végzünk, több szóközt szúrhatunk be az olvashatóság elõsegítése érdekében: <programlisting role="php"> + <![CDATA[ $rovid = foo($bar); $hosszu_valtozo = foo($baz); + ]]> </programlisting> </para> </sect1> @@ -116,8 +128,9 @@ <sect1 id="standards.funcdef"> <title>Függvénydefiníciók</title> <para> - A függvénydefiníciók a "one true brace" megállapodást követik: + A függvénydefiníciók a <quote>one true brace</quote> megállapodást követik: <programlisting role="php"> + <![CDATA[ function fooFunction($parameter1, $parameter2 = '') { if (feltetel) { @@ -125,6 +138,7 @@ } return $ertek; } + ]]> </programlisting> </para> <para> @@ -133,10 +147,11 @@ értékkel visszatérni egy függvénybõl, amennyiben lehetséges. Egy hosszabb példa: <programlisting role="php"> + <![CDATA[ function connect(&$dsn, $persistent = false) { if (is_array($dsn)) { - $dsninfo = &$dsn; + $dsninfo = &$dsn; } else { $dsninfo = DB::parseDSN($dsn); } @@ -147,6 +162,7 @@ return true; } + ]]> </programlisting> </para> </sect1> @@ -161,8 +177,8 @@ </para> <para> Dokumentálásnál általános szabály, hogy amirõl nem kívánunk leírást - készíteni ("Nem akarom kipróbálni és dokumentálni..."), arról épphogy - érdemes kommentet készíteni, mielõtt elfelejtjük hogyan mûködik. + készíteni (<quote>Nem akarom kipróbálni és dokumentálni...</quote>), arról + épphogy érdemes kommentet készíteni, mielõtt elfelejtjük hogyan mûködik. </para> <para> Mind a C-stílusú kommentek (/* */), mind a C++ stílusúak (//) használata @@ -195,9 +211,9 @@ <sect1 id="standards.tags"> <title>PHP tag-ek</title> <para> - <emphasis>Mindig</emphasis> használjunk <literal><?php ?></literal> + <emphasis>Mindig</emphasis> használjunk <literal><?php ?></literal> karaktersorozatot a PHP kód elválasztására, ne használjuk a - <literal><? ?></literal> rövidítést. Ez teszi leghordozhatóbbá a + <literal><? ?></literal> rövidítést. Ez teszi leghordozhatóbbá a PHP kódot a különbözõ operációs rendszerek és konfigurációk között. </para> </sect1> @@ -208,7 +224,7 @@ Minden forrásnyelvi fájlnak a PEAR core disztribúcióban a következõ fejléc komment blokkot kell tartalmaznia: <programlisting role="php"> -/* vim: set expandtab tabstop=4 shiftwidth=4: */ +/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ // +----------------------------------------------------------------------+ // | PHP version 4 | // +----------------------------------------------------------------------+ @@ -226,15 +242,15 @@ // | Your Name <you@example.com> | // +----------------------------------------------------------------------+ // -// $Id: +// $Id:$ </programlisting> </para> <para> Nincs határozott szabály annak eldöntésére, hogy mikor kerüljön sor egy új közremûködõ nevének felvételére a készítõk listájába egy adott forrásfájlban. Általánosságban azt mondhatjuk, hogy ehhez a - változtatásoknak a "jelentõs" kategóriába kell esniük (kb. 10-20% - változás a kódban). Kivételek tehetõk függvények újraírásánál, vagy + változtatásoknak a <quote>jelentõs</quote> kategóriába kell esniük (kb. + 10-20% változás a kódban). Kivételek tehetõk függvények újraírásánál, vagy új logika kialakításában történõ közremûködésnél. </para> <para> @@ -259,7 +275,7 @@ Helyezzük el a $Id$ CVS kulcsszót minden fájlban. Ahogy az egyes fájlok szerkesztésre kerülnek, adjuk hozzájuk ezt a tag-et, ha még nem szerepelnek a fájlban (vagy cseréljük a létezõ formákat, mint - például "Last Modified:" stb.) + például <quote>Last Modified:</quote> stb.) <!-- <note> <simpara> @@ -282,7 +298,7 @@ <variablelist> <varlistentry> - <term>RELEASE_<replaceable>n_n</replaceable></term> + <term>RELEASE_<replaceable>n_n_n</replaceable></term> <listitem> <simpara> (kötelezõ) Used for tagging a release. If you don't use it, @@ -292,7 +308,7 @@ </listitem> </varlistentry> <varlistentry> - <term>QA_<replaceable>n_n</replaceable></term> + <term>QA_<replaceable>n_n_n</replaceable></term> <listitem> <simpara> (branch, opcionális) If you feel you need to roll out a @@ -304,11 +320,11 @@ </listitem> </varlistentry> <varlistentry> - <term>MAINT_<replaceable>n_n</replaceable></term> + <term>MAINT_<replaceable>n_n_n</replaceable></term> <listitem> <simpara> - (branch, opcionális) If you need to make "micro-releases" (for - example 1.2.1 and so on after 1.2), you can use a branch for + (branch, opcionális) If you need to make <quote>micro-releases</quote> + (for example 1.2.1 and so on after 1.2.0), you can use a branch for that too, if your main trunk is very active and you want only minor changes between your micro-releases. </simpara> @@ -319,11 +335,11 @@ your convenience. </para> <para> - Below is an example of how to tag the 1.2 release of the - "Money_Fast" package: + Below is an example of how to tag the 1.2.0 release of the + <classname>Money_Fast</classname> package: <informalexample> <screen><prompt>$ </prompt><command>cd pear/Money_Fast</command> -<prompt>$ </prompt><command>cvs tag RELEASE_1_2</command> +<prompt>$ </prompt><command>cvs tag RELEASE_1_2_0</command> <computeroutput>T Fast.php T README T package.xml @@ -336,19 +352,19 @@ <para> Here's an example of how to create a QA branch: <informalexample> - <screen><prompt>$ </prompt><command>cvs tag QA_2_0_BP</command> + <screen><prompt>$ </prompt><command>cvs tag QA_2_0_0_BP</command> ... -<prompt>$ </prompt><command>cvs rtag -b -r QA_2_0_BP QA_2_0</command> -<prompt>$ </prompt><command>cvs update -r QA_2_0</command> -<prompt>$ </prompt><command>cvs tag RELEASE_2_0RC1</command> +<prompt>$ </prompt><command>cvs rtag -b -r QA_2_0_0_BP QA_2_0_0</command> +<prompt>$ </prompt><command>cvs update -r QA_2_0_0</command> +<prompt>$ </prompt><command>cvs tag RELEASE_2_0_0RC1</command> ...and then the actual release, from the same branch: -<prompt>$ </prompt><command>cvs tag RELEASE_2_0</command> +<prompt>$ </prompt><command>cvs tag RELEASE_2_0_0</command> </screen> </informalexample> - The "QA_2_0_BP" tag is a "branch point" tag, which is the start - point of the tag. It's always a good idea to start a CVS branch - from such branch points. MAINT branches may use the RELEASE tag - as their branch point. + The <literal>QA_2_0_0_BP</literal> tag is a <quote>branch point + </quote> tag, which is the start point of the tag. It's always + a good idea to start a CVS branch from such branch points. + MAINT branches may use the RELEASE tag as their branch point. </para> </sect1> @@ -356,9 +372,9 @@ <title>Példa URL-ek</title> <para> - Használjuk az "example.com", "example.org" és "example.net" formákat - minden példa URL-hez és e-mail címhez, az - <ulink url="&url.rfc;2606">RFC 2606</ulink> alapján. + Használjuk az <quote>example.com</quote>, <quote>example.org</quote> + és <quote>example.net</quote> formákat minden példa URL-hez és e-mail + címhez, az <ulink url="&url.rfc;2606">RFC 2606</ulink> alapján. </para> </sect1> @@ -388,12 +404,13 @@ <sect2> <title>Függvények és metódusok</title> <para> - A függvényeket és a metódusokat a "studly caps"-stílus szerint - nevezzük el (hívják még "bumpy case" és "camel caps" stílusnak is). + A függvényeket és a metódusokat a <quote>studly caps</quote> + -stílus szerint nevezzük el (hívják még <quote>bumpy case + </quote> és <quote>camel caps</quote> stílusnak is). Az elnevezés továbbá tartalmazza prefixként a csomag nevét, a csomagok közötti elnevezés-ütközések elkerülése érdekében. Az elnevezés kezdõbetûje (a prefix után) kisbetû, ezt követõen minden - új "szó" kezdõbetûje nagybetûvel írandó. Néhány példa: + új <quote>szó</quote> kezdõbetûje nagybetûvel írandó. Néhány példa: <informaltable> <tgroup cols="4"> <tbody> @@ -432,7 +449,7 @@ a szavak elhatárolására. Neveikben használjuk elõképzõként annak az osztálynak/csomagnak a végig nagybetûkkel írt nevét, amelyben használva vannak. Például a <literal>DB::</literal> csomag által használt - konstansok nevei a "<literal>DB_</literal>" karaktersorozattal kerülnek + konstansok nevei a <literal>DB_</literal> karaktersorozattal kerülnek bevezetésre. </para> </sect2> @@ -445,6 +462,235 @@ használt egyik globális változó a $_PEAR_destructor_object_list. </para> </sect2> + </sect1> + + <sect1 id="standards.sample"> + <title>Sample File</title> + <para> + The <command>Id</command> CVS keyword you see in the + example below contains the data for the file used to + create the document you are reading now. When creating + your own PEAR scripts, replace the data there with a + blank keyword: <literal>$Id:$</literal> + </para> + <para> + Please take note of the vertical and horizontal spacing. + They are part of the standard. + </para> + <para> + The <quote>fold markers</quote> (<literal>// {{{</literal> and + <literal>// }}}</literal>) are optional. If you aren't using + fold markers, remove <literal>foldmethod=marker</literal> + from the vim header. + </para> + <para> + The example contains many details about writing + Docblock Comments. Following those instructions + is important for two reasons. First, when docblocks + are easy to read, users and developers can quickly + ascertain what your code does. Second, the PEAR + website now contains the phpDocumentor generated + documentation for each release of each package, so + keeping things straight here means the API docs on + the website will be useful. + </para> + <para> + <programlisting role="php"> + <![CDATA[ + <?php + /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */ + // +----------------------------------------------------------------------+ + // | PHP version 4 | + // +----------------------------------------------------------------------+ + // | Copyright (c) 1997-2004 The PHP Group | + // +----------------------------------------------------------------------+ + // | This source file is subject to version 3.0 of the PHP license, | + // | that is bundled with this package in the file LICENSE, and is | + // | available through the world-wide-web at the following url: | + // | http://www.php.net/license/3_0.txt. | + // | If you did not receive a copy of the PHP license and are unable to | + // | obtain it through the world-wide-web, please send a note to | + // | license@php.net so we can mail you a copy immediately. | + // +----------------------------------------------------------------------+ + // | Authors: Original Author <author@example.com> | + // | Your Name <you@example.com> | + // +----------------------------------------------------------------------+ + // + // $Id: standards.xml,v 1.5 2004/05/14 21:10:46 norbert_m Exp $ + + require_once 'PEAR.php'; + + // {{{ constants + + /** + * This is a "Docblock Comment," also known as a "docblock." The class' + * docblock, below, contains a complete description of how to write these. + */ + define('NET_SAMPLE_OK', 1); + + // }}} + // {{{ Net_Sample + + /** + * An example of how to write code to PEAR's standards + * + * Docblock comments start with "/**" at the top. Notice how the "/" + * lines up with the normal indenting and the asterisks on subsequent rows + * are in line with the first asterisk. The last line of comment text + * should be immediately followed on the next line by the closing asterisk + * and slash and then the item you are commenting on should be on the next + * line below that. Don't add extra lines. Please put a blank line + * between paragraphs as well as between the end of the description and + * the start of the @tags. Wrap comments before 80 columns in order to + * ease readability for a wide variety of users. + * + * Docblocks can only be used for programming constructs which allow them + * (classes, properties, methods, defines, includes, globals). See the + * phpDocumentor documentation for more information. + * http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html + * + * The Javadoc Style Guide is an excellent resource for figuring out + * how to say what needs to be said in docblock comments. Much of what is + * written here is a summary of what is found there, though there are some + * cases where what's said here overrides what is said there. + * http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide + * + * The first line of any docblock is the summary. Make them one short + * sentence, without a period at the end. Summaries for classes, properties + * and constants should omit the subject and simply state the object, + * because they are describing things rather than actions or behaviors. + * + * Below are the tags commonly used for classes. @category through @access + * are required. The remainder should only be used when necessary. + * Please use them in the order they appear here. phpDocumentor has + * several other tags available, feel free to use them. + * + * @category categoryname + * @package packagename + * @author Original Author <author@example.com> + * @version $Id: standards.xml,v 1.5 2004/05/14 21:10:46 norbert_m Exp $ + * @access public + * @see NetOther, Net_Sample::Net_Sample() + * @since Class available since Release 1.2.0 + * @deprecated Class deprecated in Release 2.0.0 + */ + class Net_Sample + { + // {{{ properties + + /** + * The status of foo's universe + * + * Potential values are 'good', 'fair', 'poor' and 'unknown'. + * + * @var string + */ + var $foo = 'unknown'; + + // }}} + // {{{ setFoo() + + /** + * Registers the status of foo's universe + * + * Summaries for methods should use 3rd person declarative rather + * than 2nd person imperative, begining with a verb phrase. + * + * Summaries should add description beyond the method's name. The + * best method names are "self-documenting", meaning they tell you + * basically what the method does. If the summary merely repeats + * the method name in sentence form, it is not providing more + * information. + * + * Summary Examples: + * + Sets the label (preferred) + * + Set the label (avoid) + * + This method sets the label (avoid) + * + * Below are the tags commonly used for methods. A @param tag is + * required for each parameter the method has. The @return and + * @access tags are mandatory. The @throws tag is required if the + * method uses exceptions. @static is required if the method can + * be called statically. The remainder should only be used when + * necessary. Please use them in the order they appear here. + * phpDocumentor has several other tags available, feel free to use + * them. + * + * The @param tag contains the data type, then the parameter's + * name, followed by a description. By convention, the first noun in + * the description is the data type of the parameter. Articles like + * "a", "an", and "the" can precede the noun. The descriptions + * should start with a phrase. If further description is necessary, + * follow with sentences. Having two spaces between the name and the + * description aids readability. + * + * When writing a phrase, do not capitalize and do not end with a + * period: + * + the string to be tested + * + * When writing a phrase followed by a sentence, do not capitalize the + * phrase, but end it with a period to distinguish it from the start + * of the next sentence: + * + the string to be tested. Must use UTF-8 encoding. + * + * Return tags should contain the data type then a description of + * the data returned. The data type can be any of PHP's data types + * (int, float, bool, string, array, object, resource, mixed) + * and should contain the type primarily returned. For example, if + * a method returns an object when things work correctly but false + * when an error happens, say 'object' rather than 'mixed.' Use + * 'void' if nothing is returned. + * + * @param string $arg1 the string to quote + * @param int $arg2 an integer of how many problems happened. + * Indent to the description's starting point + * for long ones. + * + * @return int the integer of the set mode used. FALSE if foo + * foo could not be set. + * @throws exceptionclass [description] + * + * @access public + * @static + * @see Net_Sample::$foo, Net_Other::someMethod() + * @since Method available since Release 1.2.0 + * @deprecated Method deprecated in Release 2.0.0 + */ + function setFoo($arg1, $arg2 = 0) + { + /* + * This is a "Block Comment." The format is the same as + * Docblock Comments except there is only one asterisk at the + * top. phpDocumentor doesn't parse these. + */ + if ($arg1 == 'good' || $arg1 == 'fair') { + $this->foo = $arg1; + return 1; + } elseif ($arg1 == 'poor' && $arg2 > 1) { + $this->foo = 'poor'; + return 2; + } else { + return false; + } + } + + // }}} + } + + // }}} + + /* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * c-hanging-comment-ender-p: nil + * End: + */ + + ?> + ]]> + </programlisting> + </para> </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/hu/chapters/support.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/hu/chapters/support.xml diff -u peardoc/hu/chapters/support.xml:1.2 peardoc/hu/chapters/support.xml:1.3 --- peardoc/hu/chapters/support.xml:1.2 Sat Feb 28 01:21:39 2004 +++ peardoc/hu/chapters/support.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.1 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <chapter id="support"> <title>Támogatás</title> <simpara> http://cvs.php.net/diff.php/peardoc/hu/guide/developers/intro.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/guide/developers/intro.xml diff -u peardoc/hu/guide/developers/intro.xml:1.1 peardoc/hu/guide/developers/intro.xml:1.2 --- peardoc/hu/guide/developers/intro.xml:1.1 Sat Feb 28 10:25:04 2004 +++ peardoc/hu/guide/developers/intro.xml Fri May 14 17:10:46 2004 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> -<!-- Sync: 1.1.1.1 --> +<?xml version="1.0" encoding="iso-8859-2" ?> +<!-- EN-Revision: 1.1.1.1 Maintainer: norbert_m Status: ready --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. http://cvs.php.net/diff.php/peardoc/hu/package/database/db/db.ent?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/package/database/db/db.ent diff -u peardoc/hu/package/database/db/db.ent:1.1 peardoc/hu/package/database/db/db.ent:1.2 --- peardoc/hu/package/database/db/db.ent:1.1 Sat Feb 21 16:58:00 2004 +++ peardoc/hu/package/database/db/db.ent Fri May 14 17:10:46 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> http://cvs.php.net/diff.php/peardoc/hu/package/database/mdb/mdb.ent?r1=1.1&r2=1.2&ty=u Index: peardoc/hu/package/database/mdb/mdb.ent diff -u peardoc/hu/package/database/mdb/mdb.ent:1.1 peardoc/hu/package/database/mdb/mdb.ent:1.2 --- peardoc/hu/package/database/mdb/mdb.ent:1.1 Sat Feb 21 16:55:15 2004 +++ peardoc/hu/package/database/mdb/mdb.ent Fri May 14 17:10:47 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- EN-Revision: 1.1 Maintainer: norbert_m Status: ready --> <!ENTITY class.mdb '<link linkend="package.database.mdb"><classname>MDB</classname></link>'> <!ENTITY class.mdb-common '<link linkend="package.database.mdb.mdb-common"><classname>MDB_Common</classname></link>'> <!ENTITY class.mdb-error '<link linkend="package.database.mdb.mdb-error"><classname>MDB_Error</classname></link>'>