diff --git a/chmonly/aboutchm.xml b/chmonly/aboutchm.xml new file mode 100644 index 000000000..61ce60684 --- /dev/null +++ b/chmonly/aboutchm.xml @@ -0,0 +1,61 @@ + + + + Sobre Esta Edição + + + A Edição de Ajuda HTML para Windows do Manual do PHP é destinada a + desenvolvedores que desejam ter o manual sempre à mão e gostariam + de ler páginas de manual e notas do usuário sem esperar o download + de uma página da web remota. Esta edição oferece o conteúdo completo do + manual mais as notas do usuário, com alguns ótimos recursos fornecidos pela + aplicação de visualização, pelos scripts usados para gerar esse + formato e por outros contribuidores na forma de skins. + + + + Esta distribuição do Manual do PHP contém muitos arquivos, incluindo o + arquivo principal do manual php_manual_pt_BR.chm. O manual + pode ser visualizado clicando duas vezes neste arquivo (como você já percebeu). + + Um arquivo php_manual_pt_BR.chw também pode ser visto no + diretório, ele é gerado na primeira vez que a guia de índice é usada e + contém um índice com as páginas do manual. + + + + Para aqueles interessados ​​em detalhes técnicos sobre a Ajuda HTML da Microsoft, + &url.chm.helpware; é um ótimo + recurso. Para obter mais informações e o posicionamento da Ajuda HTML do + Windows nos formatos de ajuda e histórico de serviços da Microsoft, consulte este + artigo do WinWriters. + + + + + diff --git a/chmonly/integration.xml b/chmonly/integration.xml new file mode 100644 index 000000000..a532fa828 --- /dev/null +++ b/chmonly/integration.xml @@ -0,0 +1,125 @@ + + + + Integrando o Manual do PHP + + + + + As informações fornecidas aqui destinam-se principalmente a autores de IDE ou + usuários avançados que desejam integrar este arquivo CHM aos seus + IDEs favoritos ou outros componentes do ambiente de produção. + + + + + Existem vários editores com suporte para integração CHM, + mas pode ser necessário saber algumas coisas sobre o que o CHM contém + para integrar o manual com sucesso no ambiente. + + + O CHM é construído usando folhas de estilo XSL de fontes XML. Atualmente, + isso é único na família do Manual do PHP, já que todas as outras versões são + geradas usando folhas de estilo DSSSL. Isso também significa que podem + surgir diferenças de renderização não intencionais. Um script de + conversão especial é executado na saída XSLT, adicionando vários recursos + interessantes e empacotando o manual com os arquivos de preferências + e exemplos de skin. + + + Para quem nunca trabalhou com CHMs, eles podem ser considerados como arquivos compactados + com acesso compatível com o sistema operacional para arquivos internos e algum suporte + adicional de pesquisa e índice. No entanto, os CHMs só podem ser visualizados usando o HTML + Help Viewer. Pode-se acessar diretamente os arquivos dentro deles usando um prefixo de URL + especial, o nome do arquivo CHM e o arquivo solicitado. Como todo o + conteúdo da ajuda é armazenado em arquivos HTML, as páginas do CHM podem ser mostradas + no Internet Explorer. + + + Assumindo que o arquivo php_manual_pt_BR.chm está localizado em + c:\phpmanual, o arquivo de índice no manual (que + é visto no primeiro acesso) pode ser acessado com o seguinte URL: + mk:@MSITStore:C:\phpmanual\php_manual_pt_BR.chm::/_index.html. + Aqui, mk:@MSITStore: é o "protocolo" especial, + C:\phpmanual\php_manual_pt_BR.chm é o arquivo CHM com seu + caminho completo. A parte /_index.html é o caminho para o + arquivo de índice dentro do CHM e :: é o que precisa ser + inserido entre o caminho CHM e este caminho de arquivo. + + + + + Todos os arquivos estão no diretório raiz do CHM, ao contrário das versões + anteriores do CHM que incluíam um diretório de idioma. Imagens, folhas de estilo + e outros arquivos suplementares têm nomes que começam com sublinhado + (como o índice principal mostrado acima), para evitar colisões de nomes. + + + + + Os nomes dos arquivos gerados seguem as mesmas regras do manual + online, exceto que a extensão é .html e + não .php. O mais importante é que os arquivos + de documentação da função sejam denominados function.FUNCNAME.html + onde FUNCNAME é o nome da função, com todos + os sublinhados convertidos em hífens. Alguns exemplos são + function.echo.html, + function.mysql-close.html e + function.imagecopy.html. + + + Usando todas essas informações, pode-se mostrar uma página de manual para uma função + solicitada por um usuário. Um exemplo simples está incluído na distribuição, + chamado php_quickref.hta. Este é um + aplicativo HTML para demonstrar o + processo simples de mostrar uma página de manual para uma função. A + função quickRef() definida aqui faz o trabalho. + + + Se a intenção for integrar o manual em um IDE sem suporte direto + para o manual do PHP (na verdade, a conversão de sublinhado para hífen), + pode-se usar o arquivo _function.html incluído para acessar + uma página de funções. Este arquivo é simplesmente um redirecionador e pode ser parametrizado através + da URL, como _function.html#mysql_close. Esta página + irá redirecioná-lo para a página da função mysql_close + (function.mysql-close.html) automaticamente. Pode-se + fornecer o caminho completo deste arquivo se o IDE suportar ajuda sensível ao + contexto e fornecer a string especificada do IDE como parâmetro. Um exemplo + disso é a integração UltraEdit 9 (veja o site de edição). + + + O índice do manual (acessível através da guia índice no painel de + navegação) também pode ser usado para fins de integração. Todas as páginas HTML + são incluídas no índice com seus títulos como termos de índice (incluindo + páginas de descrição de funções). + + + No caso de desenvolvedores de aplicações aotônomas que gostariam de integrar totalmente + o CHM à aplicação (como exibir a árvore de Tabela de Conteúdo + na caixa de ajuda do IDE), mais informação pode ser encontrada em + &url.chm.helpware;, bem como + atalhos para outros recursos úteis. A página oficial da Ajuda HTML está em + &url.chm;. + + + +