LINUX.ORG.RU

Есть ли стандарт оформления исходного кода LaTeX?

 


0

5

Короче, есть ли аналог питоновского PEP8, только для LaTeX? А то когда над книгой работают одновременно 20 человек (да еще и 19 из них без малейшей культуры написания кода) картина плачевная...

★★★★★

Тебе для кода или для текста?

Для текста Alt+q в emacs хватает, а для кода 20 человек — что не верится. Есть правила для оформления пакетов в стиле «Грамотного программирования».

Итоговую вёрсткуи всё равно делать будет один человек — он всё и поправит по своему вкусу. Только жадничать на это времени не надо — 10% от написания текстов времени положить для красивого результата при любом раскладе придётся.

Evgueni ★★★★★
()
Последнее исправление: Evgueni (всего исправлений: 1)

Ну так и PEP8 в питоне не священен, а всего лишь рекомендация по стилю для стандартной библиотеки. Придумай сам разумный стиль и внедряй его! :)

Если серьезно, то, как мне кажется, важнее всего заставить использовать \ref и \cite, ибо это сэкономит кучу времени потом. Всё равно такую ораву заставить следовать жесткому стилю кода точно не получится.

lu4nik ★★★
()
Ответ на: комментарий от Evgueni

Итоговую верстку я и делаю. Недавно вот пришлось в ограниченный срок перелопатить всю книгу.

Я имею в виду не сам вид печатного текста, там с оформлением все хорошо. Используем написанные отдельно стилевые файлы и оформляем все в нормальные окружения. Я о самих исходниках книги. Там черт ногу сломит. Мне недавно пришлось исправить за 2 дня около 11000 ошибок (ну ладно, это я загнул, там некоторые ошибки единичные порождали 100-200 ошибок LaTeX'а) и я плакал, читая исходники.

Думал, может есть уже написанный кем-то свод рекомендаций по оформлению кода в LaTeX, который можно скинуть коллегам и попросить придерживаться.

aquadon ★★★★★
() автор топика
Ответ на: комментарий от lu4nik

Не, у нас не так все плохо. \ref и \cite все используют, метки везде проставлены.

Плохо все в коде, его очень сложно читать. А еще там полно всякого легаси.

aquadon ★★★★★
() автор топика
Ответ на: комментарий от aquadon

когда над книгой работают одновременно 20 человек (да еще и 19 из них без малейшей культуры написания кода)

При чем тут LyX?

Делаешь единый для всех шаблон класса документа, а LyX используешь как инструмент контроля соблюдения «культуры», т.е. соблюдения семантической структуры вашей нетленки.

Как бонус — каждый из двадцати твоих писателей в любой произвольный момент времени сможет посмотреть, какую красоту он наваял. Да и частичная визуализация будет значительно удобнее для неисскушённого писателя.

А ты на выходе получаешь гарантированно-валидный LaTeX-документ, ибо за валидностью будет следить LyX. А генерируемые им LaTeX-документы ты уже сможешь допилить до нужной тебе кондиции.

anonymous
()
Ответ на: комментарий от aquadon

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

в конце-концов, если автоматической визуализации не хватает, нажал несколько клавиш, сгенерировал отформатированный .pdf и вычитал свою нетленку, а на выходе получаем валидный LaTeX-документ

а всякие там нормативные документы, циркуляры и предписания пиши для себя и для документации описания шаблонов

anonymous
()

Присоединяюсь к вопросу

«Разумный стиль» и «свой вкус» нужно сначала выработать и сформулировать, что требует нелишнего времени.

Evenik ★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.