Обсуждение:Дискретная математика и алгоритмы — различия между версиями
Rybak (обсуждение | вклад) (→Викификация) |
Rybak (обсуждение | вклад) (→TeX) |
||
| Строка 32: | Строка 32: | ||
== TeX == | == TeX == | ||
* Вот тут [http://en.wikipedia.org/wiki/Help:Displaying_a_formula хорошая справка по использованию TeX] | * Вот тут [http://en.wikipedia.org/wiki/Help:Displaying_a_formula хорошая справка по использованию TeX] | ||
| − | * Использование тега <nowiki><tex></nowiki> вместо <nowiki><math></nowiki> обязательно. | + | * Использование тега <nowiki><tex></nowiki> вместо <nowiki><math></nowiki> обязательно. Везде. |
* Если лень постоянно писать <nowiki> <tex> </tex> </nowiki> , можно обернуть всю статью в <nowiki> <wikitex> </wikitex> </nowiki>, а потом обособлять формулы в $ $(например, <nowiki> <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> </nowiki>). | * Если лень постоянно писать <nowiki> <tex> </tex> </nowiki> , можно обернуть всю статью в <nowiki> <wikitex> </wikitex> </nowiki>, а потом обособлять формулы в $ $(например, <nowiki> <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> </nowiki>). | ||
* Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <nowiki> <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex> </nowiki> | * Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <nowiki> <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex> </nowiki> | ||
Версия 23:36, 25 февраля 2012
Требования к написанию вики-конспектов 1 курса.
Главное
- Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи.
- Перед отправкой на проверку перечитайте эти требования.
- В конспекте не должно быть недочетов, связанных с требованиями.
Общение с редакторами
- Будет лучше, если вы зарегистрируетесь на сайте вики-конспектов и напишете в информации о себе имя, фамилию и группу.
- Не забывайте сообщать редакторам о том, что конспект нужно проверить.
- При общении с редактором, представляйтесь и давайте ссылку на конспект, который вы пишете. В теме письма указывайте “Вики-конспекты: Название вики-конспекта”.
- Ставить замечания к конспекту может не только ваш редактор, в том числе и после принятия конспекта. Их тоже надо учитывать.
Викификация
- Смотрите в качестве примера на конспекты, которые отмечены как хорошие.
- В конспекте не должно быть орфографических, пунктуационных, речевых, фактических, логических и других ошибок. Используйте spell checker.
- Используйте вики-шаблоны Шаблон: Определение, Шаблон: Теорема, Шаблон: Лемма, Шаблон: Утверждение (Справка по шаблонам).
- Приводите английские названия терминов, теорем, имен алгоритмов и т.д. Их лучше писать в скобках курсивом после их русских названий.
- Вместо черточки “-” используйте тире “—”. Для этого можно использовать Шаблон:---. Про правила использования читать здесь
- Редактировать можно не только свои конспекты — используйте “концепцию вики”
- Не используйте тег <br> . Для перевода строки в вики надо вставлять пустую строку. Видимо, единственное место, где можно использовать его — внутри шаблонов — там переводы строки почему-то не работают.
- Ставьте категорию [[Категория: Дискретная математика и алгоритмы]] и подкатегорию с названием подтемы (например, [[Категория: Динамическое программирование]]). Список подкатегорий тут.
- Оформляйте ссылки на источники правильно.
Картинки
- Картинки, где только возможно, надо делать в векторе.
Источники
- Используйте ссылки на другие конспекты.
- В конспекте должны быть указаны источники или литература. Причем указывать ссылки не просто на википедию, а на конкретную статью(как Википедия - Экспоненциальная запись, на английскую — как Wikipedia - Scientific notation). Для книг достаточно указать автора, название, издание и номер страницы.
TeX
- Вот тут хорошая справка по использованию TeX
- Использование тега <tex> вместо <math> обязательно. Везде.
- Если лень постоянно писать <tex> </tex> , можно обернуть всю статью в <wikitex> </wikitex> , а потом обособлять формулы в $ $(например, <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> ).
- Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex>
- В качестве знака умножения нужно использовать
\timesили\cdot, а не звездочку. Сравните: . - Не опускайте знак умножения, если это может привести к неоднозначности.
Псевдокод
(правила, в основном, отсюда Участник: Kirelagin/Оформление#Псевдокод)
- Используйте максимально компактный и читаемый псевдокод.
- Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Python-style)
- Не ставьте круглые скобки вокруг внешнего условия if'а, while'а и т.п.
- Обозначайте присвоение нормально, с помощью знака «=», а сравнение как «==» (всё равно придётся слезать с паскаля).
- Не вводите какие-то левые операторы. Например, если кладёте что-то в очередь, так и напишите: q.push(a).
- TeX в псевдокоде можно использовать только в случае какого-то нестандартного оператора(а перед этим хорошо подумать и посмотреть предыдущий пункт)
- Не надо описывать ввод данных и вывод данных. Оформляйте псевдокод как функцию, принимающую входные данные и возвращающую результат.
- Обычные правила хорошего кода:
- Ставим пробелы между операндами и бинарными операторами(«1 + 2», а не «1+2»). После унарных операторов перед операндом пробел ставить не нужно.
- Не ставим пробел перед скобкой - вызовом функции(«f(x)», а не «f (x)»)
- Пробел после запятой, разделяющей аргументы функции
- Используем какой-то определённый стиль именования переменных(я бы рекомендовал lowerCamelCase для переменных и функций и UpperCamelCase для классов)
