WikiPages/ru

В Центрt пользователей находится Оглавление. Оно используется в качестве основной ссылки для автоматического создания автономной справки, которую можно получить из FreeCAD, а также автономной PDF-документации.

Шаблон Template:Docnav используется для последовательной перелинковки страниц, следуя структуре Оглавления. Список всех шаблонов смотрите в разделе #Шаблоны.

Названия Страниц

Названия страниц должны быть короткими и использовать регистр заголовка: каждое слово должно начинаться с заглавной буквы, если только это не артикли, предлоги, союзы или другие грамматические частицы (например, « из», «на», «в», «а», «ан», «и»).

Плохое название для страницы

Конструкция аэропланов AeroCompany

Хорошее название

Конструкция Аэропланов AeroCompany

Названия страниц верстаков верхнего уровня должны иметь следующий формат: XYZ Workbench, где XYZ - это имя верстака, например PartDesign Workbench. А названия страниц, описывающих команды (или инструменты), принадлежащие верстаку, должны иметь следующий формат: XYZ Command, например PartDesign Pad. Обратите внимание, что вы должны использовать название команды так, как оно встречается в исходном коде.

Заголовки

Заголовки абзацев должны быть короткими и использовать регистр предложений: все слова, кроме первого и имён собственных, должны быть написаны строчными буквами. Вам не следует использовать заголовки H1 (= Heading =) в вашей вики-разметке, поскольку заголовок страницы автоматически добавляется в качестве основного заголовка H1.

Ссылки

По возможности используйте оригинальное название ссылки. Это позволяет уточнить страницу, на которую ссылается ссылка, в печатной или автономной документации. Пожалуйста, избегайте использования слов, не несущих смысловой нагрузки для ссылки

Плохая ссылка

Для получения более подробной информации по рисованию 2D объектов кликните здесь.

Хорошая ссылка

Для получения более подробной информации о рисовании 2D обратитесь к верстаку Draft.

Предпочтительным форматом для ссылки является:

[[Name_of_Page|Name of Page]]

После перевода:

[[Name_of_page/ru|Название Страницы]]

Обратите внимание, что для части перед символом | важна фактическая ссылка, регистр. Если ваша страница называется Name_of_page, ссылка не будет подключена, если вы введете Name_of_Page (верхний регистр P). Перед символом | все пробелы следует заменить символами подчёркивания (_). Это сделано для того, чтобы помочь переводчикам, использующим программное обеспечение для перевода, без подчёркивания ссылка была бы переведена программным обеспечением, что нежелательно.

Для ссылки на определенный параграф добавьте к названию страницы знак # и его заголовки. Пример:

[[WikiPages#Links|WikiPages]]

После перевода:

[[WikiPages/ru#Ссылки|WikiPages]]

На этой же странице вы можете опустить название страницы. Пример:

[[#Links|Ссылки]]

Для ссылки на верхнюю часть страницы вы можете использовать:

</translate>{{Top}}<translate>

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

Ссылка на изображение

Чтобы использовать изображение в качестве ссылки:

[[Image:Draft_Wire.svg|24px|Необязательный текст, который отображается при наведении курсора мыши на изображение|link=Draft_Wire]]

Ссылка на изображение + текстовая ссылка

Draft Кривая

Если опустить необязательный текст, ссылка будет отображаться при наведении на изображение, что предпочтительнее, а также следует добавить текстовую ссылку после ссылки на изображение:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire/ru|Draft Кривая]]

Страницы верстаков

Страница верстака верхнего уровня должна начинаться с:

• Описания того, для чего используется верстак.
• Изображение, иллюстрирующее описание.

Смотри раздел #Снимок экрана, чтобы узнать о правилах включения изображений.

Страницы команд

Страницы команд, описывающие инструменты верстаков, не должны быть слишком длинными, они должны только объяснять, что команда может делать, а чего нет, и как её использовать. Вам следует свести к минимуму изображения и примеры. Учебные пособия могут подробно рассказать о том, как использовать этот инструмент, и предоставить пошаговые инструкции.

Пожалуйста, обратитесь к странице Пример документирования комманды Gui для получения более подробной информации.

Руководства

Хорошо написанный учебник должен учить, как быстро достичь определенных практических результатов. Он не должен быть слишком длинным, но должен включать достаточное количество пошаговых инструкций и изображений для руководства пользователем. По мере развития FreeCAD учебные пособия могут устаревать, поэтому важно указать версию FreeCAD, используемую в учебном пособии или необходимую для него.

Примеры приведены на странице Руководства.

Стилизация страниц FreeCAD wiki достигается за счёт использования шаблонов (Help:Editing#Templates_and_transcluding_pages). Они обеспечивают стандартный внешний вид и восприятие всех страниц, а также позволяют изменять стиль вики. Полный список определенных шаблонов вы можете посмотреть, обратившись к Special:PrefixIndex/Template:. Но, пожалуйста, используйте только те шаблоны, которые перечислены в таблицах ниже. Только в очень особых случаях вы должны использовать HTML-теги напрямую.

Щёлкните по ссылке шаблона, чтобы увидеть инструкции по использованию шаблона и его реализацию. Шаблоны - это мощная функция программы MediaWiki. Вы должны быть опытным пользователем вики, если хотите предлагать дополнения и изменения к существующим шаблонам. При неправильном применении шаблоны затрудняют перевод страниц на другие языки, поэтому их использование должно быть ограничено форматированием текста, перелинковку страниц следует избегать. Подробнее смотри MediaWiki Help:Templates.

Простейшие шаблоны

Эти шаблоны форматируют простой текстовый параметр в определенном стиле.

Шаблон	Внешний вид	Описание
Top	наверх	Используйте его, чтобы добавить ссылку в начало страницы.
Emphasis	акцент	Используйте его, чтобы подчеркнуть фрагмент текста.
KEY	Alt	Используйте его в случае, когда нужно указать клавишу клавиатуры, которую необходимо нажать.
ASCII		Используйте его, для отображения клавиши в виде (.svg) изображения, которую нужно нажать. В качестве параметра, вы должны указать желаемый символ или номер ascii-кода символа.
Button	Отмена	Используйте его для указания кнопки в графическом пользовательском интерфейсе, которую необходимо нажать.
RadioButton	Опция	Используйте его для указания переключателя в графическом интерфейсе пользователя, который должен быть Выбран или Нет.
CheckBox	Опция	Используйте его для указания флажка в графическом интерфейсе пользователя, который должен быть установлен в значение Включен или Нет.
SpinBox	1.50	Используйте его, чтобы указать на спинбокс в графическом интерфейсе пользователя, который необходимо изменить.
ComboBox	Меню 1	Используйте его, чтобы указать поле со списком в графическом интерфейсе пользователя, которое необходимо изменить.
LineEdit	Металл Никель (Ni)	Используйте его для указания строки в графическом интерфейсе пользователя, которую необходимо изменить.
FALSE, false	false, false	Используйте его для указания ложного логического значения, например, в качестве свойства в редакторе свойств. Это ярлык. Поскольку это значение, предпочтительнее использовать Шаблон Value false
TRUE, true	true, true	Используйте его для указания истинного логического значения, например, в качестве свойства в редакторе свойств. Это ярлык. Поскольку это значение, предпочтительнее использовать Шаблон Value true
MenuCommand	Файл → Сохранить	Используется для указания местоположения команды в определенном меню.
FileName	Имя файла	Используйте его для указания имени файла или каталога.
SystemInput	Введите этот текст	Используйте его для обозначения вводимого пользователем текста.
SystemOutput	Выводимый текст	Используется для обозначения вывода текста из системы.
Incode	import FreeCAD	Используйте его для выделения блоков исходного кода написанного моноширинным шрифтом. Содержимое должно умещаться в одну строку.
PropertyView	ВидЦвет	Используйте его для указания свойства Вид в редакторе свойств. Примеры свойств представления включают Цвет Линии, Ширина Линии, Цвет Точки, Размер Точки, и т.п.
PropertyData	ДанныеПоложение	Используйте для указания свойства данных в редакторе свойств. Свойства данных различны для разных типов объектов.
Properties Title / TitleProperty	Базовые	Используйте его для указания названия группы свойств в редакторе свойств. Название не будет включено в автоматическое оглавление.
Obsolete/ru	упразднено в версии 0.19	Используйте его, чтобы указать, что функция устарела в указанной версии FreeCAD.
VersionNoteObsolete/ru	упразднено в версии 0.19	Тоже (вариант надстрочного знака).
Version/ru	представлено в версии 0.18	Используйте его, чтобы указать, что функция была введена в указанной версии FreeCAD.
VersionNote/ru	представлено в версии 0.18	Тоже (вариант надстрочного знака).
VersionMinus/ru	0.16 и ниже	Используйте его, чтобы указать, что функция доступна в указанной версии FreeCAD и более ранних версиях.
VersionNoteMinus/ru	0.16 и ниже	Тоже (вариант надстрочного знака).
VersionPlus/ru	0.17 и выше	Используйте его, чтобы указать, что функция доступна в указанной версии FreeCAD и более поздних версиях.
VersionNotePlus/ru	0.17 и выше	Тоже (вариант надстрочного знака).
ColoredText	Цветной текст	Используйте этот шаблон для раскрашивания фона, текста или фона и текста. (ColoredText страница для получения дополнительных примеров)
ColoredParagraph	Цветной Абзац	Используйте этот шаблон для раскрашивания фона, текста или фона и текста всего абзаца. (ColoredParagraph страница для получения дополнительных примеров)

Сложные шаблоны

Эти шаблоны требуют больше входных параметров или создают блок текста определенного формата.

Шаблон	Внешний вид	Описание
Prettytable	Данная таблица	Используйте его для форматирования таблиц, подобных этой. Можно добавить дополнительные свойства таблицы..
Caption	Какая-нибудь подпись к изображению	Используйте его, чтобы добавить пояснение под изображением. Оно может быть выровнено по левому краю или по центру.
Clear		Используйте его для очистки столбцов. Для получения подробного объяснения следуйте определению шаблона. Он часто используется для того, чтобы текст не пересекался с изображениями, не имеющими отношения к тексту.
Code	import FreeCAD	Используйте его для включения многострочных примеров кода с моноширинным шрифтом. Язык по умолчанию - Python, но могут быть указаны и другие языки. Python код должен соответствовать общим рекомендациям, установленным / PEP8: Руководство по стилю для кода на python. В частности, круглые скобки должны следовать сразу за именем функции, а после запятой - пробел. Это делает код более читабельным.
CodeDownload	Какой-то ярлык	Используйте его для создания ссылки на странице Макросы.
Codeextralink	Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro # This code is copied instead of the original macro code # to guide the user to the online download page. # Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki # or if the RAW code URL is somewhere else in the wiki. from PySide import QtGui, QtCore diag = QtGui.QMessageBox(QtGui.QMessageBox.Information, "Information", "This macro must be downloaded from this link\n" "\n" "https://wiki.freecad.org/Main_Page" + "\n" "\n" "Quit this window to access the download page") diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint) diag.setWindowModality(QtCore.Qt.ApplicationModal) diag.exec_() import webbrowser webbrowser.open("https://wiki.freecad.org/Main_Page") <class="rawcodeurl"><a href="https://wiki.freecad.org/Main_Page">raw code</a>	Используется, если код макроса слишком велик для размещения на Вики. Тогда код можно разместить в другом месте, а ссылку на него указать с помощью этого шаблона. Менеджер дополнений будет использовать эту ссылку.
Fake heading	Заголовок	Используйте его для создания заголовка, который не будет автоматически включён в оглавление.
GuiCommand/ru	Смотри Пример документирования комманды Gui	Используйте его для создания поля с полезной информацией для документирования команд верстаков (инструментов).
TutorialInfo/ru	Смотрите, например, Руководство по базовому моделированию	Используйте его, чтобы создать поле с полезной информацией для документирования учебных материалов.
Macro/ru	Смотри, например Macro FlattenWire	Используйте его, чтобы создать поле с полезной информацией для документирования макросов.
Docnav/ru	Онлайн-справка Список функций Оглавление	Используйте его для создания панели со стрелками и соответствующими ссылками, которая полезна для размещения страниц в определенной последовательности.
VeryImportantMessage	Важное сообщение	Используйте его для создания выделенного окна с очень важным сообщением. Используйте экономно, только для обозначения основных проблем в функциональности программного обеспечения, прекращения использования инструментов и тому подобного.
Page in progress/ru	Эта документация находится в стадии разработки. Пожалуйста, не помечайте её как подлежащую переводу, поскольку она изменится в ближайшие часы и дни.	Используйте это для страниц, которые всё ещё находятся в процессе разработки или которые в данный момент перерабатываются. Не забудьте удалить это, когда страница будет готова.
UnfinishedDocu/ru	Эта документация не закончена. Пожалуйста, помогите и внесите свой вклад в разработку документации. Пример документирования команды Gui объясняет, как должны быть задокументированы команды. Просмотрите Category:UnfinishedDocu/ru, чтобы увидеть больше незавершённых страниц, подобных этой. Смотрите Category:Command Reference/ru для всех команд. Смотрите Wiki Страницы, чтобы узнать о редактировании вики-страниц, и зайдите на страницу Помоги FreeCAD, чтобы узнать о других способах, которыми вы можете внести свой вклад.	Используйте его для создания выделенного поля, указывающего на незаконченную страницу документации.
Softredirect		Используйте его вместо обычного перенаправления, когда вы перенаправляетесь на специальную страницу (например, Media: или Category:), в этих случаях обычное перенаправление отключено.
Quote	Крикни "Хаос" и спусти псов войны. —Уильям Шекспир, Юлий Цезарь", акт III, сцена I	Используйте его для создания текстового поля с буквенной цитатой и ссылкой.
Userdocnavi/ru, Powerdocnavi/ru		Используйте их для создания полей навигации для документации пользователя, документации опытного пользователя и документации разработчика. Это позволяет быстро переходить между различными разделами документации. Они также помещают соответствующую страницу в соответствующую категорию.

Изображения и скриншоты необходимы для создания полной документации FreeCAD. Они особенно полезны для иллюстрации примеров и учебных пособий. Изображения должны быть показаны в их оригинальном размере, чтобы они представляли достаточную детализацию и были читабельны, если они содержат в себе текст. Размеры растровых изображений не могут быть изменены.

Избегайте анимированных картинок (GIF) на страницах общей справки. Анимации и видео следует зарезервировать для учебных пособий, не предназначенных для использования в качестве offline документации в формате PDF.

Изображения можно загрузить через страницу Загрузить файл.

Названия

Давайте осмысленные названия изображениям. Если у вас есть изображение, демонстрирующее характеристики определенной команды, используйте название этой команды с _example в конце. Например, для команды Draft Offset изображение должно называться Draft_Offset_example.png.

Снимки экрана

Рекомендуемые размеры для снимков экрана::

• 400x200 (или ширина=400 и высота<=200) для страниц описывающих команнды Gui, чтобы изображение помещалось в левой части страницы, а также для других стандартных снимков.
• 600x400 (или ширина=600 и высота<=400), для страниц описывающих команнды Gui, только когда вам действительно нужно изображение большего размера, и при этом старйтесь уместить изображение в левой части страницы, а также для других стандартных снимков.
• 1024x768 (или ширина=1024 и высота<=768), только для полноэкранных изображений.
• При отображении деталей возможны меньшие размеры.
• Избегайте изображений с большим разрешением, так как они не будут очень переносимыми для других видов дисплеев или печатной документации в формате PDF.

Вы не должны зависеть от пользовательской конфигурации вашего рабочего стола или операционной системы при создании скриншотов, по возможности рекомендуется использовать визуальные настройки интерфейса FreeCAD по умолчанию.

Для создания скриншотов вы можете использовать опции, предоставляемые вашей операционной системой, или один из этих макросов: Макрос Snip (Обрезать) и Макрос Screen Wiki (Снимок для Вики).

Текст

Чтобы облегчить перевод документации, старайтесь избегать изображений экрана, содержащих текст. Если вы не можете этого избежать, сделайте отдельные снимки экрана интерфейса и 3D вида. Изображение 3D-вида можно повторно использовать в каждом переводе, а переводчик при необходимости может сделать снимок экрана локализованного интерфейса.

Иконки и графика

Обратитесь к странице Artwork для всех иллюстраций и иконок, которые были созданы для FreeCAD и которые также могут быть использованы на страницах документации. Если вы хотите внести свой вклад в создание иконок, пожалуйста, прочитайте Artwork Руководство по художественному оформлению.

По общему мнению, эталонной страницей в вики является английская страница, которая должна быть создана первой. Если вы хотите изменить или добавить содержимое на страницу, сначала это нужно сделать на английской странице, и только после завершения обновления перенести изменения на переведённую страницу.

FreeCAD wiki поддерживает расширение для перевода, которое позволяет проще управлять переводами между страницами; подробнее смотри раздел Локализация Перевод FreeCAD wiki.

Другими полезными ресурсами являются:

• Языковые коды ISO чтобы определить двухбуквенный код для определённого языка, на который вы хотите перевести.
• Google Переводчик для помощи с переводами.
• Deepl переводчик для помощи с переводами.

Несколько советов для переводчиков

Перевод GuiCommand (КомандаИнтерфейса)

{{GuiCommand
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

После перевода:

{{GuiCommand/fr
|Name=FEM EquationFlux
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}

Перевод navi (навигации)

{{FEM_Tools_navi}}

После перевода:

{{FEM_Tools_navi/fr}}

Перевод ссылок

[[Part_Workbench|Part Workbench]]

После перевода:

[[Part_Workbench/fr|Atelier Part]]

Перевод Docnav

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

После перевода:

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Пример с иконками:

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

После перевода:

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}