Gui Command/ru: Difference between revisions
Renatorivo (talk | contribs) (Created page with "Если документ не закончен(в смысле wiki статья) используйте шаблон Template:UnfinishedDocu") |
(Updating to match new version of source page) |
||
(22 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
⚫ | |||
⚫ | |||
<div class="mw-translate-fuzzy"> |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
GuiCommand. Некоторые из атрибутов GuiCommand: |
|||
⚫ | |||
* Задано имя |
* Задано имя |
||
* Содержит иконку |
* Содержит иконку |
||
Line 10: | Line 11: | ||
* Записывается в макрос |
* Записывается в макрос |
||
* и.т.д... |
* и.т.д... |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
=== Назначение имен === |
=== Назначение имен === |
||
GuiCommand именуются определенным образом: ''ИмяМодуля_ИмяКоманды'' |
GuiCommand именуются определенным образом: ''ИмяМодуля_ИмяКоманды'' |
||
т.е. "Base_Open" это команда Открыть(Open) графического интерфейса в Base( |
т.е. "Base_Open" это команда Открыть(Open) графического интерфейса в Base (базовой системе). |
||
GuiCommand |
GuiCommand в определенном модуле получает имя имя модуля впереди, например "Part_Cylinder". |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
Если документ не закончен(в смысле wiki статья) используйте шаблон [[Template:UnfinishedDocu]] |
Если документ не закончен (в смысле wiki статья) используйте шаблон [[Template:UnfinishedDocu]] |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
=== Help page === |
|||
=== Страница справки === |
|||
Every GuiCommand has to have a help page. The help page is hosted on the |
|||
Каждая GuiCommand должна обладать страницей справки. Страница справки должна располагаться в FreeCAD wiki. Статья имеет то же имя, что и GuiCommand, например, [[Draft ShapeString]]. |
|||
FreeCAD docu wiki. The article has the same name as the GuiCommand, e.g. [[Draft ShapeString]]. |
|||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
To create your own help pages you can use the template: |
|||
Чтобы создать ваши собственные справочные страницы используйте шаблон: |
|||
[[GuiCommand model]] |
[[GuiCommand model]] |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
Example: |
|||
Примеры: |
|||
* [[Draft ShapeString]] |
* [[Draft ShapeString]] |
||
* [[Draft Line]] |
* [[Draft Line]] |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
=== Icons === |
|||
=== Иконки === |
|||
[[Image:Tango-Palette.png|400px|right]] |
[[Image:Tango-Palette.png|400px|right]] |
||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
Every GuiCommand has to have an icon. We use the [http://tango.freedesktop.org/Tango_Desktop_Project| Tango icon set] and its guidelines. On the right side you see |
|||
Каждая GuiCommand-а должна иметь иконку. Мы используем [http://tango.freedesktop.org/Tango_Desktop_Project| Tango набор иконок] и его принципы. Справа вы можете видеть палитру цветов tango. |
|||
the tango color palette. |
|||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
Preferable all Icons are drafted with SVG with e.g. [http://inkscape.org Inkscape]. |
|||
Предпочтительней всех, иконки нарисованные в SVG , например с помощью [http://inkscape.org Inkscape]. |
|||
This makes it easier to apply changes and derive |
|||
Это упрощает добавление изменений и получение дополнительных Иконок в том же пространстве приложения. |
|||
additional Icons in the same application space. |
|||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
'''icons color coding chart''' |
|||
'''диаграмма цветового кодирования иконок''' |
|||
</div> |
|||
[[Image:Colorchart.png|200px]] |
[[Image:Colorchart.png|200px]] |
||
Мы стараемся насколько возможно следовать этой диаграмме, так что цвета иконок имеют прямое значение. |
|||
We try as much as possible to respect this chart, so the color of the icons has a direct meaning. |
|||
<div class="mw-translate-fuzzy"> |
|||
=== Quality requirements === |
|||
=== Требования к качеству === |
|||
⚫ | |||
Существует множество GuiCommands (Особенностей/Фишек) в FreeCAD которые являются экспериментальными или используются недолгое время для реализации целей. Эти GuiCommands в основном помещаются в инструментарии, такие как Part, Mesh или Cam. |
|||
⚫ | |||
Для обеспечения хорошей работы пользователя, был создан''Полный(Complete)'' инструментарий. Это инструментарий, который запускается по умолчанию при старте FreeCAD и он включает в себя все GuiCommand-ы, отвечающие '''Требованиям к качеству''' ,описанным здесь: |
|||
</div> |
|||
⚫ | |||
⚫ | |||
the dedicated workbenches like Part, Mesh or Cam. |
the dedicated workbenches like Part, Mesh or Cam. |
||
To ensure a good user experience the workbench ''Complete'' was created. This |
To ensure a good user experience the workbench ''Complete'' was created. This |
||
workbench incorporates all GuiCommands |
|||
which meet certain |
which meet certain quality requirements which are described here: |
||
<div class="mw-translate-fuzzy"> |
|||
* The Command/Feature has to be '''finished'''. No work in progress! |
|||
* Команда/Функция должна быть '''законченой'''. Никаких незавершенных работ! |
|||
* Has to have a '''help page''' like [[Draft ShapeString]] |
|||
* Должен иметь '''справочную страницу''' как [[Std ViewScreenShot|эта]] |
|||
** All the fields in [[Template:GuiCommand]] have to filled in |
|||
** Все поля [[Template:GuiCommand]] должны быть заполнены |
|||
** A picture of the dialogs the command eventually yield |
|||
** Картинки с изображением диологов команды и конечный вывод |
|||
** detailed description of the command and all its parameters and settings |
|||
** детальное описание команды и всех её параметров и настроек |
|||
** Description of the related python interfaces and classes with example code |
|||
** Описание связанных python интерфесов и классов с примерами кода |
|||
* Set up a proper Icon and menu position |
|||
* Настройка надлежащей иконки и позиции в меню |
|||
</div> |
|||
<div class="mw-translate-fuzzy"> |
|||
Hopefully this becomes true for all GuiCommands in the [[List of Commands]]. |
|||
Надеюсь, что так будет со всеми GuiCommands из [[List of Commands/ru|Списка команд]]. |
|||
</div> |
|||
[[Category:User Documentation]] |
|||
[[Category:Command_Reference]] |
|||
{{Powerdocnavi{{#translation:}}}} |
|||
{{clear}} |
{{clear}} |
||
⚫ |
Revision as of 19:57, 15 May 2020
GuiCommand - одна из наиболее важных функций FreeCAD при взаимодействии с пользователем. Каждый раз, когда пользователь выбирает опцию в меню или нажимает на кнопку панели инструментов, активируется GuiCommand. Некоторые из атрибутов GuiCommand:
- Задано имя
- Содержит иконку
- Определена возможности для отмены/повтора
- Есть страница справки
- Открывает и управляет диалогами
- Записывается в макрос
- и.т.д...
Назначение имен
GuiCommand именуются определенным образом: ИмяМодуля_ИмяКоманды т.е. "Base_Open" это команда Открыть(Open) графического интерфейса в Base (базовой системе). GuiCommand в определенном модуле получает имя имя модуля впереди, например "Part_Cylinder".
Если документ не закончен (в смысле wiki статья) используйте шаблон Template:UnfinishedDocu
Страница справки
Каждая GuiCommand должна обладать страницей справки. Страница справки должна располагаться в FreeCAD wiki. Статья имеет то же имя, что и GuiCommand, например, Draft ShapeString.
Чтобы создать ваши собственные справочные страницы используйте шаблон: GuiCommand model
Примеры:
Иконки
Каждая GuiCommand-а должна иметь иконку. Мы используем Tango набор иконок и его принципы. Справа вы можете видеть палитру цветов tango.
Предпочтительней всех, иконки нарисованные в SVG , например с помощью Inkscape. Это упрощает добавление изменений и получение дополнительных Иконок в том же пространстве приложения.
диаграмма цветового кодирования иконок
Мы стараемся насколько возможно следовать этой диаграмме, так что цвета иконок имеют прямое значение.
Требования к качеству
Существует множество GuiCommands (Особенностей/Фишек) в FreeCAD которые являются экспериментальными или используются недолгое время для реализации целей. Эти GuiCommands в основном помещаются в инструментарии, такие как Part, Mesh или Cam. Для обеспечения хорошей работы пользователя, был созданПолный(Complete) инструментарий. Это инструментарий, который запускается по умолчанию при старте FreeCAD и он включает в себя все GuiCommand-ы, отвечающие Требованиям к качеству ,описанным здесь:
There are a lot of GuiCommands (tools) in FreeCAD which are experimental
or used for a short time to test implementation of new features. These GuiCommands are mostly in
the dedicated workbenches like Part, Mesh or Cam.
To ensure a good user experience the workbench Complete was created. This
workbench incorporates all GuiCommands
which meet certain quality requirements which are described here:
- Команда/Функция должна быть законченой. Никаких незавершенных работ!
- Должен иметь справочную страницу как эта
- Все поля Template:GuiCommand должны быть заполнены
- Картинки с изображением диологов команды и конечный вывод
- детальное описание команды и всех её параметров и настроек
- Описание связанных python интерфесов и классов с примерами кода
- Настройка надлежащей иконки и позиции в меню
Надеюсь, что так будет со всеми GuiCommands из Списка команд.
- FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics
- Modules: Builtin modules, Units, Quantity
- Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
- Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC
- Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
- Scenegraph: Coin (Inventor) scenegraph, Pivy
- Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
- Macros: Macros, How to install macros
- Embedding: Embedding FreeCAD, Embedding FreeCADGui
- Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)
- Hubs: User hub, Power users hub, Developer hub