archived-doc-es/chmonly/integration.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: lboshell Status: ready -->
 <chapter xml:id="chm.integration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>Integración del manual de PHP</title>

  <para>
   <note>
    <para>
     La información ofrecida aquí está dirigida principalmente a autores de IDEs,
     o usuarios avanzados que quisieran integrar éste archivo CHM con sus
     IDEs favoritos u otros componentes de entornos de producción.
    </para>
   </note>
  </para>
  <para>
   Existen varios editores en la actualidad que ofrecen integración con CHM,
   pero puede que necesite saber algunas cosas sobre los contenidos CHM para integrar
   satisfactoriamente el manual a su entorno.
  </para>
  <para>
   El documento CHM es construido usando tablas de estilos XSL a partir de fuentes XML. Este hecho es
   único actualmente en la familia del Manual de PHP, ya que todas las otras versiones son
   generadas usando tablas de estilo DSSSL. Esto también quiere decir que
   pueden surgir algunas diferencias de visualización no intencionales. Un script especial
   de conversión es ejecutado sobre la salida XSLT, agregando varias
   características interesantes, y empaquetando el manual con los archivos de preferencias y
   muestras de skins.
  </para>
  <para>
   Si nunca ha trabajado con CHMs, puede pensar en ellos como archivos comprimidos
   con soporte integrado del SO para el acceso a archivos y soporte adicional para búsquedas
   e índices. Aunque los archivos CHM sólo pueden consultarse usando el Visor de Ayuda HTML,
   se puede acceder directamente a archivos al interior de documentos CHM usando un prefijo de URL especial,
   el nombre del archivo CHM y el archivo que desea en el interior. Ya que todo el
   contenido de la ayuda es almacenado en archivos HTML, puede desplegar páginas del CHM
   en Internet Explorer.
  </para>
  <para>
   Asumiendo que usted colocó su archivo <filename>php_manual_en.chm</filename> en
   <filename>c:\phpmanual</filename>, el archivo índice del manual (aquel
   que ve la primera vez) puede ser consultado con la siguiente URL:
   <literal>mk:@MSITStore:C:\phpmanual\php_manual_en.chm::/_index.html</literal>.
   Aquí, <literal>mk:@MSITStore:</literal> es el "protocolo" especial,
   <filename>C:\phpmanual\php_manual_en.chm</filename> es el documento CHM con su
   ruta completa. La parte <filename>/_index.html</filename> es la ruta al
   archivo índice dentro del CHM y <literal>::</literal> es simplemente lo que necesita
   colocar entre la ruta CHM y ésta ruta de archivo.
  </para>
  <para>
   <note>
    <para>
     Todos los archivos se encuentran en el directorio raíz del CHM, a diferencia de versiones previas
     de CHM que incluían un directorio de lenguaje. Las imágenes, tables de estilos
     y otros archivos suplementarios tienen nombres que inician con un caracter de subrayado
     (como ocurre con el índice principal mostrado anteriormente), para evitar colisiones de nombres.
    </para>
   </note>
  </para>
  <para>
   Los nombres de los archivos generados siguen las mismas reglas que
   el manual en línea, excepto que la extensión es <literal>.html</literal> y
   no <literal>.php</literal>. La más importante es que los archivos de
   documentación de funciones reciben nombres de la forma <filename>function.FUNCNAME.html</filename>,
   en donde <literal>FUNCNAME</literal> es el nombre de la función, con todos
   los signos de subrayado convertidos en guiones. Algunos ejemplos son
   <filename>function.echo.html</filename>,
   <filename>function.mysql-close.html</filename>,
   <filename>function.imagecopy.html</filename>.
  </para>
  <para>
   Usando toda esta información, usted puede mostrar una página del manual para una función solicitada
   por un usuario. Un ejemplo simple es incluido en la distribución,
   llamado <filename>php_quickref.hta</filename>. ésta es una
   <link xlink:href="&url.chm.hta;">Aplicación HTML</link> parA demostrar el
   simple proceso de mostrar una página del manual que hace referencia a una función. La
   función <literal>quickRef()</literal> definida allí cumple con esta tarea.
  </para>
  <para>
   Si se quiere integrar el manual en un IDE sin soporte directo
   para el manual de PHP (en realidad, la conversión de signos de subrayado en guiones),
   puede usar el archivo <filename>_function.html</filename> incluido para acceder a
   una página de función, Este archivo es simplemente un enrutador, y puede ser parametrizado a través de
   la URL, como <filename>_function.html#mysql_close</filename>. Esta página
   le redireccionará a la página de la función mysql_close
   (<filename>function.mysql-close.html</filename>) automáticamente. Puede
   proveer la ruta completa de este archivo si su IDE soporta la ayuda sensible a contexto,
   y proveer la cadena especificada por el IDE como el parámetro. Un ejemplo
   de esto es la integración de UltraEdit 9 (vea la página web de edición).
  </para>
  <para>
   El índice del manual (asequible a través de la pestaña de índice en el panel de navegación)
   puede ser usado también para propósitos de integración. Todas las páginas HTML
   son incluidas en el índice con sus títulos como términos de indexación (incluyendo
   páginas de descripción de funciones).
  </para>
  <para>
   Si usted es un desarrollador de aplicaciones de escritorio y quiesiera
   integrar profundamente el CHM con su programa (como por ejemplo desplegando el árbol de la tabla de contenidos
   en el cuadro de ayuda de su IDE), puede encontrar más información en
   <link xlink:href="&url.chm.helpware;">&url.chm.helpware;</link>, así como en otros
   recursos útiles. El sitio oficial del formato HTML Help se encuentra en
   <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
-->