Update to en parsefile.xml + infostyle

This commit is contained in:
Mikhail Alferov
2024-10-16 05:48:26 +03:00
committed by GitHub
parent eebc6152c8
commit 67742be5f6

View File

@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2b84fa46e30d9611e9b5d3af877a7e9ab5c7411a Maintainer: mch Status: ready -->
<!-- EN-Revision: 8bcc6238e8017a8a78c23b7256c55617ada5d385 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="tidy.parsefile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy::parseFile</refname>
<refname>tidy_parse_file</refname>
<refpurpose>Разбор разметки в файле или URI</refpurpose>
<refpurpose>Разбирает разметку в файле или URI-идентификаторе</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -26,7 +26,7 @@
<methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Разбор полученного файла.
Функция разбирает файл.
</para>
</refsect1>
@ -38,9 +38,9 @@
<term><parameter>filename</parameter></term>
<listitem>
<para>
Если получен параметр <parameter>filename</parameter>, то функция
прочитает этот файл и инициализирует объект с этим файлом,
так же как делает это функция <function>tidy_parse_file</function>.
С параметром <parameter>filename</parameter> функция
считает этот файл и инициализирует объект с этим файлом.
Функция действует аналогично функции <function>tidy_parse_file</function>.
</para>
</listitem>
</varlistentry>
@ -48,13 +48,12 @@
<term><parameter>config</parameter></term>
<listitem>
<para>
Настройки <parameter>config</parameter> могут быть заданы в виде
массива или строки. Если задана строка, то она интерпретируется как
имя файла конфигурации, в противном случае, параметр
интерпретируется как сами настройки.
В аргументе <parameter>config</parameter> передают массив или строку.
Функция интерпретирует строку как название файла конфигурации,
а массив как сами параметры.
</para>
<para>
Информацию о каждом параметре можно найти тут:
Объяснение параметров доступно по ссылке:
<link xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
</listitem>
@ -63,13 +62,13 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Параметр <parameter>encoding</parameter> устанавливает кодировку для
входных/выходных документов. Возможные значения:
Параметр <parameter>encoding</parameter> устанавливает кодировку
для входных и выходных документов. Параметр принимает значения:
<literal>ascii</literal>, <literal>latin0</literal>, <literal>latin1</literal>,
<literal>raw</literal>, <literal>utf8</literal>, <literal>iso2022</literal>,
<literal>mac</literal>, <literal>win1252</literal>, <literal>ibm858</literal>,
<literal>utf16</literal>, <literal>utf16le</literal>, <literal>utf16be</literal>,
<literal>big5</literal>, и <literal>shiftjis</literal>.
<literal>big5</literal> и <literal>shiftjis</literal>.
</para>
</listitem>
</varlistentry>
@ -77,7 +76,8 @@
<term><parameter>useIncludePath</parameter></term>
<listitem>
<para>
Поиск файла в <link linkend="ini.include-path">include_path</link>.
Параметр выполняет поиск файла в списке путей директивы
<link linkend="ini.include-path">include_path</link>.
</para>
</listitem>
</varlistentry>
@ -88,9 +88,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<methodname>tidy::parseFile</methodname> возвращает &true; в случае успешного выполнения.
<function>tidy_parse_file</function> возвращает новый экземпляр <classname>tidy</classname> в случае успешного выполнения.
И метод, и функция возвращают &false; в случае возникновения ошибки.
В случае успешного выполнения метод <methodname>tidy::parseFile</methodname> возвращает &true;.
Функция <function>tidy_parse_file</function> в случае успешного выполнения
возвращает новый экземпляр <classname>tidy</classname>.
И метод, и функция возвращают &false;, если возникла ошибка.
</para>
</refsect1>
@ -108,7 +109,8 @@
<row>
<entry>8.0.0</entry>
<entry>
<parameter>config</parameter> и <parameter>encoding</parameter> теперь допускают значение null.
Параметры <parameter>config</parameter> и <parameter>encoding</parameter>
теперь принимают значение &null;.
</entry>
</row>
</tbody>
@ -120,19 +122,21 @@
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>tidy::parseFile</function></title>
<title>Пример разбора файла методом <function>tidy::parseFile</function></title>
<programlisting role="php">
<![CDATA[
<?php
$tidy = new tidy();
$tidy->parseFile('file.html');
$tidy->cleanRepair();
if(!empty($tidy->errorBuffer)) {
if (!empty($tidy->errorBuffer)) {
echo "Возникли следующие ошибки или предупреждения:\n";
echo $tidy->errorBuffer;
}
?>
]]>
</programlisting>
@ -143,9 +147,9 @@ if(!empty($tidy->errorBuffer)) {
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>tidy::parsestring</function></member>
<member><function>tidy::repairfile</function></member>
<member><function>tidy::repairstring</function></member>
<member><function>tidy::parseString</function></member>
<member><function>tidy::repairFile</function></member>
<member><function>tidy::repairString</function></member>
</simplelist>
</refsect1>