eskdx: доводка до полного соответствия ГОСТ 2.105

[tonyk_av]

Всем привет!

Я - инженер. Пару лет назад решил попробовать оформить очередное "Руководство..." в ТеХ. Стартовал с LyX. Результатом работы и самим процессом остался очень доволен. С тех пор в работе использую связку LyX+eskdx. Но появились вопросы, решить которые мне не хватает знаний и практического опыта:

1) касается eskdx, а именно: смог ли кто-нибудь настроить правильное оформление перечислений? Проблема известная, но автор не поддерживает свой продукт, посему вопрос давно висит в воздухе нерешённым;

2) касается связки eskdx+LyX: довёл ли до ума кто-нибудь шаблон для LyX, чтобы и длинные таблицы, и титульный лист можно было делать исключительно визуальными средствами, без ТеХ-вставок и ряда небольших, но извращений?

P.S. Я понимаю, что здесь на форуме много грамотных и понимающих _суть_вопроса_ людей. Очень хочется получить ответы именно от таких. А суть проста: попробуйте вразумить/соблазнить/заставить кого-то отказаться от оформления документации в Ворде в пользу ТеХа, тогда поймёте, что без дружественного и визуального LyX сделать это сложно. Как показывает мой скромный опыт, на LyX люди пересаживаются довольно легко, особенно подогреваемые мыслью, что теперь о правильном оформление будет заботиться машина, а им нужно только писать. Вот почему и хочется "доточить" eskdx до полного соответствия ГОСТ и полной интеграции с LyX.

[tonyk_av]

Жаль, что никто не откликнулся...

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

%создание и автоматическая нумерация списков
\RequirePackage{enumitem}
\renewcommand{\alph}[1]{\asbuk{#1}} % костыль для кирилической нумерации вместо латинской

\setlist{nolistsep} % убираем дополнительные вертикальные отступы вокруг списков
\setenumerate[1]{label=\alph*), fullwidth, itemindent=\parindent,  listparindent=\parindent} 
\setenumerate[2]{label=\arabic*), fullwidth, itemindent=\parindent, listparindent=\parindent, leftmargin=\parindent}

\setitemize{fullwidth, itemindent=\parindent, listparindent=\parindent}

Продолжаю разбираться с нумерацией длинных таблиц, титульным листом, шрифтами и штампом...

[Scripach]

Спасибо за рецепт. Разрабатывал с помощью eskdx одну "Методику ...". Проблему с перечнями заметил, но она не была для меня критичной, поэтому сам решение не искал. Буду рад, если вы будете выкладывать свои решения проблем с eskdx.
Сам я в Lyx не работаю, поэтому проблем именно связки eskdx+Lyx не знаю.

-- 11.12.2013, 21:25 --

Спасибо за рецепт. Разрабатывал с помощью eskdx одну "Методику ...". Проблему с перечнями заметил, но она не была для меня критичной, поэтому сам решение не искал. Буду рад, если вы будете выкладывать свои решения проблем с eskdx.
Сам я в Lyx не работаю, поэтому проблем именно связки eskdx+Lyx не знаю.

[tonyk_av]

Продолжаем "дотачивать" eskdx.

Оформление оглавления. Цель: раздел жирным шрифтом с заполнением пробела точками, подраздел весь обычным шрифтом. Ну и отступы привести в соответствие с ГОСТ 2.105. По-моему, будет и красиво, и по ГОСТ.

Пробую так:

% Настраиваем шрифт разделов в оглавлении
\makeatletter
\renewcommand{\l@section}{\bfseries \@dottedtocline{1}{0em}{1.5em}}
\renewcommand{\l@subsection}{\normalfont \@dottedtocline{2}{0em}{2.5em}}
\makeatother

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

[tonyk_av]

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

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

Писать шаблон для LyX не стал. Намного проще в преамбуле задать поля для eskdx и всё. Хотя зрелищности результатам моих копаний написание такого шаблона добавило бы наверняка.

Результат:
- "выпрямлены" все шрифты в документе (мне не понравился курсив в штампе);
- исправлено оформление нумерованных и ненумерованных перечислений;
- разобрался, как настраивать оформление титульного листа.

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

Очень жаль, что никто не подсказал про настройку оглавления...

[Scripach]

tonyk_av
Не могли бы вы поделиться своим каркасом eskdx.lyx?

[tonyk_av]

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

Только подскажите мне, куда и как лучше выложить файл?

[Scripach]

tonyk_av в сообщении #808608 писал(а):

Могу, ибо чем больше людей будет пользоваться, тем быстрее будут прибиты баги.
Я выложу реальный документ, но с искажённым содержанием. Есть нюансы, которые необходимо учитывать при наборе в Ликс, и проще показать их в реальном документе.
Только подскажите мне, куда и как лучше выложить файл?

Подойдет любое облако: yandex.disk, dropbox и т.п. Можно даже на GitHub выложить.

[tonyk_av]

Вот ссылка:

http://my-files.ru/n8lyh

Всех заинтересованных прошу высказывать конструктивные замечания и предложения!
А именно:

а) выкладываем код для улучшения внешнего вида (например, "обжирнение" названий разделов и соответствующих им номеров страниц) не противоречащий ГОСТ 2.105;

б) если вы видите отклонение в оформлении документа от ГОСТ 2.105, то указывайте пункт и, желательно, цитату из пункта ГОСТ, который, по-вашему, нарушен.

Я старался все изменения сделать в преамбуле документа, чтобы не трогать исходную библиотеку eskdx. Как-то у меня не поднимается рука трогать такой монументальный труд...

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

[EtCetera]

Ваш файлик требует при открытии некий layout file под названием eskdtextnew.

[tonyk_av]

Цитата:

Ваш файлик требует при открытии некий layout file под названием eskdtextnew.

Верно! Забыл, что для LyX нужно добавить шаблон, который можно найти здесь:

http://habrahabr.ru/post/116517/

[EtCetera]

У меня при попытке сборки выдается такая ошибка: LaTeX Error: \ESKDfontIVsize undefined. Если строчку с \ESKDfontIVsize закомментировать, то все собирается.
По поводу нарушений (далеко не все со ссылками, мое мнение помечено [IMHO]):

• разделы лучше начинать с новой страницы (4.1.10);
• [IMHO]между номером (под)раздела/(под)пункта и его заголовком ставится обычный пробел (как это сделано у Вас для приложений в содержании);
• [IMHO]сильно сомневаюсь насчет разного кегля для заголовков (под)разделов и (под)пунктов и такого выравнивания текста заголовков;
• расстояния между заголовками, а также между заголовком и текстом несколько странные (4.1.9, Приложение А);
• [IMHO]у таблиц между номером и заголовком должно располагаться тире, а не короткое тире; оно же должно фигурировать в пустых ячейках таблицы (4.4.18) и между словом "Примечание" и текстом примечания (4.2.21); в целом, Вы и в тексте, как мне кажется, злоупотребляете короткими тире (ставите их и на месте длинных тире, и на месте дефисов);
• [IMHO]перед заголовком таблицы и после последней ее строки следует отбивать лишний интервал;
• подзаголовки графы в таблице 1.3 должны начинаться со строчной буквы в данном случае (4.4.4), кроме того, они не согласованы с ее заголовком;
• очень подозрительно выглядят таблицы 1.4 (объединенные графы) и 1.6 (многострочные ячейки), п. 4.4.12 стандарта позволяет объединять только ячейки с одинаковыми числовыми значениями величин;
• [IMHO]в таблице 2.1 неправильно оформлено примечание, перед ним не должно быть горизонтальной линии (4.2.21, рисунок 17).

[tonyk_av]

Цитата:

LaTeX Error: \ESKDfontIVsize undefined

Хм, было дело, добавлял в

eskdfont.sty

определение этого шрифта, чтобы влезло название компании в штампе, но сейчас он там закоментарен и добавлен в преамбулу. Проверю.

Цитата:

[IMHO]между номером (под)раздела/(под)пункта и его заголовком ставится обычный пробел (как это сделано у Вас для приложений в содержании);
[IMHO]сильно сомневаюсь насчет разного кегля для заголовков (под)разделов и (под)пунктов и такого выравнивания текста заголовков;

Так сделано в eskdx. ГОСТу не протеворечит.

Цитата:

расстояния между заголовками, а также между заголовком и текстом несколько странные (4.1.9, Приложение А);

"4.1.9 ....Расстояние между заголовком и текстом при выполнении документа машинописным способом должно быть равно 3, 4 интервалам".
А вот насчёт картинки из приложения А вы правы! Но тогда она не соответствует 4.1.9, правда? Чему верить?

Цитата:

[IMHO]у таблиц между номером и заголовком должно располагаться тире, а не короткое тире;

Так делает eskdx. А где в ГОСТ указываются параметры для дефиса, тире и длинного тире? Если ошибся автор eskdx, то давайте исправим ошибку. Только дайте ссылку на ГОСТ, который нарушен автором.

Цитата:

в целом, Вы и в тексте, как мне кажется, злоупотребляете короткими тире (ставите их и на месте длинных тире, и на месте дефисов);

Очень может быть, что с точки зрения норм русской типографии я допускаю неверное употребление короткого и длинного тире. Но покажите ГОСТ, в котором даны требования когда и в каких случаях употребляют дефис, тире и длинное тире, и, главное, где указаны требования к изображению этих сущностей.

Цитата:

подзаголовки графы в таблице 1.3 должны начинаться со строчной буквы в данном случае (4.4.4)

Верно! Моя ошибка! И нормоконтроль не заметил...

Цитата:

кроме того, они не согласованы с ее заголовком;

Тоже верно замечено!

Цитата:

очень подозрительно выглядят таблицы 1.4 (объединенные графы) и 1.6 (многострочные ячейки), п. 4.4.12 стандарта позволяет объединять только ячейки с одинаковыми числовыми значениями величин;

Не вижу ничего подозрительного: "4.4.12... Числовые значения величинЧисловые значения величин, одинаковые для нескольких строк, допускается указывать один раз в соответствии с рисунками 4 и 6". А когда не число, а текст, то почему нельзя?

Цитата:

в таблице 2.1 неправильно оформлено примечание, перед ним не должно быть горизонтальной линии (4.2.21, рисунок 17)

Смотрим, дивимся:

http://www.gosthelp.ru/gost/gost5378.html
http://vsegost.com/Catalog/53/5378.shtml

Чему верить? Перед вами официальное печатное издание? Тогда выложите, пожалуйста, скан этой страницы, буду знать. Мне нормоконтролёр показывала именно тот вариант, что сделан у меня. Хотя, абзацного отступа перед словом "Примечание" я не сделал...

Очень признателен EtCetera за комментарии! Меня, как и многих других читающих это, зае..л наш российский ГОСТ 2.105 и нормоконтроллёры! Вот пиндосы взяли и сделали AMS-классы, чтобы народ не беспокоился о правильности оформления статей,а думал о смысле написанного. Понимаю, что отсутствие ряда явных требований, а посему вольность трактовки и личные представления о прекрасном каждого конкретного нормоконтролёра, позволяют докопаться до любого документа, но всё же хочется иметь инструмент для удовлетворения хотя бы 95 % этих упырей.

Мои ответы уважаемому EtCetera преследуют цель проверить результаты работы eskdx с помощью таких опытных людей как он, проверить свою работу и себя в общении с нормоконтролёрами.

Смотрите, проверяйте, пишите!

[Scripach]

1. Не понял почему у Вас некоторые подразделы (например 1.1) вообще не имеют нумерованных пунктов (4.1.4).
2. В некоторых подразделах сначала идет не нумерованный пункт, а потом нумерованные (подраздел 1.7 и другие). (4.1.3 и прил. А)

[EtCetera]

tonyk_av в сообщении #812141 писал(а):

А вот насчёт картинки из приложения А вы правы! Но тогда она не соответствует 4.1.9, правда?

Почему не соответствует?

tonyk_av в сообщении #812141 писал(а):

Но покажите ГОСТ, в котором даны требования когда и в каких случаях употребляют дефис, тире и длинное тире, и, главное, где указаны требования к изображению этих сущностей.

Я такого ГОСТа не знаю. Дефис (в $\LaTeX$е -) и длинное тире (---) используются в соответствии с правилами пунктуации. Короткое тире (--) занимает полумаргинальное положение и используется при оформлении двойных фамилий (Бойля--Мариотта, но Гей-Люссака $\text{---}$ это составная фамилия) и интервалов численных значений (1818--1881). Можете поискать поиском по форуму, это здесь уже обсуждалось.

tonyk_av в сообщении #812141 писал(а):

А когда не число, а текст, то почему нельзя?

Раз про "не число" ничего не сказано, значит нельзя.
А что насчет таблицы 1.4, где Вы объединили две заголовка граф в один, оставив при этом два столбца?

tonyk_av в сообщении #812141 писал(а):

Смотрим, дивимся:

http://www.gosthelp.ru/gost/gost5378.html

http://vsegost.com/Catalog/53/5378.shtml


Чему верить?

Да, странно. Будем считать это ошибкой сканирования.