Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions chmonly/integration.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: lacatoire Status: ready -->
<chapter xml:id="chm.integration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Integrare il Manuale PHP</title>

<para>
<note>
<para>
Le informazioni fornite qui sono principalmente rivolte agli autori di IDE, o
agli utenti avanzati che desiderano integrare questo file CHM nei loro
IDE preferiti o in altri componenti dell'ambiente di produzione.
</para>
</note>
</para>
<para>
Esistono diversi editor con supporto per l'integrazione CHM,
ma potresti aver bisogno di conoscere alcune cose sul contenuto del CHM
per integrare con successo il manuale nel tuo ambiente.
</para>
<para>
Il CHM è costruito utilizzando fogli di stile XSL da sorgenti XML. Questo è
attualmente unico nella famiglia del Manuale PHP, poiché tutte le altre versioni sono
generate utilizzando fogli di stile DSSSL. Questo significa anche che
potrebbero verificarsi differenze di rendering non intenzionali. Uno speciale
script di conversione viene eseguito sull'output XSLT, aggiungendo diverse
funzionalità interessanti, e impacchettando il manuale con i file delle preferenze
e gli esempi di skin.
</para>
<para>
Se non hai mai lavorato con i CHM, puoi pensarli come file compressi
con accesso ai file interni supportato dal sistema operativo e con supporto aggiuntivo
per ricerca e indice. Tuttavia i CHM possono essere visualizzati solo utilizzando HTML Help
Viewer, puoi accedere direttamente ai file al loro interno utilizzando un prefisso URL
speciale, il nome del file CHM e il file che richiedi dall'interno. Poiché tutto
il contenuto dell'aiuto è memorizzato in file HTML, puoi mostrare le pagine del CHM
in Internet Explorer.
</para>
<para>
Supponiamo che tu abbia posizionato il tuo <filename>php_manual_it.chm</filename> in
<filename>c:\phpmanual</filename>, il file indice nel manuale (che
vedi la prima volta) può essere accessibile con il seguente URL:
<literal>mk:@MSITStore:C:\phpmanual\php_manual_it.chm::/_index.html</literal>.
Qui <literal>mk:@MSITStore:</literal> è il "protocollo" speciale,
<filename>C:\phpmanual\php_manual_it.chm</filename> è il CHM con il suo
percorso completo. La parte <filename>/_index.html</filename> è il percorso del
file indice all'interno del CHM e <literal>::</literal> è semplicemente ciò che devi
mettere tra il percorso del CHM e questo percorso del file.
</para>
<para>
<note>
<para>
Tutti i file sono nella directory radice del CHM, a differenza delle precedenti
versioni CHM che includevano una directory per la lingua. Immagini, fogli di stile
e altri file supplementari hanno nomi che iniziano con un underscore
(come l'indice principale mostrato sopra), per evitare collisioni di nomi.
</para>
</note>
</para>
<para>
I nomi dei file generati seguono le stesse regole del manuale
online, tranne che l'estensione è <literal>.html</literal> e
non <literal>.php</literal>. La cosa più importante è che i file
di documentazione delle funzioni sono denominati <filename>function.NOMEFUNZIONE.html</filename>
dove <literal>NOMEFUNZIONE</literal> è il nome della funzione, con tutti
gli underscore convertiti in trattini. Alcuni esempi sono
<filename>function.echo.html</filename>,
<filename>function.mysql-close.html</filename>,
<filename>function.imagecopy.html</filename>.
</para>
<para>
Utilizzando tutte queste informazioni, puoi mostrare una pagina del manuale per una funzione
richiesta da un utente. Un semplice esempio è incluso nella distribuzione,
denominato <filename>php_quickref.hta</filename>. Questa è una
<link xlink:href="&url.chm.hta;">HTML Application</link> per dimostrare il
semplice processo di mostrare una pagina del manuale per una funzione. La
funzione <literal>quickRef()</literal> definita al suo interno fa il lavoro.
</para>
<para>
Se desideri integrare il manuale in un IDE senza supporto diretto
per il manuale PHP (in particolare la conversione da underscore a trattino),
puoi utilizzare il file <filename>_function.html</filename> incluso per accedere
a una pagina di funzione. Questo file è semplicemente un redirector, e può essere parametrizzato tramite
l'URL, come <filename>_function.html#mysql_close</filename>. Questa pagina
ti reindirizzerà automaticamente alla pagina della funzione mysql_close
(<filename>function.mysql-close.html</filename>). Puoi
fornire il percorso completo di questo file se il tuo IDE supporta l'aiuto
contestuale, e fornire la stringa specificata dall'IDE come parametro. Un esempio
per questo è l'integrazione con UltraEdit 9 (vedi il sito web dell'edizione).
</para>
<para>
L'indice del manuale (accessibile tramite la scheda indice nel pannello
di navigazione) può anche essere utilizzato per scopi di integrazione. Tutte le pagine HTML
sono incluse nell'indice con i loro titoli come termini dell'indice (incluse
le pagine di descrizione delle funzioni).
</para>
<para>
Se sei uno sviluppatore di applicazioni desktop e desideri integrare
strettamente il CHM nel tuo programma (come visualizzare l'albero TOC
nella casella di aiuto del tuo IDE), puoi trovare maggiori informazioni su
<link xlink:href="&url.chm.helpware;">&url.chm.helpware;</link>, così come
link ad altre risorse utili. Il sito ufficiale per HTML Help è
su <link xlink:href="&url.chm;">&url.chm;</link>.
</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:"~/.phpdoc/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
-->
Loading