Difference between revisions of "Lazarus Documentation Editor/ru"

From Free Pascal wiki
Jump to navigationJump to search
Line 24: Line 24:
 
[[Image:Lazdemain.png|bottom]]
 
[[Image:Lazdemain.png|bottom]]
  
−
=== Documenting the LCL ===
+
=== Документирование LCL ===
  
 
[[Image:Lazdeelements.png|left]]
 
[[Image:Lazdeelements.png|left]]
  
−
Opening the "Packages" node shows the "LCL" node which contains a "Dialogs" node. Selecting this last node fills the lower treeview with elements. These elements list the Constants, Types and Classes defined in the Dialogs.pp unit. Any units used by dialogs.pp are also added as further nodes.  
+
Открытие узла "Packages"(пакеты) показывает узел "LCL", который содержит узел "Dialogs"(диалоги). Выбор этого последнего узла заполняет нижнюю TreeView с элементами. Эти элементы списка Constants (константы), Types (типы) and Classes (классы) определены в модуле Dialogs.pp. Любые модули, используемые dialogs.pp также добавляются в качестве дополнительных узлов.
−
Other nodes are added for the properties of a class, the parameters of functions and procedures, and so on.
+
Другие узлы добавляются для свойств класса, параметров функций и процедур, и так далее.
  
−
Selecting a node in the lower left treeview displays the content of that node on the right side of the window.
+
Выбор узла в нижнем левом дереве отображает содержимое этого узла с правой стороны окна.
  
−
When you look at [http://lazarus-ccr.sourceforge.net/docs/lcl/dialogs/index-4.html this page] you see an overview of classes defined in the "dialogs" unit. After each class you see a line of text which is whatever was entered in lazde's "short" editbox.
+
Если взглянуть на [https://lazarus-ccr.sourceforge.io/docs/lcl/dialogs/index-4.html эту страницу], вы увидите обзор классов, определенных в модуле "dialogs". Напротив названия каждого класса вы увидите строку текста-пояснения, который был введен в «короткий» EditBox редактора lazde.
  
−
Below the "short" editbox, there is a memo field where you can enter a longer description of the component or property.
+
Далее под «коротким» EditBox будет  подразумеваться поле для заметок, куда вы можете вводить более подробное описание компонента или свойства.
  
−
{{Note|If you want to insert a line break use <nowiki><br/></nowiki>}}
+
{{Note|Если вы хотите вставить новую строку, используйте тэг <nowiki><br/></nowiki>}}
  
 
Below the main description field are further fields labelled "Errors", "See also" and "Example code File".
 
Below the main description field are further fields labelled "Errors", "See also" and "Example code File".
 +
Ниже основного описания поля есть дополнительными поля, обозначенные как "Errors" (ошибки), "See also" (см. также) и "Example code File" (файл с кодом примера).
  
−
"Errors" is used to give information about any errors raised by a function if parameters have values that are out of range. For an example see [http://lazarus-ccr.sourceforge.net/docs/rtl/dateutils/recodeyear.html this page].
+
"Errors" (ошибки) используется для предоставления информации о каких-либо ошибках, возращаемых функциями, если параметры имеют значение, которые находятся вне заданного диапазона. Например, см. [https://lazarus-ccr.sourceforge.io/docs/rtl/dateutils/recodeyear.html эту страницу].
  
−
The "See also" and "Example code File" fields are each provided with three buttons ([+], [^], [-]). These buttons enable you to add and remove links to other pages or code examples respectively.
+
Каждое поле - "See also" (см. также) и "Example code File" (файл с кодом примера) - снабжено тремя кнопками ({{keypress|+}}, {{keypress|^}}, {{keypress|-}}). Эти кнопки позволяют добавлять и удалять ссылки на другие страницы или примеры кода соответственно.
  
 
== The Outcome ==
 
== The Outcome ==

Revision as of 13:40, 17 September 2019

│ Deutsch (de) │ English (en) │ español (es) │ français (fr) │ 日本語 (ja) │ polski (pl) │ русский (ru) │ slovenčina (sk) │

Введение

Хорошая, исчерпывающая документация является важной недостающей частью Lazarus. Чтобы помочь подготовить необходимую документацию, был разработан инструмент под названием LazDE. На этой странице описывается использование этого инструмента для редактирования существующей документации или для создания новых файлов документации. В этом вики-документе я использую [$LazDir] для обозначения базового каталога Lazarus. Поэтому, когда вы читаете [$LazDir], просто замените его на каталог, соответствующий вашей установке Lazarus.

Обоснование

Основная цель этого проекта документации - сделать доступным онлайн-файл справки. Чтобы сделать файл справки независимым от платформы, мы используем файлы XML для записи и хранения данных документации. Каждый модуль Lazarus имеет свой собственный файл данных XML-документации.

Большое количество таких файлов XML уже написано, и их можно использовать:

  • для создания HTML-страниц, к которым вы можете получить доступ на https://lazarus-ccr.sourceforge.io/docs/lcl/
  • для создания CHM-файлов, которые можно просматривать в автономном режиме (после помещения в правильно зарегистрированный локальный каталог) в качестве справки для Lazarus, которая доступна даже в том случае, если у вас нет доступа к Интернету.

Задача документирования Lazarus выполняется

Как упоминалось выше, XML был выбран в качестве формата данных документации, поскольку он не зависит от платформы. Текущую документацию можно найти в [$LazDir]/docs/xml/. Пока что каталог /lcl/ содержит в основном пустые файлы скелетов, которые содержат мало (или не содержат) полезной документации. XML-файлы, которые вы найдете в этом каталоге, генерируются автоматически и должны быть адаптированы, чтобы быть полезными. Итак, теперь мы знаем, где найти файлы, давайте посмотрим на инструмент, который мы разрабатываем для создания и адаптации файлов данных документации.

Инструмент документирования Lazarus

"Lazde" - это инструмент, предназначенный для редактирования файлов документации XML. Его также можно использовать для генерации базового скелета XML-файла, полученного из исходного файла модуля Pascal, и (с помощью внешнего инструмента FPDoc) для генерации HTML-версии документации. Пример вывода FPDoc можно увидеть здесь, часть документации на данный момент. Поскольку скомпилированные исполняемые версии lazde не поставляются, вы должны самостоятельно создать один экземпляр для себя. Исходники "lazde" можно найти в [$LazDir]/doceditor/. Когда вы соберете и запустите эту программу, если вы откроете [$LazDir]/docs/xml/lcl/dialogs.xml, вы увидите такую картинку

Lazdemain.png

Документирование LCL

Lazdeelements.png

Открытие узла "Packages"(пакеты) показывает узел "LCL", который содержит узел "Dialogs"(диалоги). Выбор этого последнего узла заполняет нижнюю TreeView с элементами. Эти элементы списка Constants (константы), Types (типы) and Classes (классы) определены в модуле Dialogs.pp. Любые модули, используемые dialogs.pp также добавляются в качестве дополнительных узлов. Другие узлы добавляются для свойств класса, параметров функций и процедур, и так далее.

Выбор узла в нижнем левом дереве отображает содержимое этого узла с правой стороны окна.

Если взглянуть на эту страницу, вы увидите обзор классов, определенных в модуле "dialogs". Напротив названия каждого класса вы увидите строку текста-пояснения, который был введен в «короткий» EditBox редактора lazde.

Далее под «коротким» EditBox будет подразумеваться поле для заметок, куда вы можете вводить более подробное описание компонента или свойства.

Light bulb  Примечание: Если вы хотите вставить новую строку, используйте тэг <br/>

Below the main description field are further fields labelled "Errors", "See also" and "Example code File". Ниже основного описания поля есть дополнительными поля, обозначенные как "Errors" (ошибки), "See also" (см. также) и "Example code File" (файл с кодом примера).

"Errors" (ошибки) используется для предоставления информации о каких-либо ошибках, возращаемых функциями, если параметры имеют значение, которые находятся вне заданного диапазона. Например, см. эту страницу.

Каждое поле - "See also" (см. также) и "Example code File" (файл с кодом примера) - снабжено тремя кнопками (+, ^, -). Эти кнопки позволяют добавлять и удалять ссылки на другие страницы или примеры кода соответственно.

The Outcome

Have a look at the description of InputQuery. At the top of the page you can see what the page is about (in this case the InputQuery function from dialogs.pp). The first line of text is what has been entered in the "Short" editbox in lazde.

Next is the declaration of this function taken from the source file dialogs.pp. The declaration part is created by the html-builder and is parsed directly from the sources. Because there are two versions of this function the source position says 0.

Then the arguments are given. When you open the InputQuery node in lazde you will see each argument separately as a child node. The text shown after each argument corresponds to whatever was entered in the "Short" editbox when the respective child node was selected.

The function result is shown as a fourth paragraph. The text shown here has been entered in the same way as for the function's arguments.

Lastly the description is shown. This is the text entered in the description box of lazde.

Adding documentation for new units

There are of course many other units waiting to be documented. If the unit is part of a package, it is likely that there is no xml file for you to start from. You will then have to start from scratch, and lazde has a function to get you off to a flying start. Just go to File -> New and the following screen appears:

Lazdenewdocfromfile.png

You start by naming the package. All units you want to add to this package should be given the same package name. Afterwards you enter the source file to use. You can browse to this file as well. Then enter a name for the output file - do not forget the xml extension! - and click OK.

lazde will then generate the skeleton documentation. The generated file will be opened and the treeview will be populated with all the units, classes, types, functions and so on from your source file. Now you are ready to start documenting a new part of Lazarus.

Have a look at LCL Documentation Roadmap to see which units still need to be documented.

You can use FPDoc Updater to easily update FPDoc files when Pascal units have been changed.

The Final result

What I experienced during the use of the program is that I would like to see how the information is shown in its final stage (as a browsable document). For this purpose lazde makes use of a utility to build all necessary HTML-files.

This utility can be started from the menu Extra -> Build. The following screen will be shown:

Lazdebuild1.png

"Package" should be the same as the name you gave when you created the xml files. For "Format" choose HTML. At "Output" you enter the path where the resulting files should be placed. Press "Add all" and all documents your were working on will be added to the project. Then go to the next to tab

Lazdebuild2.png

and enter the paths to the source files. After you have pressed build your HD will start to rattle and finally the following output will be shown on the "Build output" tab. 

Building docs using command: fpdoc --package="LCL"
--output="/home/matthijs/documentatie/LCL" --format=html --content 
--descr="/home/matthijs/Projecten/Lazarus/doceditor/buttons.xml"
--descr="/home/matthijs/Projecten/Lazarus/doceditor/comctrls.xml"
--descr="/home/matthijs/Projecten/Lazarus/doceditor/dialogs.xml"
--descr="/home/matthijs/Projecten/Lazarus/doceditor/controls.xml"
--input="/home/matthijs/cvsroot/lazarus/lcl/buttons.pp"
--input="/home/matthijs/cvsroot/lazarus/lcl/comctrls.pp"
--input="/home/matthijs/cvsroot/lazarus/lcl/dialogs.pp"
--input="/home/matthijs/cvsroot/lazarus/lcl/controls.pp" 

FPDoc - Free Pascal Documentation Tool
(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org

Writing 2788 pages...
Done.
Documentation successfully built.

When you go to the directory you entered at "Output" you will see a index.html file and (in this case 4) sub directories. Open index.html in your favorit browser and see the result of all your hard work on the documentation. You will be able to follow the links and read it all.

When you plan to continue working on this package of documentation, press "Save" and save the build options. You will be asked to provide a name for the file and the options will be saved. Next time you want to build the HTML-files you can just "load" them again.

Submitting your work

When you are satisfied with your work on Lazarus' documentation, you certainly want to share it with the Lazarus community. All you have to do is make a patch, zip the patch and send it in.

Improvements welcome

Light bulb  Примечание: lazde is a work-in-progress. It does work, but it's certainly not completely finished yet. You may encounter bugs. Feel free to fix them!
Retrieved from "http://wiki.freepascal.org/index.php?title=Lazarus_Documentation_Editor/ru&oldid=127149"