You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 51 Next »

light bulb  Здесь мы собрали минимально необходимую информацию для оформления статьи в Confluence.


Создание новой страницы

Чтобы создать новую страницу, выберите категорию, пространство и раздел. Так, создаваемая страница будет связана с выбранным разделом. 

Например:

  • Дисциплина → Архитектурный BIM → Коммерция → Подразделы → Создать новую страницу
  • Сервисы → Учебный центр BIM → Развитие → Создать новую страницу

PIK-smallНажмите значок «Создать» в правом верхнем углу.

PIK-smallВыберите шаблон или используйте пустую страницу.

 

Создание нового раздела с вложенными страницами

PIK-smallСоздайте новую страницу — это будет страница раздела. Внутри неё создавайте страницы статей.

PIK-smallПерейдите в режим редактирования на странице нового раздела, в верхнем меню выберите «Вставить прочий контент»

 

PIK-smallВыберите в списке «Другие макросы», через поиск найдите «Отображение дочерних»

PIK-smallВставьте макрос, чтобы все эти вложенные страницы были видны на странице раздела. 




Оформление заголовка

PIK-smallВведите заголовок страницы.  


Общие правила составления заголовков 

PIK-grey-smallЗаголовки страниц должны быть уникальными. Это важно для поисковой системы.

PIK-grey-smallНе ставьте точку в конце залоговка, это не принято. В составном заголовке между смысловыми частями можно ставить знаки препинания. 

ПлохоХорошо

Проемы и отверстия в стенах.

Проемы и отверстия в стенах

Стены. Проемы и отверстия

Стены: проемы и отверстия


PIK-grey-smallИспользуйте общепринятые термины и аббревиатуры. 

ПлохоХорошо

Оформление ДМ

Подбетонка

Оформление демонстрационных материалов

Бетонная подготовка


PIK-grey-smallСтруктурируйте текст, придерживайтесь подхода «От общего к частному». Не дублируйте название предыдущего уровня, если логическая цепочка не обрывается.

ПлохоХорошо

Инструменты PIKTools

Общие инструменты

Общая Печать листов

PIKTools

Общие инструменты

Печать листов


PIK-grey-smallДобавьте к заголовку дополнительные слова или аббревиатуру, если в разных подразделах у вас должны находиться инструкции с одинаковыми названиями.

PIK-grey-smallРазместите уточнение в конце заголовка, чтобы в начале находилось уникальное название. Соблюдение этого правила сделает работу с каталогом удобнее.

ПлохоХорошо

Вставка оглавления

Вставьте оглавление, если в тексте больше двух-трёх абзацев.

Разместите оглавление непосредственно перед основным текстом. Вводный текст, который объясняет цели документа, должен быть перед оглавлением.


PIK-small
Прежде всего оформите заголовки блоков/рубрик текста через встроенную систему заголовков (это необходимо для использования макроса). 

PIK-smallВыберите макрос «Оглавление» через функцию «Вставить прочий контент» в верхнем меню

PIK-smallЗадайте уровни заголовков, которые должны отображаться, в настройках. Чтобы увидеть результат, используйте кнопку «Предварительный просмотр».


Если вы хотите закрепить оглавление при прокрутке страницы, используйте макрос Easy Heading Macro. 

PIK-smallВыберите «Вставить прочий контент» → «Другие макросы» и введите название в поисковую строку.

face with monocle Реализацию можно посмотреть прямо в этой статье или в учебных инструкциях к курсам «Технология проектирования в Revit»: Написать заявку в поддержку


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

PIK-smallВыберите «Вставить прочий контент» → «Другие макросы» и введите название в поисковую строку.

Реализация в режиме просмотра:

face with monocle Реализацию также можно посмотреть в учебных инструкциях к курсам «Технология проектирования в Revit»: Проверить и исправить дубликаты семейств


Форматирование текста

Используйте в инструкции простые предложения. Разделяйте текст для лучшего восприятия. Соблюдайте правило: в одном абзаце - 4-5 предложений. В предложении должно быть 8-10 слов. Если слов больше, разделите на два предложения.

PIK-smallВыполняйте основной текст стилем «Абзац», для деления текста применяйте систему заголовков. 

 PIK-smallИли воспользуйтесь инструментом «Разметка страницы». 

 
PIK-smallИспользуйте также разделительную линию, чтобы зонировать текст. 



PIK-smallФорматируйте тест при помощи встроенных инструментов.

PIK-smallИспользуйте списки при перечислениях, вам доступны два вида.

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

  • Пример
  • Пример
  • Пример

Нумерованный список, когда позиции списка имеют заданную последовательность.

  1. Действие 
  2. Действие
  3. Действие

PIK-smallВыделяйте важное в тексте. 

Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив: ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ! 

Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью. Для выделения блока лучше использовать эмодзи или символы: или специальные блоки. Можно также использовать слова: Внимание! Совет и др.

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

Например:

  • полужирный шрифт — для описания названий элементов интерфейса и кнопок

  • прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем

  • курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)

  • рамка — для оформления фрагментов кода

  • маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация

Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить»

Верхние кавычки, или лапки  — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай).

Сочетание клавиш в Windows для ёлочек: 

« —  alt + 0171
» —  alt + 0187


PIK-smallИ
спользуйте макрос Info, чтобы выделить текст в виде блока.






PIK-small
Оформляйте содержательные ссылки на другие ресурсы. 


PIK-smallСоблюдайте авторское право. Указывайте название источника заимствования, если этого материала больше 20% в отношении объема вашей статьи, или вы использовали изображения из внешней среды.


face with monocle Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.


PIK-smallСохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».

backhand index pointing up Если вы не обновили статью, то все внесенные изменения сохранятся в виде неопубликованных. 




Визуализация

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

PIK-smallПеретащите объект в поле страницы в режиме редактирования. 

backhand index pointing up Следите за названием изображений, если вы добавите на страницу новое изображение с таким же названием, то старое изображение автоматически заменится на новое.


PIK-smallВоспользуйтесь инструментом меню «Вставить изображение», если вы работаете с набором изображений.

PIK-smallОтроется окно с функций «Загрузить файлы».  После загрузки файлов, вы можете выбрать нужные для вставки. Нажмите кнопку «Вставить».

PIK-smallИспользуйте стандартные функции настройки изображения. Выберите то, что вам нужно: изменить размер, добавить границу, вставить ссылку, открыть окно свойств.

Окно «Свойства изображения» имеет два режима: эффекты и описание. 

effects      

PIK-smallВ режиме «Описание» вы можете добавить подпись для изображения, которая будет появляться при наведении на него:

light bulb Задайте изображениям содержательные названия, тогда они будут попадать в выдачу по поиску. Это также поможет вам, если одно и то же изображение нужно разместить на разных страницах. Не придётся дублировать изображение несколько раз.

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



Вставляйте в статью контент со встроенным плеером и возможностью управления. Вы можете добавить документы в формате PDF, а также аудио- и видеофайлы.

backhand index pointing up Сначала загрузите файл с компьютера на страницу Confluence, с которой вы планируете подгружать файл в макрос. После этого вы можете удалить отображение файла на странице, но он останется во вложении. Чтобы увидеть вложения страницы, в режиме чтения нажмите на значок «Скрепка».

Вам откроется 


Файл PDF

PIK-smallПеретащите PDF-документ с компьютера в пространство Confluence. Удалите его на странице, при этом он сохранился во вложении страницы.

PIK-smallВставьте макрос PDF.

PIK-smallВыберите страницу, с которой должен подгружаться файл PDF. Поскольку это единственный подходящий файл для макроса, он сразу отображается в блоке «Имя файла». Если на странице несколько таких файлов, то нужно выбрать нужный из выпадающего списка.

Результат в режиме редактирования:

Результат в режиме просмотра:

raising hands Файл PDF отображается через внутренний интерфейс, пользователь может перелистывать страницы.


Аудио- и видеофайлы

PIK-smallПеретащите аудио- и видеофайлы с компьютера в пространство Confluence. Удалите их на странице, при этом они сохранились во вложении страницы.

PIK-smallВставьте макрос Multimedia.

PIK-smallВыберите страницу и файл для отображения на странице публикации.


Результат в режиме просмотра:


Добавление меток

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

При создании новых разделов и страниц обязательно следует проставлять метки их принадлежности: 

  • к дисциплине (разделу проектирования): АР, КР, ЭОМ и т.д.
  • к инструментам и ПО: Revit, Civil 3D, Family Manager, BIM Inspector, PIKTools и т.д. 
  • к сервису: BIM-поддержка , BIM-координация, Фабрика семейств, Учебный центр. 


PIK-smallДля созданной страницы используйте значок добавления метки, расположенный в правом нижнем углу.

PIK-smallВ режиме редактирования используйте значок метки над заголовком страницы.


PIK-smallВ диалоговом окне введите названия необходимых меток и нажмите кнопку «Добавить». 
Если метка с таким именем уже существует, она появится в меню автоподстановки. Если название новое, оно добавится в каталог.


Общие правила наименования:

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

инструкции

но! требование

bim координатор

Civil 3D

инструкция

требования

bim-координатор

civil3d

 
Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует. 


Общие правила размещения меток:

light bulb Чтобы не придумывать новые правила, используйте уже разработанную систему. Посмотрите правила Группы BIM-поддержки Метки инструкций. 

Если вы создаёте для своего раздела собственные правила, то следуйте общим рекомендациям: 

  • Не создавайте множество меток, по которым можно найти только одну страницу.  Учитывайте все алгоритмы поиска: через наименование страницы происходит конкретизация поиска

  • Добавляйте метки к странице по принципу «от общего к частному»
Обязательные →Категории, пространства, раздела →Дополнительные →Основные (суть темы) 
bim
проектный_блок
кадры
маркетинг
и т.д.

ар
кр
эом
revit
civil3d
fm
bim-inspector
piktools 
bim-поддержка 
bim-координация
фс 
уц
и т.д.

коммерция
реновация
рабочая_документация
спецификация
задача
обучение
новости
р22 (шифр проекта)
и т.д.

оси
координаты
помещение
вор
реестр
ошибка
ипр
отпуск
и т.д.





thumbs up Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!


  • No labels