Как сделать справочник c
Обновлено: 08.07.2024
Как перебрать элементы подчиненного справочника с помощью запроса?
Как перебрать элементы подчиненного справочника с помощью выборки справочника?
Как открыть форму списка (элемента) справочника?
Как добавить запись в табличную часть элемента справочника?
Как удалить строки из табличной части справочника?
Как перебрать строки табличной части справочника?
Как создать элемент в нужной группе?
Как узнать, есть ли у текущего элемента подчиненные?
Как узнать количество подчиненных элементов у выбранного элемента справочника?
Как узнать количество подчиненных элементов у выбранного элемента справочника, если подчиненных справочников несколько?
Как получить всех родителей выбранного элемента справочника?
Как получить все элементы справочника, содержащие в наименовании определенную подстроку, со всей иерархией, в которую они входят?
Как найти все элементы справочника, в которых не заполнен строковый реквизит?
Как организовать программный выбор элемента справочника?
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Справочник предоставляет линейный или иерархический перечень элементов, содержащий краткие и точные сведения, объединенные единой тематикой. Обычно сведения в справочнике расположены в определённом порядке (алфавитном, систематическом, хронологическом и т.д.), удобном для их быстрого поиска.
В многомерной модели данных элементы справочника играют роль индексов, которые используются для составления координатного вектора показателей, находящихся в ячейках куба. Элементы справочника обладают набором атрибутов, таких как имя элемента, его уникальный код, порядок следования в иерархии. При объединении элементов в справочнике появляется наиболее важное свойство справочника - иерархия. Как правило, иерархия может быть представлена в виде дерева, в вершинах которого находятся элементы справочника, связанные между собой атрибутами отношения владения.
Создание справочников
Для создания справочника в навигаторе объектов:
После создания справочника можно просмотреть его содержимое.
Существуют следующие виды справочников:
Табличный справочник . Справочник предназначен для структурированного представления элементов без возможности их добавления и изменения. Для создания справочника требуется табличный набор данных или справочник НСИ. Каждая запись источника данных представляет собой элемент справочника и должна содержать определение всех атрибутов справочника. Для ограничения количества данных, попадающих в справочник, пользователь может использовать различные фильтры. Табличный справочник поддерживает управление содержимым при помощи параметров, то есть является динамическим. Может быть создан в любом месте репозитория:
Календарный справочник . Содержит иерархическое представление временной шкалы с заданной детализацией.
Календарный справочник поддерживает детализацию по следующим уровням: годы, 9 месяцев, полугодия, кварталы, месяцы, недели и дни. Его содержимое генерируется автоматически в зависимости от указанных параметров.
Календарный справочник поддерживает динамическое определение начала и окончания временной шкалы, то есть является динамическим.
Для построения данного справочника не нужно создавать таблицы и устанавливать взаимосвязь между элементами таблиц. Необходимо лишь выбрать уровни календаря, а их соподчиненность, элементы и взаимосвязь между ними генерируются системой:
- Вычисляемый справочник . Структура справочника задается по аналогии с табличным справочником. Наполнение справочника элементами осуществляется на основе алгоритма пользователя. Алгоритм задается в виде модуля на внутреннем языке программирования Fore . Модуль должен содержать процедуру, имеющую следующую сигнатуру:
Sub (UserDim: IUserDimension; Builder: IDimBuilder; Params: IMetabaseObjectParamValues);
Begin
//Код для построения дерева элементов вычисляемого справочника
End Sub ;
Табличный справочник НСИ. Справочник предназначен для структурированного представления элементов с возможностью их преобразования. Для создания справочника не требуется источник данных. Данные в справочник могут быть внесены вручную или загружены из источника данных с помощью встроенных инструментов ETL. Элементы справочника могут изменяться во времени, то есть иметь несколько версий. Табличный справочник НСИ может быть создан в любом месте репозитория, а не только в репозитории НСИ. Табличный справочник НСИ использует для хранения информации отдельную таблицу. Она создается автоматически при создании справочника и является его дочерним объектом. Поля таблицы соответствуют атрибутам справочника. Для создания табличного справочника НСИ вне репозитория НСИ требуется БД для хранения данных справочника:
Составной табличный справочник НСИ . Табличный справочник НСИ, который включает в себя как свои собственные элементы, так и элементы из других справочников НСИ:
В зависимости от структуры справочники можно разделить на следующие виды:
Рекурсивный справочник . Справочник, число уровней которого не может быть зафиксировано при создании, так как оно зависит от данных, на основе которых он построен;
Нерекурсивный справочник . Справочник, число уровней которого фиксируется при создании и не зависит от данных, на основе которых он построен.
Справочник может быть:
Примечание . Создание справочников доступно только в настольном приложении. В веб-приложении доступна работа только с табличными справочниками НСИ и составными табличными справочниками НСИ.
Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для просмотра CHM-файлов есть во всех версиях Windows 10. Более того, наличие справки в приложении часто рассматривается как один из показателей качества приложения. В этой статье я расскажу о том, как создать справку в формате CHM.
Справка в формате HTML Help (CHM) представляет собой скомпилированный HTML — автономный веб-сайт, сжатый и упакованный в файл формата CHM. Наряду со стандартным функционалом, таким как динамическое оглавление, указатель и полнотекстовый поиск, HTML Help может содержать и дополнительный функционал, например, избранное и т.д. Подробное описание формата можно посмотреть в статье Формат HTML Help. Создать CHM справку можно при помощи специальных программ, как платных, так и бесплатных.
Бесплатные программы для создания CHM-справки
MS HTML Help Workshop
Компания Microsoft, разработчик формата CHM, предоставила для создания справки бесплатный инструмент, HTML Help Workshop. Его можно свободно скачать с сайта компании по данной ссылке. В составе программы имеется максимально подробный файл справки на английском языке. На сайте есть подробное описание формата, также в оригинале.
Очевидный, и, на мой взгляд, единственный плюс программы HTML Help Workshop — бесплатность. Создание более-менее серьезной справки в HTML Help Workshop — очень трудоемкая задача, выполнение которой растягивается на многие месяцы. При этом вы получите справку с базовыми возможностями формата CHM: текст, рисунки, ссылки. Регулярное обновление справки на базе проекта, созданного в HTML Help Workshop, практически нереально. Я пользуюсь данной программой исключительно для компиляции / декомпиляции CHM-файлов. В более продвинутых бесплатных и профессиональных программах, предназначенных для разработки справочных систем, HTML Help Workshop используется в качестве компилятора. Это говорит о солидном потенциале формата, скрывающемся под непростым пользовательским интерфейсом инструмента.
Рассмотрим еще несколько более продвинутых программ, при помощи которых можно создать справку в формате CHM: HelpNDoc и Help+Manual.
HelpNDoc
HelpNDoc — это условно-бесплатная программа от французского разработчика, компании IBE Software. Пользовательский интерфейс программы выполнен в стиле MS Office, поэтому работу с программой можно быстро и легко освоить. Для работы с текстом, рисунками, таблицами, ссылками и другим контентом в HelpNDoc используется простой и интуитивно понятный визуальный редактор. HelpNDoc работает по принципу единого источника и поддерживает экспорт проекта в ряд форматов справки, в том числе, CHM. Подробное описание программы на русском языке можно посмотреть здесь.
На момент написания статьи выпускается 3 редакции программы:
- Standard — платная редакция, позволяющая генерировать CHM и Web-Help в коммерческих целях. Выходные файлы в остальных форматах (DOCX, PDF, EPUB и др.) будет содержать отметку о том, что они созданы некоммерческой версии программы.
- Professional — платная редакция без отметок во всех выходных форматах.
- Personal — полнофункциональная программа, бесплатная для личного, некоммерческого использования. Во всех выходных форматах в нижней части всех страниц добавляется отметка о том, что файл создан с использованием некоммерческой версии HelpNDoc.
По опыту использования HelpNDoc в течение 2 лет могу поделиться только положительными впечатлениями. HelpNDoc позволяет быстро написать с нуля и оперативно обновлять справку в различных форматах. Во время работы с программой не хватает возможности вставки в документацию элементов, характерных для электронных форматов: раскрывающихся блоков с контентом (аккордеон), адаптивных изображений, размер которых автоматически подстраивается под размер окна и т.п. Разумеется, все это можно реализовать, используя готовые или написанные самостоятельно стили и скрипты, но это отрывает технического писателя от главной задачи: разработка и обновление справки.
Как создать профессиональную справку в формате CHM
Несмотря на то, что первой профессиональной программой для разработки справки, с которой я познакомился в 2003 году, был RoboHelp Х4 (в связке с RoboDemo 4 они использовались в проекте локализации библиотеки пользовательской документации, включая справку и электронный обучающий видеокурс), с 2005 года я предпочитаю работать с Help&Manual. Сегодня это программный комплекс Help+Manual 7, в котором, на мой взгляд, есть всё необходимое для автора пользовательской документации.
Help+Manual 7 Pro — это самый популярный программный комплекс для создания справки, пользовательской и различной технической документации. Он предназначен для разработки и локализации профессиональных справочных систем, руководств пользователя, баз знаний, электронных книг и другой документации в форматах CHM, WebHelp, PDF, DOCX, EPUB, MOBI и др. для настольных и мобильных приложений, iOS и Android, Windows и Linux.
Бесплатная книга по Help+Manual 7 Pro на русском языке
Большинство обучающих материалов и инструкций по Help&Manual написано на английском и немецком языках. Предлагаемая вашему вниманию книга на русском. В ней изложены основы работы с Help&Manual. Какая версия программного комплекса подходит для работы с кириллицей? Где взять Help&Manual? Как установить? Что и как настроить для начала работы? Ответы на эти и многие другие вопросы вы найдете в данной книге.
Даже если вы ни разу не делали справку в формате CHM, данная книга идеально подойдет вам. В ней подробно разбирается пользовательский интерфейс Help&Manual, настройки и порядок работы. Для всех этапов создания справки в формате CHM приводятся подробные пошаговые инструкции с рисунками. Изучив мою книгу, вы сможете самостоятельно:
- установить и подготовить Help+Manual к работе;
- создать проект с нуля и импортировать все необходимые материалы;
- наполнить проект контентом: текстом, рисунками, таблицами и т.д.;
- создать справку в формате CHM.
Предварительный просмотр книги:
Чтобы бесплатно скачать книгу, пожалуйста, заполните форму:
Если есть вопросы по изложенному материалу или пожелания, что можно дополнительно включить в книгу, пишите в комментариях, либо воспользуйтесь формой обратной связи.
Если значение логического выражения истинно, то вычисляется выражение1, в противном случае вычисляется выражение2.
Пример:
switch(‘выражение целого типа’)
case ‘значение1’ :
break;
case ‘значение2’ :
break;
case ‘значение n’:
break;
default
/*ветку default можно не описывать. Она выполняется, если ни один из вышестоящего выражения не удовлетворено*/
‘последовательность операторовn+1’;
Пример:
default : cout "не один и не два" ; //если n равно другому числу, то выводится строка "не один и не два"
Операторы цикла:
while (‘логическое выражение’) //цикл с проверкой условия на верху
Пример:
do
while (‘логическое выражение’); //Цикл условия проверки внизу
Пример:
for(‘инициализация’; ‘проверка’; ‘новое_значение’)
Пример:
for ( i = 0 ; g [ i ] = 0 ; i ++ ) ; //В начале i=0 и пока g[i]!=0, к i прибавляется 1 и выполняется пустой оператор ;
; /*Пустой оператор применяется когда синтаксис языка требует присутствие оператора, однако по логике программы оператор должен отсутствовать.*/
Пример:
for ( i = 0 ; g [ i ] = 0 ; i ++ ) ; //В начале i=0 и пока g[i]!=0, к i прибавляется 1 (оператор после оператора for() не нужен)
Массивы:
‘тип данных’ ‘имя массива’ [‘размер массива’];
Адресация к массивам:
‘имя массива’ [‘значение индекса’];
Пример:
Константы:
‘тип’ ‘имя константы’ = ‘значение константы’; //Описание константы
Пример:
Классы:
Объявление классов:
class ‘имя класса’
‘закрытые функции и переменные класса’;
public:
‘имя класса’(‘список параметров’); //Конструктор
~‘имя класса’(); //Деструктор
‘открытые функции и переменные класса’;
> ‘список объектов’;
Определение функции-члена:
‘тип возращаемого значения’ ‘имя класса’::‘имя функции’ (‘список параметров’)
‘тело функции’;
Определение конструктора:
‘имя класса’::‘имя класса’ (‘список параметров’)
‘тело конструктора’;
Определение деструктора
‘имя класса’::~‘имя класса’ (‘список параметров’)
‘тело деструктора’;
Объявление класса:
‘имя класса’ ‘имя объекта’(‘список параметров’);
Обращение к членам класса:
‘имя класса’.‘член класса’;
‘имя класса’->‘член класса’;
Пример:
Структуры:
struct ‘имя структуры’
‘имя структуры’(‘список параметров’);//Конструктор
~‘имя структуры’(); //Деструктор
‘открытые функции и переменные структуры’;
private:
‘закрытые функции и переменные структуры’;
> ‘список объектов’;
Определение функции-члена, конструктора, деструктора, объявление структуры, обращение к членам структуры такие же как у класса.
Встраиваемые функции:
inline ‘тип возращаемого значения’ ‘имя функции’(‘список параметров’)
‘тело функции’;
Пример:
Встраиваемые функции в объявлении класса:
public:
‘тип возвращаемого значения’ ‘имя функции’(‘список параметров’)‘тело функции’;>
Пример:
Дружеские функции:
class ‘имя класса’
public:
friend ‘тип возвращаемого значения’ ‘имя функции’(‘список параметров’);
‘тип возвращаемого значения’ ‘имя функции’ (‘список параметров’);
Пример:
Комментарии:
Комментарии 6
А так, неплохой краткий справочник по синтаксису=)
Здравствуйте.
Большое спасибо, что вы захотели сделать мой справочник лучше, это мне очень льстит.
>1. Точка с запятой после using namespace std не нужна;
К сожалению многие компиляторы с вами не согласяться. Возможно вы имели ввиду конструкцию:
namespace std
…
>
Тогда да, точка с зяпятой после неё дейтсвительно не нужна.
Или можете сказать название компилятора или IDE, где это работает?
>2. В for’е то, что стоит в круглых скобках разделяется точками с запятыми, а не запятыми;
Да, косяк поправил.
>3. Для кода на любом языке всегда используй моноширинный шрифт (Courier, Courier New, Consolas, monospace), даже если этот код не выделен в отдельный абзац;
посмотрел на Courier, стало скучнее. 🙂 Лан, пусть дети привыкают.
>А так, неплохой краткий справочник по синтаксису=)
И ещё раз спасибо, что обратили внимания на данную статью.
Рис. 1.2. Файл справочной системы в формате PDF
Доступ к справочнику может быть реализован несколькими способами. Наиболее распространенный из них - явный вызов посредством соответствующей команды меню справка, но возможны также использование специальной кнопки на панели инструментов или вызов через контекстное меню значка конкретного объекта. Итак, для того чтобы формат электронного документа был пригоден для создания справочника, он (формат) должен обладать следующими свойствами:
· обеспечивать приемлемую компактность итогового документа;
· обладать достаточной функциональностью (в частности, поддерживать полнотекстовый поиск);
· поддерживать возможность представления мультимедийной информации (графики, видео, звука);
· не требовать установки на компьютеры пользователей дополнительного программного обеспечения;
· достаточно легко интегрироваться с программным кодом создаваемого приложения.
Для приложений, разрабатываемых под Windows, на сегодняшний день большинству их перечисленных выше требований отвечают три формата: WinHelp, HTML, HTML Help (CHM).
Таким образом, когда встает вопрос о выборе наиболее подходящего инструмента, имеет смысл принимать во внимание следующие факторы:
· Какие выходные форматы справочников он поддерживает;
· Насколько полно он использует те возможности, которые предоставляет формат справочника;
· Насколько удобны средства управления параметрами проекта;
· Имеются ли в составе инструмента средства тестирования гипертекстовых ссылок;
· Позволяет ли инструмент работать с исходными форматами данных (RTF - для WinHelp и HTML - для HTML Help);
· Насколко удобно реализовано взаимодействие с дополнительными инструментами, необходимыми для подготовки мультимедийных материалов;
· Какова степень (или возможность) интеграции со средой разработки приложения, для которой создается справочник.
При создании справочников на русском языке существенным фактором является также то, насколько корректно инструмент работает с кириллицей (хотя сами форматы WinHelp и HTML Help никаких ограничений в этом отношении не накладывают.)
Help And Manual.
С помощью этого пакета можно получить справочник в трех форматах: WinHelp, HTML Help и WebHelp (разработчики HelpAnd Manual именуют его Brouser Based Help). Кроме того, возможен экспорт справочника в PDF-файл и в файл формата текстового редактора Word (.doc или.rtf). И наконец, пакет Help And Manual способен создавать электронные книги (electronic book). Такая книга внешне очень похожа на справочник в формате HTML Help, но представляет собой самостоятельное Windows-приложение (EXE-файл). Формат электронной книги имеет один существенный недостаток, - он не очень компактен (но вполне пригоден для распространения дополнительных обучающих материалов на компакт-дисках).
Пакет HelpAnd Manual использует для генерации справочников в форматах WinHelp и HTML Help компиляторы от Microsoft, однако прямого доступа к интерфейсу Help Workshop и HTML Help Workshop разработчик справочника не имеет.
Следует отметить, что в дистрибутив входит программа Help Workshop, а вот HTML Help Workshop предполагается получить на сайте компании EC Software. Если же этот инструмент уже установлен на компьютере, следует указать его расположение.
При создании русскоязычного справочника в формате WinHelp никаких дополнительных настроек выполнять не требуется. Перед генерацией CHM-файла необходимо указать используемый язык. Также, на сайте компании можно получить русский словарь, подключаемый к Help And Manual для проверки правописания текста разделов.
Mif2GO - это не самостоятельное приложение, а подключаемый модуль, который может работать только совместно с пакетом Adobe FrameMaker.
FrameMaker - это программа для верстки, ориентированная на создание документов большого объема, имеющих сложную структуру. В ней реализованы средства для автоматической нумерации таблиц и иллюстраций, построения оглавления и указателей. Кроме того, она поддерживает перекрестные ссылки и гипертекстовые связи, позволяет привязывать графику к абзацам текста и многое другое. Можно разделить документ на главы, собрать главы в книгу, и FrameMaker автоматически обновит номера страниц и ссылки независимо от того, каким образом переставлены страницы, главы или разделы.
Для хранения документов FrameMaker использует собственный формат файлов (.fm и.book), однако в программе имеются средства, позволяющие экспортировать файлы в форматы PDF и HTML. Необходимо также отметить, сто программа FrameMaker изначально создавалась для подготовки технических описаний систем вооружения (в частности, авиационной техники), а также верстки текстов, требующих частого обновления (каковой является документация к программному обеспечению).
Mif2GO позволяет создавать справочники в пяти форматах: WinHelp, HTML Help, OmniHelp (собственный кроссплатформенный формат справочной системы компании Omni Systems, аналогичный формату WebHelp), Oracle Help и JavaHelp. Для генерации выходных файлов в перечисленных форматах требуется наличие на компьютере соответствующих компиляторов, которые не входят в дистрибутив Mif2GO и должны устанавливаться отдельно. Собственно говоря, для подключения Mif2GO к FrameMaker установка как таковая не требуется. Достаточно скопировать файлы из дистрибутива в папки, указанные в инструкции по установке.
В качестве исходных данных для создания справочников WinHelp и HTML Help программа Mif2GO использует файлы в форматах RTF и HTML. Однако прежде, чем ни будут получены из собственных файлов FrameMaker (.fm и.book), должен пройти многоэтапный процесс преобразований.
1. Enterprise. Этот вариант включает единственный продукт RoboHelp Enterprise, который позволяет создавать справочную систему в одноименном формате. Его существенное отличие от всех форматов, рассмотренных выше, состоит в том, что он предполагает наличие серверной и клиентской части справочной системы. Серверное программное обеспечение, основанное на использовании сервера IIS (Internet Information Server) от Microsoft, позволяет отслеживать действия пользователя, работающего со справочной системой. Благодаря этому разработчик может получить весьма ценные статистические данные об интересах пользователей. Формат клиентской части справки аналогичен формату WebHelp.
2. Professional. Этот вариант включает набор инструментов под общим наименованием RoboHelp Office. В набор входят:
· RoboHelp HTML - приложение, предназначенное для создания справочных систем на основе языка HTML и позволяющее генерировать справочники в форматах WebHelp, Microsoft HTML Help, JavaHelp и Oracle Help for Java;
· RoboHelp Classic - приложение, специализирующееся на подготовке справочников в формате WinHelp, в том числе в модифицированном формате WinHelp 2000;
3. Standart. Это облегченный вариант RoboHelp Office, который включает три инструмента:
· RoboHelp for Microsoft HTML Help - приложение для разработки справочных систем в формате HTML Help;
· RoboHelp for WinHelp - приложение для разработки справочных систем в формате WinHelp;
· RoboHelp for Word - приложение, которое позволяет создать справочники во всех стандартных форматах (WebHelp, Microsoft HTML Help, JavaHelp), но с одним ограничением: в качестве редактора разделов (в том числе HTML-файлов) с ним может использоваться только Microsoft Word.
Для работы с исходными форматами данных (RTF - для WinHelp и HTML - для HTML Help) RoboHelp по умолчанию использует Microsoft Word, однако для создания разделов справочника он подключает собственные шаблоны, в значительной степени автоматизирующие процесс редактирования.
MS Word нельзя считать идеальным инструментом для создания файлов в форматах RTF и HTML, поскольку выходные файлы содержат избыточные теги. Но если для работы с RTF альтернативы нет, то для подготовки разделов в RoboHelp HTML модно подключать любой HTML-редактор.
При разработке с помощью приложения RoboHelp HTML возможно не корректное отображение кириллицы. Т.к. изначально в RoboHelp Office не предусмотрена поддержка русского языка. Вместе с тем, RoboHelp практически не изменяет параметры RTF-файла, созданного в Word. Поэтому при генерации справочника в формате WinHelp языковые проблемы достаточно редки. При создании справочной системы в формате HTML Help проблемы с корректным отображением кириллицы (на этапе разработки справочника) более вероятны. Эта проблема может быть решена несколькими способами, в том числе посредством подключения к RoboHelp HTML внешнего HTML-редактора.
Мощная и удобная в использовании программа, с помощью которой можно быстро и легко создавать справочную документацию в разнообразных форматах, включая CHM, HTML, PDF или совместимых с Word.
Рис. 1.3. Внешний вид HelpNDoc
В программе присутствует интерактивная проверка орфографии, возможность визуального редактирования, генерация кода для различных языков программирования (C/C++, Delphi/Pascal, Fortran 90/95, Power Basic и Visual Basic), поддержка шаблонов и многое другое. Программа бесплатна для персонального использования.
Читайте также: