cvs: phpdoc-sk /chmonly aboutchm.xml credits.xml integration.xml search.xml
[email protected] ("Milan Brezovsky")
| Newsgroups | php.doc.sk |
|---|---|
| Message-ID | <cvsanalytik1044207257@cvsserver> |
analytik Sun Feb 2 12:34:17 2003 EDT
Added files:
/phpdoc-sk/chmonly aboutchm.xml credits.xml integration.xml
search.xml
Log:
(null)
analytik-20030202123417.txt
(text/plain, 21.7 KB)
Index: phpdoc-sk/chmonly/aboutchm.xml
+++ phpdoc-sk/chmonly/aboutchm.xml
<?xml version="1.0" encoding="iso-8859-2"?>
<!-- EN-Revision: 1.5 Maintainer: analytik Status: ready -->
<chapter id="chm.about">
<title>O Tejto Edícií</title>
<para>
Edícia Windows HTML Help PHP Manuálu je zameraná na
vývojárov, ktorí chcú ma» manuál stále po ruke a radi by
èítali stránky manuálu a poznámky u¾ívateµov bez èakania na vzdialenú
webstránku. Táto edícia Vám dáva v¹etko, èo je v manuáli
plus poznámky u¾ívateµov a niekoµko super vymo¾eností vïaka
prehliadaèu a skriptom, ktoré pou¾ívame na vygenerovanie tohto
formátu a vïaka ïaµ¹ím príspevkom v podobe skínov ;).
</para>
<para>
Táto distribúcia PHP manuálu obsahuje viac súborov, zahàòajúc
hlavný súbor manuálu <filename>php_manual_sk.chm</filename>. Manuál
si mô¾ete prezrie» doubleclickom na tento súbor (ako ste asi domysleli;).
U¼ívateµské poznámky sú v <filename>php_manual_notes.chm</filename>. Staèí
Vám len jedna kópia tohto súboru v poèítaèi bez ohµadu na to,
v koµkých jazykoch máte PHP Manuál. Jediná
po¾iadavka je, aby v¹etky súbory <filename>php_manual_JAZYK.chm</filename>
boli v tom istom adresári ako <filename>php_manual_notes.chm</filename>.
Tie¾ si mô¾ete pozrie» súbor <filename>php_manual_en.chw</filename>,
je vygenerovaný pri prvom pou¾ití index tabu a
obsahuje index so stránkami manuálu.
</para>
<para>
Pre tých zúfalcov, èo by radi zistili nejaké technické detaily o Microsoft HTML Help,
<ulink url="&url.chm.helpware;">&url.chm.helpware;</ulink> je namakaný
zdroj informácií. Pre ïaµ¹ie informácie a umiestnenie Windows HTML Help
do histórie Microsof»áckych help formátov a slu¾ieb si pozrite
<ulink url="&url.chm.history;">èlánok od WinWriters</ulink>.
</para>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc-sk/chmonly/credits.xml
+++ phpdoc-sk/chmonly/credits.xml
<?xml version="1.0" encoding="iso-8859-2"?>
<!-- EN-Revision: 1.4 Maintainer: analytik Status: ready -->
<chapter id="chm.credits">
<title>CHM Edition Credits</title>
<para>
Táto premakaná verzia PHP Manuálu by nikdy neuzrela svetlo
existencie, keby nebolo nasledujúcich µudí, ktorí pomohli
príspevkami k projektu (nedoradení):
<itemizedlist>
<listitem>
<simpara>
Holger Eggert, ktorý vytvoril dva základné designy
a poskytol mnoho u¾itoèných tipov
</simpara>
</listitem>
<listitem>
<simpara>
Gonzalo De la Pena Andreu, ktorý pomohol mnohými komentármi
na tému ako by to bolo namakané so skinova»eµným interface
</simpara>
</listitem>
<listitem>
<simpara>
Olexandr Vynnychenko pridal nespoèetne kibicov a celý èas
pomáhal testovaním
</simpara>
</listitem>
<listitem>
<simpara>
Brendan Ferguson, ktorý pridal mnoho optimalizácií a vylep¹ení
HTML a JS kódu skovávajúcimi sa za stránkami manuálu
</simpara>
</listitem>
<listitem>
<simpara>
Sandor Hojtsy, ktorý nakódoval aplikáciu nastavení manuálu
</simpara>
</listitem>
<listitem>
<simpara>
A nakoniec, ale nie v poslednom rade, ka¾dý, kto poskytol feedback
cez ná¹ mailing list a u¾ívateµský priezkum
</simpara>
</listitem>
</itemizedlist>
</para>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc-sk/chmonly/integration.xml
+++ phpdoc-sk/chmonly/integration.xml
<?xml version="1.0" encoding="iso-8859-2"?>
<!-- EN-Revision: 1.3 Maintainer: analytik Status: working -->
<chapter id="chm.integration">
<title>Integrovanie PHP Manuálu</title>
<para>
<note>
<para>
Nasledujúce informácie sú namierené hlavne na autorov IDE, popr.
na pokroèilých u¾ívateµov, ktorí by chceli integrova» tento CHM
súbor do ich obµúbených IDE alebo iných
production environment components.
</para>
</note>
</para>
<para>
Existuje pár editorov s podporou pre integráciu CHM, ale budete
potrebova» vedie» pár vecí o tom, èo obsahuje CHM, aby ste mohli
manuál úspe¹ne inegrova» do vá¹ho prostredia.
</para>
<para>
CHM je kompilovaný pomocov XSL stylesheetov z XML zdrojov. Toto je
momentálne jediný prípad z rodiny PHP Manuálu, v¹etky ostatné formy
sú generované s pou¾itím DSSSL stylesheetov. To taktie¾ znamená, ¾e
sa mô¾u objavi» neplánované renderovacie rozdiely. ©peciálny
konverzný skript je spú¹»aný na XSLT výstup, pridáva zopár milých
features a napakuje manuál so súbormi nastavení a prikladmi skinov.
</para>
<para>
Ak ste nikdy nepracovali s CHMkami, mô¾ete si ich predstavi» ako zbalené
súbory s podporou operaèného systému pre prístup k nim, s pridanými
funkciami vyhµadávania a indexovania. Aj keï CHMká mô¾u by» prehliadané
len s pomocou HTML Help Viewer, mô¾ete k súborom v nich pristupva» priamo
pou¾ijúc ¹peciálnu predlo¾ku URL, meno CHM súboru a súbor, ktorý zvnútra
vy¾adujeme. Preto¾e v¹etok obsah helpu je ulo¾ený v HTML súboroch,
mô¾ete si stránky z CHM otvára» v Internet Exploreri.
</para>
<para>
Ak predpokladáme, ¾e ste umiestili <filename>php_manual_sk.chm</filename> do
<filename>c:\phpmanual</filename>, indexový súbor v manuáli (to je ten,
ktorý vidíte prvý krát) mô¾e by» sprístupnený nasledujúcou URL:
<literal>mk:@MSITStore:C:\phpmanual\php_manual_sk.chm::/_index.html</literal>.
Tuná je <literal>mk:@MSITStore:</literal> ¹peciálny "protokol",
<filename>C:\phpmanual\php_manual_sk.chm</filename> je CHMko aj s celou
cestou. Napokon <filename>/_index.html</filename> je cesta k indexovému súboru
vnútri CHMka a <literal>::</literal> je presne to, èo musíte da»
medzi cestou k CHMku a cestou po¾adovaného súboru.
</para>
<para>
<note>
<para>
V¹etky súbory sú v koreòovom adresári CHMka na rozdiel od predchádzajúcich
verzií CHM, ktoré obsahovali adresár s názvom jazyka. Obrázky, style sheety
a iné dodatoèné súbory majú meno zaèínajúce s podtr¾ítkom
(ako indexový súbor vý¹¹ie spomínaný), aby sa vyhlo kolíziám mien.
</para>
</note>
</para>
<para>
Mená generovaných súborov podliehajú tým istým pravidlám ako tie v online manuáli,
len s tým rozdielom, ¾e prípona je <literal>.html</literal> a
nie <literal>.php</literal>. Najdôle¾itej¹ie je, ¾e súbory dokumentujúce
funkcie sú pomenované <filename>function.FUNCNAME.html</filename>,
kde <literal>FUNCNAME</literal> je meno funkcie, so v¹etkými
podtr¾ítkami prevedenými na pomlèky. Tu je pár príkladov:
<filename>function.echo.html</filename>,
<filename>function.mysql-close.html</filename>,
<filename>function.imagecopy.html</filename>.
</para>
<para>
Using all this information, you can show a manual page for a function
requested by a user. A simple example is included in the distribution,
named <filename>php_quickref.hta</filename>. This is a
<ulink url="&url.chm.hta;">HTML Application</ulink> to demonstrate the
simple process of showing a manual page for a function. The
<literal>quickRef()</literal> function defined therein does the job.
</para>
<para>
Ak chcete integrova» manuál do IDE bez priamej
podpory pre PHP manuál (v podstate len zmenu z podtr¾ítka na pomlèku),
mô¾ete pou¾i» súbor <filename>_function.html</filename> na zprístupnenie
stránky funkcie. Tento súbor je jednoducho redirector a mô¾ete mu preda» parameter
cez URL, ako napr. <filename>_function.html#mysql_close</filename>. Táto stránka
vás automaticky redirektuje na stránku funkcie mysql_close
(<filename>function.mysql-close.html</filename>). You can
provide the full path of this file if your IDE supports context sensitive
help, and provide the IDE specified string as the parameter. An example
for this is the UltraEdit 9 intergation (see the edition's website).
</para>
<para>
The index of the manual (accessible via the index tab on the navigation
pane) can also be used for integrational purposes. All the HTML pages
are included in the index with their titles as index terms (including
function description pages).
</para>
<para>
If you are a desktop application developer and would like to tightly
integrate the CHM into your program (such as displaying the TOC tree
in your IDE's help box), you can find more information at
<ulink url="&url.chm.helpware;">&url.chm.helpware;</ulink>, as well as
links to other useful resources. The official site for HTML Help is
at <ulink url="&url.chm;">&url.chm;</ulink>.
</para>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc-sk/chmonly/search.xml
+++ phpdoc-sk/chmonly/search.xml
<?xml version="1.0" encoding="iso-8859-2"?>
<!-- EN-Revision: 1.4 Maintainer: analytik Status: working -->
<chapter id="chm.search">
<title>Full-textové Vyhµadávanie</title>
<para>
Táto edícia PHP Manuálu zahàòa mo¾nos» pokroèilého full textového
vyhµadávanie poskytnutého prehliadaèom. Toto dovoµuje
pou¾ívateµom hlada» v celom helpe slovo po slove.
Napríklad, keï u¾ívateµ vykoná full-texté vyhµadávanie slova
"Apache", na zozname bude ka¾dý topic, ktorý obsahuje slovo "Apache"
Pokroèilé full-textové vyhµadávanie umo¾ní u¾ívateµom vyhµadáva» pomocov boolean,
wildcard, a vetvených výrazov. Ïalej mô¾e u¾ívateµ omedzi» vyhµadávanie
na predo¹lé výsledky, zahrnú» podobné slová, alebo vyhµadáva» len v nadpisoch.
</para>
<para>
The usage of the search feature is fairly straightforward. Click on
the search tab, type in the desired words and press ENTER (or click
on "List Topics"). Then you'll receive a list of matches from the
PHP Manual (and the notes). You can use the button with a right
arrow on it to add boolean operators to your search (or you can type
them in). As you see the results, you can use the column headings
(Title, Location and Rank) to sort the topic list. The default order
is by Rank. You can also adjust some parameters at the bottom of this
tab.
</para>
<para>
The words found are highlighted on the current page in the Topic pane
by default. You can turn off this feature by choosing the "Search
Highlight Off" menu item in the Options menu. To can get this feature
back similarly. If you are viewing a long topic, only the first 500
instances of a search word or phrase will be highlighted, due to a
limitation of the viewer.
</para>
<sect1 id="chm.search.rules">
<title>General searching rules</title>
<para>
A basic search consists of the word or phrase you want to find. You
can use wildcard expressions, nested expressions, boolean operators,
similar word matches, a previous results list, or topic titles to further
define your search.
</para>
<para>
The basic rules for formulating queries are as follows:
<itemizedlist>
<listitem>
<simpara>Searches are not case-sensitive, so you can type your search
in uppercase or lowercase characters.</simpara>
</listitem>
<listitem>
<simpara>
You may search for any combination of letters (a-z) and numbers (0-9).
You cannot search for single letters (a, b, c, etc.) and common
words, like: an, and, as, at, be, but, by, do, for, from, have, he,
in, it, not, of, on, or, she, that, the, there, they, this, to, we,
which, with, you.
</simpara>
</listitem>
<listitem>
<simpara>
Punctuation marks such as the period (.), colon (:), semicolon (;), comma (,),
and hyphen (-) are ignored during a search.
</simpara>
</listitem>
<listitem>
<simpara>Group the elements of your search using double quotes or parentheses to set apart each element. You cannot search for quotation marks.</simpara>
</listitem>
</itemizedlist>
</para>
<para>
<note>
<para>
If you are searching for a file name with an extension, you should group
the entire string in double quotes, ("filename.ext"). Otherwise, the period
will break the file name into two separate terms. The default operation
between terms is AND, so you will create the logical equivalent to
"filename AND ext."
</para>
</note>
</para>
</sect1>
<sect1 id="chm.search.words">
<title>Searching for words or phrases</title>
<para>
You can search for words or phrases and use wildcard expressions.
Wildcard expressions allow you to search for one or more characters
using a question mark or asterisk. The table below describes the
results of these different kinds of searches.
<table>
<title>Word and phrase searches</title>
<tgroup cols="3">
<thead>
<row>
<entry>Search for</entry>
<entry>Example</entry>
<entry>Results</entry>
</row>
</thead>
<tbody>
<row>
<entry>A single word</entry>
<entry>select</entry>
<entry>Topics that contain the word "select". (You will also find its grammatical variations, such as "selector" and "selection".)</entry>
</row>
<row>
<entry>A phrase</entry>
<entry>"new operator" or new operator</entry>
<entry>
<simpara>
Topics that contain the literal phrase "new operator" and all its grammatical variations.
</simpara>
<simpara>
Without the quotation marks, the query is equivalent to specifying "new AND operator," which
will find topics containing both of the individual words, instead of the phrase.
</simpara>
</entry>
</row>
<row>
<entry>Wildcard expressions</entry>
<entry>esc* or HT??</entry>
<entry>
<simpara>
Results for the first example include topics that contain the terms "ESC",
"escape", "escalation", and so on. The asterisk cannot be the only
character in the term.
</simpara>
<simpara>
Results for the second example include topics that contain the terms "HTTP",
"HTML" and so on. The question mark cannot be the only character in the
term.
</simpara>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<note>
<para>
Select the Match similar words check box to include minor grammatical variations
for the phrase you search. This feature only locates variations of the word with
common suffixes. For example, a search on the word "add" will find "added," but
it will not find "additive". This option is independent of other options or syntax.
If you do a titles-only search, variations in titles will be matched. If you use
quotes (or any other query operator) any variation of the word can appear; for
example, "stemmed search" will also match "stemming search".
</para>
</note>
</para>
</sect1>
<sect1 id="chm.search.terms">
<title>Defining search terms</title>
<para>
The AND, OR, NOT, and NEAR operators enable you to precisely define your
search by creating a relationship between search terms. The following table
shows how you can use each of these operators. If no operator is specified,
AND is used. For example, the query "server cgi security" is equivalent
to "server AND cgi AND security".
<table>
<title>Search operators</title>
<tgroup cols="3">
<thead>
<row>
<entry>Search for</entry>
<entry>Example</entry>
<entry>Results</entry>
</row>
</thead>
<tbody>
<row>
<entry>Both terms in the same topic</entry>
<entry>http AND apache</entry>
<entry>Topics containing both the words "http" and "apache".</entry>
</row>
<row>
<entry>Either term in a topic</entry>
<entry>ming OR swflib</entry>
<entry>Topics containing either the word "ming" or the word "swflib" or both.</entry>
</row>
<row>
<entry>The first term without the second term</entry>
<entry>xml NOT expat</entry>
<entry>Topics containing the word "xml" but not the word "expat".</entry>
</row>
<row>
<entry>Both terms in the same topic, close together</entry>
<entry>database NEAR security</entry>
<entry>Topics containing the word "database" within eight words of the word "security".</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<note>
<para>
The |, &, and ! characters can also be used in place of OR AND and
NOT respectively. This may not work if you use a very old version of the
viewer.
</para>
</note>
</para>
</sect1>
<sect1 id="chm.search.nested">
<title>Using nested expressions when searching</title>
<para>
Nested expressions allow you to create complex searches for information.
For example, "html AND ((smtp OR pop3) NEAR mail)" finds topics
containing the word "html" along with the words "smtp" and "mail"
close together, or containing "html" along with the words "pop3" and
"mail" close together.
</para>
<para>
The basic rules for searching help topics using nested expressions are
as follows:
<itemizedlist>
<listitem>
<simpara>
You can use parentheses to nest expressions within a query. The
expressions in parentheses are evaluated before the rest of the query.
</simpara>
</listitem>
<listitem>
<simpara>
If a query does not contain a nested expression, it is evaluated from left to right.
For example: "mail NOT pop3 OR smtp" finds topics containing the word "mail" without
the word "pop3" or topics containing the word "smtp". On the other hand, "mail NOT
(pop3 OR smtp)" finds topics containing the word "mail" without either of the words
"pop3" or "smtp".
</simpara>
</listitem>
<listitem>
<simpara>You cannot nest expressions more than five levels deep.</simpara>
</listitem>
</itemizedlist>
</para>
</sect1>
<sect1 id="chm.search.notes">
<title>Manual Content and User Note Separation</title>
<para>
The manual content and the user notes are separated to
<filename>php_manual_LANG.chm</filename> and
<filename>php_manual_notes.chm</filename>. There were several resons
to do this, including:
<itemizedlist>
<listitem>
<simpara>
This way you can update the user notes and the manual independently
as you need.
</simpara>
</listitem>
<listitem>
<simpara>
You can have more than one language of the manual, while only
need to have one notes file. All the CHM files need to be in the
same directory, and all translations need to share the same
preferences if you would not like to have more then one notes file.
</simpara>
</listitem>
<listitem>
<simpara>
You can bookmark manual pages with notes, or just a notes part
of a page separately.
</simpara>
</listitem>
<listitem>
<simpara>
You can "turn off" user note display and user note search results by
simply deleting <filename>php_manual_notes.chm</filename>, moving it
out of the directory or renaming it.
</simpara>
</listitem>
</itemizedlist>
All these benefits lead us to provide the manual the way you can see it
right now. This distribution had the effect on the full text search that
you get search results from the manual content and from the user notes
as separate ones. The "Location" column shows the source of the result,
also enabling you to "add precedence" to manual content results with
ordering the results by "Location". User note page titles are also
prefixed with "N:" to make them easily distinguisable in the favorites
list (there's no location info in the favorites list).
</para>
</sect1>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->