УкраїнськаEnglishmRussian
Вхід/Новий
У темі немає нових постів

Печатный документ руководства по OpenSCADA


Автор Повідомлення
Повідомлення створено: 12. 02. 2009 [13:33]
roman
Roman Savochenko
Moderator
Contributor
Developer
Автор теми
Зареєстрован(а) с: 12.12.2007
Повідомлення: 3750
Был закончен раздел конфигурации OpenSCADA в документе описания. На основе документов: "Введение", "Функциональные характеристики и требования системы OpenSCADA", "Описание программы OpenSCADA" и документации на модуля создан документ руководства для OpenSCADA 0.6.3 на 303 печатные страницы.

Кроме этого дополнен и переформатирован документ "API системы OpenSCADA" на 75 печатные страницы.

Документы подготовленные для печати доступны на ftp и http серверах.

Learn, learn and learn better than work, work and work.
Повідомлення створено: 16. 02. 2009 [07:17]
Expert
Владимир Тихонов
Зареєстрован(а) с: 05.08.2008
Повідомлення: 45
ссылку исправьте а то написано ftp://oscada.org.ua/OpenSCADA/0.6.3/doc а отправляет на http:///

Все глюки Windows исправляются установкой Linux
Повідомлення створено: 03. 07. 2009 [08:42]
fLegmatik
Азат Газизов
Зареєстрован(а) с: 19.02.2009
Повідомлення: 16
Я смотрю, пдфки регулярно обновляются. В основе лежат материалы базы знаний? А что за инструмент используется для столь элегантного экспорта сотни статей БЗ? Есть какой-то встроенный в WackoWiki, что ль?

В своё время я рассматривал вариант написания диссертации в mediawiki для того, чтоб научные руководитель, консультанты и товарищи могли в любое время вносить правки и замечания в документ. Но тогда не нашёл (да, похоже, и сейчас такого нет) какого-нибудь инструмента для конвертации wiki2odt -- чтобы и разметку переводил в стили, и объединял бы отдельные статьи как параграфы одного документа, основываясь на странице оглавления. Сам я такой парсер никогда не смогу написать.

Спрашиваю ещё потому, что можно было бы усовершенствовать данный инструмент, коли он существет.
1. Проставлять номера страниц по центру, а не справа. Тогда можно будет, не задумываясь, отправлять документ на двухстороннюю печать. Заметку с названием можно оставить справа, но лучше на чётных страницах ставить слева.
2. Ввести общую нумерацию разделов (кроме введения), добавляя полученные числа к существующим заголовкам. Например, "2.1.3 PLC и другие источники динамических данных. Подсистема 'Сбор данных' ".
3. Ввести общую нумерацию рисунков. Разумеется, нужно будет превращать все упоминаемые в текстах " [Р|р]ис[.|унок][ ]{0,}[0-9]* " в какие-нибудь автоматические ссылки как в OpenOffice.org, чтобы их тоже исправлять. Очень сложная, на мой взгляд работа.
4. После внутренних ссылок проставлять в скобках номер страницы, на которой находится заголовок. Например, "модуль UI.QTCfg (стр. 239)". После внешних опять-таки в скобках давать полный адрес ссылки, если для неё задан другой текст. Даже круче: отправлять внешние ссылки в список литературы, но нафиг не надо.
5. Ещё желательно автоматически подгонять оформление под текущий российский ГОСТ 2.10х:
- расшифровывать "рис."/"Рис." до "рисунок"/"Рисунок",
- убирать точку в конце заголовков,
- убирать точку в конце нумерации заголовка, как в вышеприведённом примере (хотя не очень красиво получается).


[Повідомлення редагувалось 3 раз(ів), останній раз 03.07.2009 в 09:30.]

Окажу помощь в организации связи OpenSCADA <--modbus--> Овен ПЛК.
xmpp:ag@jabber.ufanet.ru
[Сообщение редактировалось 65535 раз(а), в последний раз 19.01.2038 в 03:14.]
Повідомлення створено: 04. 07. 2009 [10:30]
roman
Roman Savochenko
Moderator
Contributor
Developer
Автор теми
Зареєстрован(а) с: 12.12.2007
Повідомлення: 3750
fLegmatik wrote:

Я смотрю, пдфки регулярно обновляются. В основе лежат материалы базы знаний? А что за инструмент используется для столь элегантного экспорта сотни статей БЗ?

Да, в основе всей документации материалы на БЗ.
Для экспорта используется шаблон ODT и руки. К сожалению полностью это не автоматизировано.

fLegmatik wrote:

Есть какой-то встроенный в WackoWiki, что ль?

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

fLegmatik wrote:

В своё время я рассматривал вариант написания диссертации в mediawiki для того, чтоб научные руководитель, консультанты и товарищи могли в любое время вносить правки и замечания в документ. Но тогда не нашёл (да, похоже, и сейчас такого нет) какого-нибудь инструмента для конвертации wiki2odt -- чтобы и разметку переводил в стили, и объединял бы отдельные статьи как параграфы одного документа, основываясь на странице оглавления. Сам я такой парсер никогда не смогу написать.

Для mediawiki такой конвертер есть. Одна только проблема, механизмы форматирования в mediawiki крайне примитивны и документ, как результат, получается такой-же. Даже прямое копирование из WackoWiki в шаблон ODT даёт лучший результат.

fLegmatik wrote:

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

Просто поменять шаблон нужно.
fLegmatik wrote:

2. Ввести общую нумерацию разделов (кроме введения), добавляя полученные числа к существующим заголовкам. Например, "2.1.3 PLC и другие источники динамических данных. Подсистема 'Сбор данных' ".

Для общего документа это вредно, поскольку теряется связность с БЗ. А в отдельных документах нумерация и так сплошная.
fLegmatik wrote:

3. Ввести общую нумерацию рисунков. Разумеется, нужно будет превращать все упоминаемые в текстах " [Р|р]ис[.|унок][ ]{0,}[0-9]* " в какие-нибудь автоматические ссылки как в OpenOffice.org, чтобы их тоже исправлять. Очень сложная, на мой взгляд работа.

Тоже самое, что и в предыдущем случае.

fLegmatik wrote:

5. Ещё желательно автоматически подгонять оформление под текущий российский ГОСТ 2.10х:
- расшифровывать "рис."/"Рис." до "рисунок"/"Рисунок",
- убирать точку в конце заголовков,
- убирать точку в конце нумерации заголовка, как в вышеприведённом примере (хотя не очень красиво получается).

Рисунок по гост не разворачивается. Точки только недавно ставил для полиграфии. icon_smile.gif

Learn, learn and learn better than work, work and work.
Повідомлення створено: 06. 07. 2009 [06:49]
fLegmatik
Азат Газизов
Зареєстрован(а) с: 19.02.2009
Повідомлення: 16
roman wrote:
Рисунок по гост не разворачивается.
По оформлению этого элемента можно сразу отличить перспективную молодёжь от опытных кадров. В технических вузах нынче строго спрашивают за невыполнение (даже не российского, а) межгосударственного ГОСТ 2.105-95. Там очень много радикальных изменений в отношении оформления текстов, рисунков, таблиц по сравнению с предшествующей редакцией. Про иллюстрации, в частности, написано в пункте 4.3.1.
roman wrote:
Точки только недавно ставил для полиграфии.
Аха! Значит, вопрос тиражирования в бумажном виде обсуждается уже с печатниками? Тогда запишите меня в очередь на приобретение книги. Также можете показать печатникам пункт 4.1.9 того же ГОСТ, хотя они наверняка не признают ЕСКД.

Окажу помощь в организации связи OpenSCADA <--modbus--> Овен ПЛК.
xmpp:ag@jabber.ufanet.ru
[Сообщение редактировалось 65535 раз(а), в последний раз 19.01.2038 в 03:14.]
Повідомлення створено: 09. 07. 2009 [10:45]
roman
Roman Savochenko
Moderator
Contributor
Developer
Автор теми
Зареєстрован(а) с: 12.12.2007
Повідомлення: 3750
fLegmatik wrote:

В технических вузах нынче строго спрашивают за невыполнение (даже не российского, а) межгосударственного ГОСТ 2.105-95. Там очень много радикальных изменений в отношении оформления текстов, рисунков, таблиц по сравнению с предшествующей редакцией. Про иллюстрации, в частности, написано в пункте 4.3.1.

Поглядим
fLegmatik wrote:

roman wrote:
Точки только недавно ставил для полиграфии.
Аха! Значит, вопрос тиражирования в бумажном виде обсуждается уже с печатниками? Тогда запишите меня в очередь на приобретение книги.

Не с печатниками, а с руководством DIYA. Хотя это всёравно вялотекущий процесс, который будет форсирован только после 0.6.4, или вообще после 0.7.0.

Learn, learn and learn better than work, work and work.



6681