Massive editing.

* Edit Help>Library * Edit Help>Documentation * Edit Help>Firmware * Edit Help>Qt-debugger * Edit Help>Python * Edit Help>CSharp * Edit Help>TANGO * Edit Help>Profiles
EPC-MSU · Jan 15, 2024 · 718a92d · 718a92d
1 parent 4e7ba7f
commit 718a92d
Show file tree

Hide file tree

Showing 27 changed files with 326 additions and 268 deletions.
diff --git a/frontend/static/img/URMC_header_file.png b/frontend/static/img/URMC_header_file.png
diff --git a/frontend/static/img/URPC_CMake_Configure.png b/frontend/static/img/URPC_CMake_Configure.png
diff --git a/frontend/static/img/URPC_CMake_Generate.png b/frontend/static/img/URPC_CMake_Generate.png
diff --git a/frontend/static/img/URPC_CMake_Generator.png b/frontend/static/img/URPC_CMake_Generator.png
diff --git a/frontend/static/img/URPC_CMake_build_dir.png b/frontend/static/img/URPC_CMake_build_dir.png
diff --git a/frontend/static/img/URPC_CMake_src_dir.png b/frontend/static/img/URPC_CMake_src_dir.png
diff --git a/frontend/static/img/URPC_CMake_window.png b/frontend/static/img/URPC_CMake_window.png
diff --git a/frontend/static/img/URPC_Device_choosing.png b/frontend/static/img/URPC_Device_choosing.png
diff --git a/frontend/static/img/URPC_Qt.png b/frontend/static/img/URPC_Qt.png
diff --git a/frontend/static/img/URPC_VS_Release.png b/frontend/static/img/URPC_VS_Release.png
diff --git a/frontend/static/img/URPC_csharp_binding.png b/frontend/static/img/URPC_csharp_binding.png
diff --git a/frontend/static/img/URPC_documentation.png b/frontend/static/img/URPC_documentation.png
diff --git a/frontend/static/img/URPC_libraries.png b/frontend/static/img/URPC_libraries.png
diff --git a/frontend/static/img/URPC_library_generation.png b/frontend/static/img/URPC_library_generation.png
diff --git a/frontend/static/img/URPC_profiles_assembler.png b/frontend/static/img/URPC_profiles_assembler.png
diff --git a/frontend/static/img/URPC_profiles_assembler_format.png b/frontend/static/img/URPC_profiles_assembler_format.png
diff --git a/frontend/static/img/URPC_python_binding.png b/frontend/static/img/URPC_python_binding.png
diff --git a/frontend/static/img/cmake_gui_instruction.png b/frontend/static/img/cmake_gui_instruction.png
diff --git a/frontend/templates/editor/base.html b/frontend/templates/editor/base.html
@@ -103,7 +103,7 @@
     </fieldset>
     </form>
 
-    <p class="form-legend">QT debugger</p>
+    <p class="form-legend">Qt debugger</p>
     <form class="pure-form" action="{{ reverse_url("project", "generate_debugger")[1:] }}" method="get">
     <fieldset>
         <button type="submit" class="pure-button pure-button-primary">Generate</button>

diff --git a/frontend/templates/help_csharp.html b/frontend/templates/help_csharp.html
@@ -2,24 +2,30 @@
 
 {% block help %}
 
-<h2>C# биндинги (генерируются uRPC)</h2>
-<i>Требует: сгенерированной <a href="/helplibrary">библиотеки</a></i>
+<h1>C#-биндинги</h1>
+<i>Требуется: сгенерированная <a href="/helplibrary">библиотека</a></i>
+
 <h3>Описание</h3>
-<p align="justify">
-C# биндинги - это файлы C# (.cs), которые позволяют общаться с устройством на языке C#. По сути это C#
-обёртка для библиотеки, написанной на C.
-Результатом работы этого генератора является .cs файл (имя_протокола).py.
-В файле (имя_проекта).cs описаны все константы библиотеки, структуры данных и методы для вызова команд и аксессоров
-<h3> Инструкция по сборке и запуску</h3>
-
-<p align="justify">
-C# файл не требует отдельной сборки. Просто добавьте собранную библиотеку и файл .cs из сгенерированного uRPC архива
-    в ваш проект Microsoft Visual C#
+<img src="{{static_url('img/URPC_csharp_binding.png')}}"/>
+<p>
+    C#-биндинги генерируется с помощью кнопки Generate в разделе Bildings.<br/>
+    <br/>
+    C#-биндинги - это файлы C# (.cs), которые позволяют общаться с устройством на языке C#. По сути это C#-обёртка для
+    библиотеки, написанной на C. Результатом работы этого генератора является файл <code>(имя_протокола).cs</code>. В
+    файле <code>(имя_проекта).cs</code> описаны все константы библиотеки, структуры данных и методы для вызова команд и
+    аксессоров.
+</p>
+
+<h3>Инструкция по сборке и запуску</h3>
+<p>
+    Файл C# не требует отдельной сборки. Просто добавьте собранную библиотеку и файл .cs из сгенерированного uRPC
+    архива в ваш проект Microsoft Visual C#.
 </p>
-<p align="justify"> Пример работы с биндингом</p>
-Пусть в протоколе устройства Foo есть команда supercommand, и устройство подключено к порту 42.
-    Тогда пример консольной программы C#, которая открывает устройство и вызывает эту команду, будет таким:
 
+<h3>Пример работы с биндингом</h3>
+    <p>
+        Пусть в протоколе устройства Foo есть команда supercommand, и устройство подключено к порту 42. Тогда пример
+        консольной программы C#, которая открывает устройство и вызывает эту команду, будет таким:</p>
     <pre><code class="с#">
         using System;
         using System.Collections.Generic;
@@ -42,7 +48,6 @@ <h3> Инструкция по сборке и запуску</h3>
                 }
             }
         }
-
     </code></pre>
 </p>
 

diff --git a/frontend/templates/help_doc.html b/frontend/templates/help_doc.html
@@ -2,35 +2,28 @@
 
 {% block help %}
 
-<h2>Документация (генерируется uRPC)</h2>
-<p align="justify">
-    uRPC умеет генерировать документацию в двух форматах: Textile и Sphinx
-</p>
+<h1>Документация</h1>
+<img src="{{static_url('img/URPC_documentation.png')}}"/>
+<p>uRPC умеет генерировать документацию в двух форматах: Textile и
+    <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a>. Каждый из форматов описан ниже.</p>
 <h3>Textile</h3>
-<h4>Описание</h4>
-<p align="justify">
-    Результатом работы этого генератора является документация протокола в формате Textile - простого языка разметки,
-    позволяющего пользователям описывать сложные схемы форматирования текстовых документов без использования внешних
-    средств (WYSIWYG-редакторов, TEX, HTML и т.д.). Более подробно о синтаксисе и семантике языка Textile можно
-    узнать в <a href="https://textile-lang.com">онлайн-песочнице</a> (там же можно и потестировать сгенерированные
-    файлы).
-</p>
-<h4> Инструкция по сборке </h4>
-<p align="justify">
-    Содержимое созданных этим генератором файлов можно напрямую вставлять во все предназанченные для
-    Textile текстовые поля Redmine(wiki, тексты сообщений, новости и т.д.).
+<p>
+    Формат Textile - простой язык разметки, позволяющий пользователям описывать сложные схемы форматирования текстовых
+    документов без использования внешних средств (WYSIWYG-редакторов, TEX, HTML и т.д.). Более подробно о синтаксисе и
+    семантике языка Textile можно узнать в <a href="https://textile-lang.com/">онлайн-песочнице</a> (там же можно и
+    протестировать сгенерированные файлы).
 </p>
+
 <h3>Sphinx</h3>
-<h4>Описание</h4>
-<p align="justify">
-    uRPC также умеет генерировать документацию для <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a>. В архиве
-    с сгенерированной документацией лежит файл .rst - файл формата документации Sphinx, и файл .po - файл в
-    формате <a href="http://www.gnu.org/software/gettext/">gettext</a> для перевода документации на русский язык
-</p>
-<h4>Инструкция по сборке</h4>
-<p align="justify">
-    О том, как сделать html страницу документации Sphinx из этих файлов, смотрите на сайте
-    <a href="https://www.sphinx-doc.org/en/master/usage/quickstart.html">Sphinx</a>
+<p>
+    Sphinx &#8211; это генератор документации, который преобразует файлы в формате reStructuredText в HTML и другие
+    форматы (PDF, EPub и man).<br/>
+    <br/>
+    Архив сгенерированной документацией содержит файл .rst формата документации Sphinx и файл .po формата
+    <a href="http://www.gnu.org/software/gettext/">gettext</a> для перевода документации на русский язык.<br/>
+    <br/>
+    О том, как сделать html-страницу документации Sphinx из этих файлов, можно прочитать на сайте
+    <a href="https://www.sphinx-doc.org/en/master/usage/quickstart.html">Sphinx</a>.
 </p>
 
 {% end %}
diff --git a/frontend/templates/help_firmware.html b/frontend/templates/help_firmware.html
@@ -2,17 +2,20 @@
 
 {% block help %}
 
-<h2>Прошивка (генерируется uRPC)</h2>
-<h3> Описание </h3>
-<p align="justify">
-По описанию протокола этот генератор способен создать проект (IAR) полноценной прошивки для целевого микроконтроллера.
-    Список поддерживаемых контроллеров есть в выпадающем списке в разделе Firmware генератора.
-    Для генерации нужной прошивки выберите свой контроллер в выпадающем списке и нажмите "Generate"
+<h1>Прошивка</h1>
+<h3>Описание</h3>
+<p>
+    Генератор uRPC способен создать проект (IAR) полноценной прошивки для целевого микроконтроллера по описанию
+    протокола.<br/>
+    <br/>
+    Перечень поддерживаемых контроллеров можно увидеть в выпадающем списке в разделе «Firmware» главной страницы. Для
+    генерации прошивки выберите в списке нужный контроллер и нажмите кнопку «Generate».
 </p>
+<img src="{{static_url('img/URPC_Device_choosing.png')}}" />
 <h3> Инструкция по сборке </h3>
-<p align="justify">
-Инструкция по сборке и прошивке индивидуальна для каждого типа контроллера. Она описана в README.md и лежит в архиве
-    сгенерированной прошивки
+<p>
+    Инструкция по сборке и прошивке индивидуальна для каждого типа контроллера. После генерации прошивки ее можно найти
+    в полученном архиве в файле README.md.
 </p>
 
 {% end %}