|
| 1 | +# Инструкции по интеграции статей в книгу |
| 2 | + |
| 3 | +Некоторые разделы нашей книги будут писаться на основе написанных нами ранее статей. |
| 4 | +При интеграции текста из статей в книгу может потребоваться его существенная доработка (унификация терминов и определений, изменение структуры под структуры разделов книги). |
| 5 | +Результирующий текст должен быть таким же целостным и корректным, как и текст в статье. |
| 6 | + |
| 7 | +1. Исходники статей хранятся в [papers_src](papers_src/) |
| 8 | + 1. Каждая верхнеуровневая поддиректория --- исходники одной статьи. |
| 9 | +2. Исходники статей могут быть как на русском, так и на английском. Для английских версий нужно выполнять перевод. |
| 10 | +3. Итоговый стиль изложения должен соответствовать стилю соответствующих частей в книге, а не исходному стилю статьи. |
| 11 | +4. Книга должна быть целостной, потому при интеграции необходимо следить за обозначениями, терминами, определениями. Иногда их придётся менять или корректировать. И соответствующим образом корректировать переносимый из статьи текст. |
| 12 | + |
| 13 | +## Правила работы с обозначениями, определениями, терминами |
| 14 | +1. Во всей книге используются общие определения и одни и те же обозначения и термины. |
| 15 | +2. Термины, их сокращения и переводы приведены в `glossary.md`. Используй их при переводе. также используй этот файл для унификации терминологии. |
| 16 | +3. Если термин или сокращение отсутствуют в `glossary.md`, то уточни у меня через "Question tool". Я скажу, как правильно добавить в `glossary.md` |
| 17 | +4. Всегда используй обозначения, принятые в книге. Например, если в книге граф обозначается `G` а в статье `\mathcal{G}`, то используй `G`. |
| 18 | +5. В статье могут вводиться определения. В книге разрешено использовать только те определения, которые есть в ней. Потому: |
| 19 | + 1. Сперва найди в книге эквивалентное определение. Если оно есть, то используй его. |
| 20 | + 2. Если эквивалентного нет, но есть близкое, использование которого не искажает содержание переносимого текста, то используй его. Не забудь соответствующим образом изменить переносимый текст. От деталей определения могут зависеть многие разделы статьи. |
| 21 | + 3. Если кажется, что в интегрируемой статье даётся новое определение (предыдущие два пункта не сработали), то уточни у меня через "Question tool", что делать. |
| 22 | + |
| 23 | +## Правила работы со списком литературы |
| 24 | +1. Если в интегрируемой статье была ссылка на какой-либо источник, то делай следующее |
| 25 | + 1. Проверь, что в библиографии книги нет такого же источника (проверяй не только ключ библиографической записи, но и содержимое) |
| 26 | + 2. Если такой источник уже есть, то при переносе сошлись на него. |
| 27 | + 3. Если источника точно нет, то добавь нужную запись из библиографии статьи в библиографию книги. |
| 28 | + 4. Если в библиографии книги есть очень похожая (но не идентичная) запись (например, ключи различаются, но содержимое совпадает или совпадают название и авторы, но немного различаются остальные поля), то уточни у меня через "Question tool". |
| 29 | +2. Некоторые библиографические записи могут быть представлены в переведённом виде (например, переведено название статьи или журнала). |
| 30 | + 1. Если одна запись является в точности переводом другой, то используем запись на том языке, на котором написана работа, которую идентифицирует эта запись. |
| 31 | + 2. Иначе уточни у меня через "Question tool". |
| 32 | + |
| 33 | +## Правила работы с вёрсткой |
| 34 | +1. При переносе используй правила вёрстки, принятые в книге. |
| 35 | +2. Убедись, что все необходимые tex-пакеты уже есть в книге. |
| 36 | + 1. Если нет в точности такого же, то проверь, нет ли аналогичного, на который легко перейти. Если есть, используй его. Доработай переносимы текст там, где это необходимо. |
| 37 | + 2. Если не удалось найти аналог, то добавь необходимый пакет в соответствующий файл в `styles/`. |
| 38 | +3. В некоторых работах есть свои стилевые настройки для уже существующих в книге пакетов или вспомогательные команды или макросы. Перенеси их в соответствущие файлы в `styles/`. |
| 39 | + 1. Убедись, что новые настройки не будут конфликтовать с имеющимися. Если конфликтуют, уточни у меня через "Question tool", что делать. |
| 40 | + |
| 41 | +## Правила перевода |
| 42 | +1. При переводе терминов используй `glossary.md`. Если в нём нет перевода, обязательно уточни у меня перевод через "Question tool". |
| 43 | +2. Не переводи названия статей, авторов, журналы, названия конференций. |
| 44 | +3. Будь внимателен к языку. Язык книги --- русский строгий (научная монография). Соответственно, не должно быть жаргона, разговорной речи и так далее. |
| 45 | + |
| 46 | +## Правила переноса содержимого |
| 47 | +1. Как правило, в статье будет описан алгоритм, который нужно перенести в книгу. В книге будет раздел для этого алгоритма. Туда должно попасть описание этого алгоритма, примеры его работы, формулировка и доказательство свойств алгоритма. |
| 48 | +2. В статье могут быть эксперименты. Они интегрируются в связанный раздел о сравнении алгоритмов (в книге он общий на серию алгоритмов) |
| 49 | +3. В статье есть введение, обзор, обсуждение связанных исследований (related work). Информация оттуда, связанная непосредственно с алгоритмом (например, мотивация для его разработки) интегрируется во вводную часть раздела с алгоритмом. Остальная информация интегрируется во вводную часть главы, в которой находится раздел с алгоритмом. |
| 50 | +4. Не забудь перенести изображения. Если статья была на английском, то отметь изображение `\mytodo` о том, что его надо перевести. |
| 51 | +5. Обязательно коротко записывай в `book_structure.md`, какие части какой статьи в какие части книги попали. |
0 commit comments