Оформление — различия между версиями
Admin (обсуждение | вклад) (Новая страница: «Для тех, кто будет в дальнейшем заниматься наполнением данной Wiki, предлагается ознакоми…») |
Admin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 3: | Строка 3: | ||
# Каждый текст разбивается на визуально удобно читабельные абзацы. | # Каждый текст разбивается на визуально удобно читабельные абзацы. | ||
##Если у текста есть первоисточник, то под каждым таким абзацем указывать аналогичный абзац первоисточника. | ##Если у текста есть первоисточник, то под каждым таким абзацем указывать аналогичный абзац первоисточника. | ||
| − | ###Думаю, теги <pre | + | ###Думаю, теги <code>pre</code> для выделения оригинала подойдут. |
| − | ###Для каждой статьи обязательно указывать ресурс-первоисточник. Это можно сделать единоразово, в конце страницы: два отступа («\n») от конца текста, разделительная черта (<h1>, но лучше 4 тире - черта в Wiki-разметке), текст «Источник: », домен, к которому прилагается точная ссылка. Пример. Источник: [https://c9x.me/compile/doc/il.html#Types c9x.me]. | + | ###Для каждой статьи обязательно указывать ресурс-первоисточник. Это можно сделать единоразово, в конце страницы: два отступа («\n») от конца текста, разделительная черта (<code>h1</code>, но лучше 4 тире - черта в Wiki-разметке), текст «Источник: », домен, к которому прилагается точная ссылка. Пример. Источник: [https://c9x.me/compile/doc/il.html#Types c9x.me]. |
##Разрешается создавать Wiki-структуры и использовать возможности HTML для оформления страниц. | ##Разрешается создавать Wiki-структуры и использовать возможности HTML для оформления страниц. | ||
| − | #В каждой статье, в случае, если применяются аббревиатуры, либо термины, к каждому такому термину в русскоязычном тексте/переводе указывать ссылку на сторонний ресурс ([ссылка Термин]) или на уже существующую на нашей Wiki статью ([[Термин]] или, если термин склоняется, [[СтатьяНаWiki | Термин]]). | + | #В каждой статье, в случае, если применяются аббревиатуры, либо термины, к каждому такому термину в русскоязычном тексте/переводе указывать ссылку на сторонний ресурс ([ссылка Термин]) или на уже существующую на нашей Wiki статью (<pre>[[Термин]]</pre> или, если термин склоняется, <pre>[[СтатьяНаWiki | Термин]]</pre>). |
#Код оформляется двумя способами. | #Код оформляется двумя способами. | ||
| − | ##Если строка используется в где-то в тексте, то её нужно выделить либо тегами <code></code>, либо <b></b> = <strong></strong> | + | ##Если строка используется в где-то в тексте, то её нужно выделить либо тегами <pre><code></code></pre>, либо <pre><b></b></pre> = <pre><strong></strong></pre> |
##Если код приводится после текста/абзаца, то каждая строка к каждой строке с кодом добавляем пробел в ее начало. Это выделит код в блок. | ##Если код приводится после текста/абзаца, то каждая строка к каждой строке с кодом добавляем пробел в ее начало. Это выделит код в блок. | ||
| − | ###Если в тексте есть указание на какой-то конкретный пример кода, который уже был приведен, либо только будет приведен, желательно, первую строку в п. 3.2. начать с <strong>Пример.<strong> | + | ###Если в тексте есть указание на какой-то конкретный пример кода, который уже был приведен, либо только будет приведен, желательно, первую строку в п. 3.2. начать с <pre><strong>Пример.<strong></pre> |
| − | ###Если в тексте присутствует не один пример, а несколько, то каждый блок кода, являющийся примером, должен начинаться с <strong>Пример НомерПримера.</strong> | + | ###Если в тексте присутствует не один пример, а несколько, то каждый блок кода, являющийся примером, должен начинаться с <pre><strong>Пример НомерПримера.</strong></pre> |
| − | ##Комментарии в блоках кода для удобства чтения будем указывать по принципу QBE (у Python так же) - через символ решетки. То есть, например, %a = w add 0,1 # Кладем 1 в переменную а. | + | ##Комментарии в блоках кода для удобства чтения будем указывать по принципу QBE (у Python так же) - через символ решетки. То есть, например, </code>%a = w add 0,1 # Кладем 1 в переменную а</code>. |
| − | #В массивных текстах, в которых возможно логическое разделение на главы, лучше это практиковать. В Wiki-разметке первый уровень выделяется в два знака равно, второй в три знака равно, третий - в четыре, и тд. Пример: == Глава 1 ==, === Раздел 1 (первой главы) === | + | #В массивных текстах, в которых возможно логическое разделение на главы, лучше это практиковать. В Wiki-разметке первый уровень выделяется в два знака равно, второй в три знака равно, третий - в четыре, и тд. Пример: <pre>== Глава 1 ==, === Раздел 1 (первой главы) ===</pre> |
#В случае возникновения проблем с переводом, либо при отсутствии возможности однозначной трактовки, обязательно указывать через слэш, либо в круглых скобках вторую возможную трактовку/комментарий/примечание. | #В случае возникновения проблем с переводом, либо при отсутствии возможности однозначной трактовки, обязательно указывать через слэш, либо в круглых скобках вторую возможную трактовку/комментарий/примечание. | ||
Текущая версия на 16:36, 5 апреля 2018
Для тех, кто будет в дальнейшем заниматься наполнением данной Wiki, предлагается ознакомиться с общими для всех подобных статей и вещей и использовать следующую структуру.
- Каждый текст разбивается на визуально удобно читабельные абзацы.
- Если у текста есть первоисточник, то под каждым таким абзацем указывать аналогичный абзац первоисточника.
- Думаю, теги
preдля выделения оригинала подойдут. - Для каждой статьи обязательно указывать ресурс-первоисточник. Это можно сделать единоразово, в конце страницы: два отступа («\n») от конца текста, разделительная черта (
h1, но лучше 4 тире - черта в Wiki-разметке), текст «Источник: », домен, к которому прилагается точная ссылка. Пример. Источник: c9x.me.
- Думаю, теги
- Разрешается создавать Wiki-структуры и использовать возможности HTML для оформления страниц.
- Если у текста есть первоисточник, то под каждым таким абзацем указывать аналогичный абзац первоисточника.
- В каждой статье, в случае, если применяются аббревиатуры, либо термины, к каждому такому термину в русскоязычном тексте/переводе указывать ссылку на сторонний ресурс ([ссылка Термин]) или на уже существующую на нашей Wiki статью (
[[Термин]]
или, если термин склоняется,[[СтатьяНаWiki | Термин]]
). - Код оформляется двумя способами.
- Если строка используется в где-то в тексте, то её нужно выделить либо тегами
<code></code>
, либо<b></b>
=<strong></strong>
- Если код приводится после текста/абзаца, то каждая строка к каждой строке с кодом добавляем пробел в ее начало. Это выделит код в блок.
- Если в тексте есть указание на какой-то конкретный пример кода, который уже был приведен, либо только будет приведен, желательно, первую строку в п. 3.2. начать с
<strong>Пример.<strong>
- Если в тексте присутствует не один пример, а несколько, то каждый блок кода, являющийся примером, должен начинаться с
<strong>Пример НомерПримера.</strong>
- Если в тексте есть указание на какой-то конкретный пример кода, который уже был приведен, либо только будет приведен, желательно, первую строку в п. 3.2. начать с
- Комментарии в блоках кода для удобства чтения будем указывать по принципу QBE (у Python так же) - через символ решетки. То есть, например, </code>%a = w add 0,1 # Кладем 1 в переменную а</code>.
- Если строка используется в где-то в тексте, то её нужно выделить либо тегами
- В массивных текстах, в которых возможно логическое разделение на главы, лучше это практиковать. В Wiki-разметке первый уровень выделяется в два знака равно, второй в три знака равно, третий - в четыре, и тд. Пример:
== Глава 1 ==, === Раздел 1 (первой главы) ===
- В случае возникновения проблем с переводом, либо при отсутствии возможности однозначной трактовки, обязательно указывать через слэш, либо в круглых скобках вторую возможную трактовку/комментарий/примечание.
