Skip to content

Commit 9ccd9e9

Browse files
leonardolaraleonardolara
committed
initial translation in chmonly
1 parent 9deccec commit 9ccd9e9

File tree

2 files changed

+186
-0
lines changed

2 files changed

+186
-0
lines changed

‎chmonly/aboutchm.xml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: leonardolara Status: ready -->
3+
<chapter xml:id="chm.about" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<title>Sobre Esta Edição</title>
5+
6+
<para>
7+
A Edição de Ajuda HTML para Windows do Manual do PHP é destinada a
8+
desenvolvedores que desejam ter o manual sempre à mão e gostariam
9+
de ler páginas de manual e notas do usuário sem esperar o download
10+
de uma página da web remota. Esta edição oferece o conteúdo completo do
11+
manual mais as notas do usuário, com alguns ótimos recursos fornecidos pela
12+
aplicação de visualização, pelos scripts usados para gerar esse
13+
formato e por outros contribuidores na forma de skins.
14+
</para>
15+
16+
<para>
17+
Esta distribuição do Manual do PHP contém muitos arquivos, incluindo o
18+
arquivo principal do manual <filename>php_manual_pt_BR.chm</filename>. O manual
19+
pode ser visualizado clicando duas vezes neste arquivo (como você já percebeu).
20+
<!--
21+
The user notes are in <filename>php_manual_notes.chm</filename>. You
22+
only need to have one copy of this file on your computer, regardless
23+
of how many languages you use to read the PHP Manual. The only
24+
requirement is that you need to have all <filename>php_manual_LANG.chm</filename>
25+
files in one directory with <filename>php_manual_notes.chm</filename>.
26+
-->
27+
Um arquivo <filename>php_manual_pt_BR.chw</filename> também pode ser visto no
28+
diretório, ele é gerado na primeira vez que a guia de índice é usada e
29+
contém um índice com as páginas do manual.
30+
</para>
31+
32+
<para>
33+
Para aqueles interessados ​​em detalhes técnicos sobre a Ajuda HTML da Microsoft,
34+
<link xlink:href="&url.chm.helpware;">&url.chm.helpware;</link> é um ótimo
35+
recurso. Para obter mais informações e o posicionamento da Ajuda HTML do
36+
Windows nos formatos de ajuda e histórico de serviços da Microsoft, consulte este
37+
<link xlink:href="&url.chm.history;">artigo do WinWriters</link>.
38+
</para>
39+
40+
</chapter>
41+
42+
<!-- Keep this comment at the end of the file
43+
Local variables:
44+
mode: sgml
45+
sgml-omittag:t
46+
sgml-shorttag:t
47+
sgml-minimize-attributes:nil
48+
sgml-always-quote-attributes:t
49+
sgml-indent-step:1
50+
sgml-indent-data:t
51+
indent-tabs-mode:nil
52+
sgml-parent-document:nil
53+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
54+
sgml-exposed-tags:nil
55+
sgml-local-catalogs:nil
56+
sgml-local-ecat-files:nil
57+
End:
58+
vim600: syn=xml fen fdm=syntax fdl=2 si
59+
vim: et tw=78 syn=sgml
60+
vi: ts=1 sw=1
61+
-->

‎chmonly/integration.xml

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: leonardolara Status: ready -->
3+
<chapter xml:id="chm.integration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<title>Integrando o Manual do PHP</title>
5+
6+
<para>
7+
<note>
8+
<para>
9+
As informações fornecidas aqui destinam-se principalmente a autores de IDE ou
10+
usuários avançados que desejam integrar este arquivo CHM aos seus
11+
IDEs favoritos ou outros componentes do ambiente de produção.
12+
</para>
13+
</note>
14+
</para>
15+
<para>
16+
Existem vários editores com suporte para integração CHM,
17+
mas pode ser necessário saber algumas coisas sobre o que o CHM contém
18+
para integrar o manual com sucesso no ambiente.
19+
</para>
20+
<para>
21+
O CHM é construído usando folhas de estilo XSL de fontes XML. Atualmente,
22+
isso é único na família do Manual do PHP, já que todas as outras versões são
23+
geradas usando folhas de estilo DSSSL. Isso também significa que podem
24+
surgir diferenças de renderização não intencionais. Um script de
25+
conversão especial é executado na saída XSLT, adicionando vários recursos
26+
interessantes e empacotando o manual com os arquivos de preferências
27+
e exemplos de skin.
28+
</para>
29+
<para>
30+
Para quem nunca trabalhou com CHMs, eles podem ser considerados como arquivos compactados
31+
com acesso compatível com o sistema operacional para arquivos internos e algum suporte
32+
adicional de pesquisa e índice. No entanto, os CHMs só podem ser visualizados usando o HTML
33+
Help Viewer. Pode-se acessar diretamente os arquivos dentro deles usando um prefixo de URL
34+
especial, o nome do arquivo CHM e o arquivo solicitado. Como todo o
35+
conteúdo da ajuda é armazenado em arquivos HTML, as páginas do CHM podem ser mostradas
36+
no Internet Explorer.
37+
</para>
38+
<para>
39+
Assumindo que o arquivo <filename>php_manual_pt_BR.chm</filename> está localizado em
40+
<filename>c:\phpmanual</filename>, o arquivo de índice no manual (que
41+
é visto no primeiro acesso) pode ser acessado com o seguinte URL:
42+
<literal>mk:@MSITStore:C:\phpmanual\php_manual_pt_BR.chm::/_index.html</literal>.
43+
Aqui, <literal>mk:@MSITStore:</literal> é o "protocolo" especial,
44+
<filename>C:\phpmanual\php_manual_pt_BR.chm</filename> é o arquivo CHM com seu
45+
caminho completo. A parte <filename>/_index.html</filename> é o caminho para o
46+
arquivo de índice dentro do CHM e <literal>::</literal> é o que precisa ser
47+
inserido entre o caminho CHM e este caminho de arquivo.
48+
</para>
49+
<para>
50+
<note>
51+
<para>
52+
Todos os arquivos estão no diretório raiz do CHM, ao contrário das versões
53+
anteriores do CHM que incluíam um diretório de idioma. Imagens, folhas de estilo
54+
e outros arquivos suplementares têm nomes que começam com sublinhado
55+
(como o índice principal mostrado acima), para evitar colisões de nomes.
56+
</para>
57+
</note>
58+
</para>
59+
<para>
60+
Os nomes dos arquivos gerados seguem as mesmas regras do manual
61+
online, exceto que a extensão é <literal>.html</literal> e
62+
não <literal>.php</literal>. O mais importante é que os arquivos
63+
de documentação da função sejam denominados <filename>function.FUNCNAME.html</filename>
64+
onde <literal>FUNCNAME</literal> é o nome da função, com todos
65+
os sublinhados convertidos em hífens. Alguns exemplos são
66+
<filename>function.echo.html</filename>,
67+
<filename>function.mysql-close.html</filename> e
68+
<filename>function.imagecopy.html</filename>.
69+
</para>
70+
<para>
71+
Usando todas essas informações, pode-se mostrar uma página de manual para uma função
72+
solicitada por um usuário. Um exemplo simples está incluído na distribuição,
73+
chamado <filename>php_quickref.hta</filename>. Este é um
74+
<link xlink:href="&url.chm.hta;">aplicativo HTML</link> para demonstrar o
75+
processo simples de mostrar uma página de manual para uma função. A
76+
função <literal>quickRef()</literal> definida aqui faz o trabalho.
77+
</para>
78+
<para>
79+
Se a intenção for integrar o manual em um IDE sem suporte direto
80+
para o manual do PHP (na verdade, a conversão de sublinhado para hífen),
81+
pode-se usar o arquivo <filename>_function.html</filename> incluído para acessar
82+
uma página de funções. Este arquivo é simplesmente um redirecionador e pode ser parametrizado através
83+
da URL, como <filename>_function.html#mysql_close</filename>. Esta página
84+
irá redirecioná-lo para a página da função mysql_close
85+
(<filename>function.mysql-close.html</filename>) automaticamente. Pode-se
86+
fornecer o caminho completo deste arquivo se o IDE suportar ajuda sensível ao
87+
contexto e fornecer a string especificada do IDE como parâmetro. Um exemplo
88+
disso é a integração UltraEdit 9 (veja o site de edição).
89+
</para>
90+
<para>
91+
O índice do manual (acessível através da guia índice no painel de
92+
navegação) também pode ser usado para fins de integração. Todas as páginas HTML
93+
são incluídas no índice com seus títulos como termos de índice (incluindo
94+
páginas de descrição de funções).
95+
</para>
96+
<para>
97+
No caso de desenvolvedores de aplicações aotônomas que gostariam de integrar totalmente
98+
o CHM à aplicação (como exibir a árvore de Tabela de Conteúdo
99+
na caixa de ajuda do IDE), mais informação pode ser encontrada em
100+
<link xlink:href="&url.chm.helpware;">&url.chm.helpware;</link>, bem como
101+
atalhos para outros recursos úteis. A página oficial da Ajuda HTML está em
102+
<link xlink:href="&url.chm;">&url.chm;</link>.
103+
</para>
104+
</chapter>
105+
106+
<!-- Keep this comment at the end of the file
107+
Local variables:
108+
mode: sgml
109+
sgml-omittag:t
110+
sgml-shorttag:t
111+
sgml-minimize-attributes:nil
112+
sgml-always-quote-attributes:t
113+
sgml-indent-step:1
114+
sgml-indent-data:t
115+
indent-tabs-mode:nil
116+
sgml-parent-document:nil
117+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
118+
sgml-exposed-tags:nil
119+
sgml-local-catalogs:nil
120+
sgml-local-ecat-files:nil
121+
End:
122+
vim600: syn=xml fen fdm=syntax fdl=2 si
123+
vim: et tw=78 syn=sgml
124+
vi: ts=1 sw=1
125+
-->

0 commit comments

Comments
 (0)