Wiki source code of DocumentationTemplate

Last modified by Eugen Colesnicov on 2013/03/20 13:56
Show last authors
1 {{box cssClass="floatinginfobox" title="**Содержание**"}}
2 {{toc start="2"/}}
3 {{/box}}
4
5 == О программе ==
6
7 Middleware-приложение **etvcCV** предоставляет средства для регистрации и учета CV (различные поля), хранения оригинальных файлов-CV, ввода заметок и комментариев к CV. Технология LiveTable дает пользователям широкие возможности по фильтрации и сортировке базы CV по любому полю. Также обеспечиваются возможности контекстного поиска как по Базе CV, так и по содержимому оригинальных файлов CV. Перечень параметров CV, а также язык интерфейса не являются фиксированными и могут быть сконфигурированы под Ваши потребности.
8
9 Это middleware-приложение создано на платформе **[[XWiki>>http://xwiki.org]]**. Также используется следующие расширения платформы XWiki: [[Spoiler Macro>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Spoiler+Macro]], [[Tabs Macro>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Tabs+Macro]]
10
11 == Начало использования ==
12
13 Основные элементы начального экрана приложения:
14
15 * **Каталог CV** - таблица, содержащая перечень всех CV. Вы можете удобно и быстро сортировать и фильтровать записи таблицы, а после нахождения нужных CV - перейти к редактированию карточки или же сразу открыть файл CV.
16
17 * **Управляющая панель** - обеспеченивает возможности по доступу к Каталогу CV, справочникам и документации, вводу новых CV, новых элементов справочников, а также контекстному поиску по базе CV. Элементы управления на Панели контекстно выводятся, в зависимости от текущей операции на основном пространстве экрана.
18
19 [[image:etvcCVcode.DocumentationTemplate@pic1.png||width="80%"]]
20
21
22 //Примечания://
23 * //здесь и далее по тексту перечень полей Каталога CV, параметры Карточки CV, перечень вспомогательных справочников, а также язык интерфейса приложения могут отличаться от указанных на скриншотах и в тексте, в связи с широкими возможностями по настройке данных параметров.//
24
25 == Работа с Карточкой CV ==
26
27 Для добавления CV введите условное внутренее имя **Карточки CV** (обычно фамилия+имя) в поле //Добавить CV// на **Управляющей Панели** и кликните на иконку [[image:etvcCVcode.DocumentationTemplate@add.gif]].
28 [[image:etvcCVcode.DocumentationTemplate@pic2.png]]
29
30
31 Новая **Карточка CV** будет открыта в режиме редактирования. Заполните в ней те параметры, которые необходимы. Затем нажмите на "Сохранить и просмотреть".
32 [[image:etvcCVcode.DocumentationTemplate@pic3.png||width="80%"]]
33
34
35 После сохранения **Карточка CV** будет показана в режиме просмотра. Проверьте правильность заполнения. Вернуться к редактированию можно нажав на //Правка//. Для добавления неограниченного количества файлов CV используется **закладка Файлы** внизу Карточки CV в режиме просмотра. Нажмите на кнопку //Выберите файл// и после осуществления выбора нажмите на //Добавить//. При необходимости - повторите. Все добавленные файлы показываются в **закладке Файлы**.
36 [[image:etvcCVcode.DocumentationTemplate@pic4.png||width="80%"]]
37
38 Вернуться к **Каталогу CV** можно кликнув на соответствующий пункт меню на **Управляющей панели**.
39
40 == Использование Каталога CV ==
41
42 **Каталог CV** представляет собой специальную табличную форму (технология LiveTable), каждая запись (строка) которой является отдельным CV, а поля (колонки) данной строки содержат различные параметры из Карточки данного CV.
43 [[image:etvcCVcode.DocumentationTemplate@pic5.png||width="80%"]]
44
45 **Каталог CV** предоставляет пользователям следующие возможности:
46 * //Многостраничность// - все записи таблицы разбиваются на порции (страницы) и на экране показывается только одна из страниц. Справа верху и внизу табличной формы приводится список всех страниц и предоставляются возможности по переходу на следующую / предыдущую страницу, а также быстрому переходу на страницу с определенным номером. Слева вверху табличной формы показывается общее число строк и интервал тех строк, который показываются в текущий момент на экране, а также предоставляется возможность по выбору количества показываемых строк на одной странице экранной формы.
47
48 * //Фильтрация по любому полю, а также по нескольким полям сразу// - между шапкой таблицы и записями таблицы имеется еще одна строка, содержащая пустые поля для каждой из колонок. Просто начинайте набирать текст, по которому вы хотите фильтровать то или иное поле - и записи всего Каталога CV сразу же будут фильтроваться после набора каждой буквы (технология LiveTable).
49
50 * //Сортировка по любому полю// - просто кликните на нужный заголовок колонки - и весь Каталог CV сразу же будет отсортирован по данной колонке. Для сортировки в обратном порядке - нажмите еще раз. Текущее активное поле сортировки показывается выделением заголовка колонки, а порядок сортировки - стрелочкой в заголовке столбца.
51
52 * //Переход к Карточке выбранного CV// - просто наведите мышку на нужную строку Каталога CV и кликните на Имени или Фамилии - Карточка данного CV будет открыта в режиме просмотра. Доступные действия в Карточке CV, открытой в режиме просмотра, описаны ранее.
53
54 * //Доступ к файлам CV// - в таблице Каталога CV, для каждой строки, в специальной колонке, показываются все файлы CV, прикрепленные к данной Карточке CV. Для открытия / сохранения на диске просто кликните на имени файла.
55
56 * //Редактирование и удаление CV// - в таблице Каталога CV, в отдельной колонке, приведены ссылки, позволяющие: а) редактировать - сразу перейти в режим редактирования выбранной Карточки CV; b) полностью удалить CV (также удаляются и файлы CV).
57
58 == Работа со Справочниками ==
59 **Справочники** представляют собой предварительно заданные вспомогательные перечни возможных значений тех или иных параметров **Карточки CV**. Перечень доступных в текущей конфигурации справочников выводится на **Управляющую Панель**, соответственно для перехода к требуемому справочнику - кликните на его название.
60 [[image:etvcCVcode.DocumentationTemplate@pic6.png]]
61
62 На основном пространстве экрана будет открыт выбранный вами справочник. Элементы справочника представлены в стандартизированной табличной форме, аналогично табличной форме **Каталога CV** (технология LiveTable). Соответственно доступны стандартные возможности (многостраничность, фильтрация, сортировка, редактирование, удаление), обеспечиваемые и в **Каталоге CV** (см.выше).
63
64 Для добавления записи в справочник, на **Управляющей Панели** введите запись в поле //Добавить// и кликните на иконку [[image:etvcCVcode.DocumentationTemplate@add.gif]].
65 [[image:etvcCVcode.DocumentationTemplate@pic7.png||width="80%"]]
66
67 Далее нажмите //Сохранить и просмотреть// для завершения процедуры добавления в Справочник и возврата к табличной форме.
68 [[image:etvcCVcode.DocumentationTemplate@pic8.png||width="80%"]]
69
70 Вернуться к **Каталогу CV** можно кликнув на соответствующий пункт меню на **Управляющей панели**.
71
72 == Контекстный поиск CV ==
73 Контекстный поиск по базе CV является мощным универсальным средством выборки и поиска данных, без необходимости специального указания дополнительных критериев поиска. Поиск производится:
74 * во всех полях базы CV, формирующих Карточки CV
75 * в прикрепленных файлах-оригиналах CV (любой тип текстовых и офисных файлов doc, xls, pdf, txt, odf, html, ...)
76
77 Возможность поиска внутри прикрепленных текстовых файлов позволяет для Карточки CV заполнять только основную информацию, без необходимости, например, подробного указания полного перечня навыков и предыдущих работ претендента. И в дальнейшем, для выяснения наличия у кандидатов навыков работы с базой данных Oracle (например) - достаточно просто выполнить контекстный поиск по ключевому слову //Oracle// - все CV, где в Карточке или в файле-оригинале содержится данное ключевое слово - будут найдены.
78
79 Для начала контекстного поиска введите искомое ключевое слово в поле //искать CV// на **Управляющей Панели** и кликните на иконку [[image:etvcCVcode.DocumentationTemplate@search.png]].
80 [[image:etvcCVcode.DocumentationTemplate@pic9.png]]
81
82 Будет открыта специальная форма, на которую будут выведены результаты вашего запроса.
83
84 В верхней части формы имеется поле для ввода, где показывается введенное Вами ключевое слово. Вы можете изменить его и повторить поиск, если результаты текущего поиска неудовлетворительны. При этом также возможно использование специальных символов и выражений: * - означает //любой символ//, AND - позволяет выполнять поиск сразу по нескольким ключевым словам.
85
86 Далее, последовательно, выводятся найденные результаты. При этом результаты ранжируются по условному коэффициенту соответствия (вычисляется в процентах) - первыми показываются результаты, имеющие наибольший коэффициент соответствия.
87
88 [[image:etvcCVcode.DocumentationTemplate@pic10.png||width="80%"]]
89
90 Сами результаты бывают 2-х типов:
91 * ссылка на страницу Карточки CV - ключевое слово найдено среди параметров Карточек CV (эти результаты имеют приоритет)
92 * ссылка на файл CV - ключевое слово найдено внутри файлов-оригиналов CV
93
94 Также для каждого из результатов показывается ссылка на Карточку CV (для возможности перехода), а также имя пользователя и время последнего изменения Карточки CV.
95
96 Для перехода к результату и его просмотра - просто кликните на одну из ссылок (ссылки на Карточку CV или на файл-оригинал CV). Вернуться к **Каталогу CV** можно кликнув на соответствующий пункт меню на **Управляющей панели**.
97
98 == Прочие возможности ==
99 Приложение также содержит 2 другие формы:
100 * Форма с Документацией + История версий
101 * Форма настройки параметров приложения
102
103 Доступ к //Документации// осуществляется через клик на сведения о номере и дате текущей версии приложения, которые выводятся на **Управляющую Панель**. В отдельной закладке содержится также описание версий приложения с подробной историей изменений.
104
105 Доступ к //Настройкам// возможен только после открытия //Документации// через соответствующий пункт меню на **Управляющей Панели**.