Template:Macro/ru

использование
Этот шаблон является основным инструментом для документирования макросов. Он должен быть вставлен в качестве первой строки на страницах документации, после а также tags. Смотрите образец справа.

Обязательные параметры:

Другие параметры могут быть опущены или их значение может быть пустым.

Обязательные параметры
Параметры указываются с его значением после знака равенства,.

Каждый параметр в списке разделен символом канала. |... |Name=SomeMacro|Author=WikiUserName| ... Параметры могут быть размещены в одной строке или каждый в отдельной строке. |...
 * Name=SomeMacro
 * Author=WikiUserName

Следующие параметры обязательны.


 * Name
 * Правильно прописное имя макроса для документирования.
 * Имя используется для извлечения графического значка  или   из хранилища вики. Шаблон работает правильно, если значок не существует; в этом случае отображается общий значок [[Image: Text-x-python.png|24px]].


 * Description
 * Описание макроса, это описание будет отображаться в менеджере дополнений.

Автор макроса. Это имя связано со страницей пользователя в вики, то есть User:Author. Поскольку макросы не являются частью официального кода FreeCAD, пользователи должны направлять свои вопросы о них своим конкретным создателям. Автор макроса должен быть доступен на forum с тем же именем пользователя, что и в вики.
 * Author
 * Date
 * Все макросы должны иметь дату. Это полезно для указания времени последнего изменения макроса и предупреждения пользователя о возрасте кода. Очень старые макросы могут быть устаревшими и могут не работать с последней версией FreeCAD.

Необязательные параметры
Следующие параметры являются необязательными. Если они не включены в шаблон, они будут отображать значение по умолчанию.
 * Translate
 * Имя переведено на ваш язык и будет отображаться в заголовке окна. Например,


 * Version
 * Версия макроса. Если значение не указано, по умолчанию используется значение . Это полезно для авторов, так как они могут задокументировать конкретные версии своих макросов.


 * Shortcut
 * Некоторые макросы могут содержать ярлыки для запуска определенных инструментов. Укажите кнопки быстрого доступа для нажатия с этим значением. Если значение не указано, по умолчанию None.


 * SeeAlso
 * Необязательные ссылки на другие связанные команды, например,.


 * Icon
 * Файл изображения, отличный от  или   для использования в качестве значка. Это может быть использовано для включения определенного значка, который не назван в честь команды, например,