| 1 | = Поддержка reStructuredText в Trac = |
| 2 | |
| 3 | En-Version: WikiRestructuredText |
| 4 | |
| 5 | |
| 6 | Trac поддерживает ''reStructuredText'' (RST) как альтернативу wiki-разметки в любом контексте, использующем [wiki:WikiFormatting wiki-форматирование]. |
| 7 | |
| 8 | С web сайта reStucturedText: |
| 9 | "''reStructuredText — это easy-to-read (легкочитаемый), what-you-see-is-what-you-get (что-вы-видите-то-и-получите) plaintext ("плоскотекстовый") синтаксис разметки и парсер-система. Полезен для встроенного в код документирования (как Python docstrings), для быстрого создания простых web страниц и других документов. reStructuredText разработан для расширения specific application domains (?специфичных предметных областей?).''" |
| 10 | |
| 11 | === Требования === |
| 12 | Заметьте, что для активации RST поддержки в Trac, должен быть установлен пакет Python docutils. |
| 13 | Если еще не доступен в вашей операционной системе, можете загрузить его с [http://docutils.sourceforge.net/rst.html RST Web сайта]. |
| 14 | |
| 15 | === Дополнительная информация по RST === |
| 16 | |
| 17 | * reStructuredText Website -- http://docutils.sourceforge.net/rst.html |
| 18 | * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html |
| 19 | |
| 20 | ---- |
| 21 | |
| 22 | == Исопльзование RST в Trac == |
| 23 | Чтобы задать блок текста, полежащего обработке с использованием RST парсера, используйте ''rst'' процессор. |
| 24 | |
| 25 | === [wiki:TracLinks Trac-ссылки] в reStructuredText === |
| 26 | |
| 27 | * Trac обеспечивает специальную директиву 'trac', чтобы разрешить [wiki:TracLinks Trac-ссылки] внутри RST-текста. |
| 28 | |
| 29 | Пример: |
| 30 | {{{ |
| 31 | {{{ |
| 32 | #!rst |
| 33 | Это ссылка на |a тикет| |
| 34 | |
| 35 | .. |a тикет| trac:: #42 |
| 36 | }}} |
| 37 | }}} |
| 38 | Для полного примера всех использований ''trac''-директивы, пожалуйста смотрите WikiRestructuredTextLinks. |
| 39 | |
| 40 | * Trac допускает более простой путь создания [wiki:TracLinks Trac-ссылок] в RST, используя специальную схему именования ссылок '':trac:''. |
| 41 | |
| 42 | Пример: |
| 43 | {{{ |
| 44 | {{{ |
| 45 | #!rst |
| 46 | Это ссылка на тикет `#12`:trac: |
| 47 | |
| 48 | Чтобы узнать, как использовать Trac, смотрите `TracGuide`:trac: |
| 49 | }}} |
| 50 | }}} |
| 51 | |
| 52 | === Подсветка синтаксиса в reStructuredText === |
| 53 | |
| 54 | Также есть директива для задания TracSyntaxColoring в ReST. Вызов директивы: |
| 55 | code-block |
| 56 | |
| 57 | Пример |
| 58 | |
| 59 | {{{ |
| 60 | {{{ |
| 61 | #!rst |
| 62 | |
| 63 | .. code-block:: python |
| 64 | |
| 65 | class Test: |
| 66 | |
| 67 | def TestFunction(self): |
| 68 | pass |
| 69 | |
| 70 | }}} |
| 71 | }}} |
| 72 | |
| 73 | Результат ниже. |
| 74 | |
| 75 | {{{ |
| 76 | #!rst |
| 77 | |
| 78 | .. code-block:: python |
| 79 | |
| 80 | class Test: |
| 81 | |
| 82 | def TestFunction(self): |
| 83 | pass |
| 84 | |
| 85 | }}} |
| 86 | |
| 87 | === Wiki макросы в reStructuredText === |
| 88 | |
| 89 | Для включения [WikiMacros Wiki макросов] в ReST вы должны использовать ту же директиву, что и для подсветки синтаксиса, т.е. code-block. To work you must use a version of trac that has #801 applied (Не понял, что имеется в виду и как перевести — прим. переводч.). |
| 90 | |
| 91 | === Wiki макрос пример === |
| 92 | |
| 93 | {{{ |
| 94 | {{{ |
| 95 | #!rst |
| 96 | |
| 97 | .. code-block:: RecentChanges |
| 98 | |
| 99 | Trac,3 |
| 100 | |
| 101 | }}} |
| 102 | }}} |
| 103 | |
| 104 | Результат ниже: |
| 105 | |
| 106 | [[RecentChanges(Trac,3)]] |
| 107 | |
| 108 | Или еще более краткий синтаксис, подобный Wiki macro: |
| 109 | |
| 110 | {{{ |
| 111 | {{{ |
| 112 | #!rst |
| 113 | |
| 114 | :code-block:`RecentChanges:Trac,3` |
| 115 | }}} |
| 116 | }}} |
| 117 | |
| 118 | === Большой ReST пример === |
| 119 | Пример ниже по большей части не требует дополнительных разъяснений: |
| 120 | {{{ |
| 121 | #!html |
| 122 | <pre class="wiki">{{{ |
| 123 | #!rst |
| 124 | FooBar Header |
| 125 | ============= |
| 126 | reStructuredText is **nice**. It has its own webpage_. |
| 127 | |
| 128 | A table: |
| 129 | |
| 130 | ===== ===== ====== |
| 131 | Inputs Output |
| 132 | ------------ ------ |
| 133 | A B A or B |
| 134 | ===== ===== ====== |
| 135 | False False False |
| 136 | True False True |
| 137 | False True True |
| 138 | True True True |
| 139 | ===== ===== ====== |
| 140 | |
| 141 | RST TracLinks |
| 142 | ------------- |
| 143 | |
| 144 | See also ticket `#42`:trac:. |
| 145 | |
| 146 | .. _webpage: http://docutils.sourceforge.net/rst.html |
| 147 | }}}</pre> |
| 148 | }}} |
| 149 | |
| 150 | |
| 151 | Результат: |
| 152 | {{{ |
| 153 | #!rst |
| 154 | FooBar Header |
| 155 | ============= |
| 156 | reStructuredText is **nice**. It has its own webpage_. |
| 157 | |
| 158 | A table: |
| 159 | |
| 160 | ===== ===== ====== |
| 161 | Inputs Output |
| 162 | ------------ ------ |
| 163 | A B A or B |
| 164 | ===== ===== ====== |
| 165 | False False False |
| 166 | True False True |
| 167 | False True True |
| 168 | True True True |
| 169 | ===== ===== ====== |
| 170 | |
| 171 | RST TracLinks |
| 172 | ------------- |
| 173 | |
| 174 | See also ticket `#42`:trac:. |
| 175 | |
| 176 | .. _webpage: http://docutils.sourceforge.net/rst.html |
| 177 | }}} |
| 178 | |
| 179 | |
| 180 | ---- |
| 181 | Смотрите также: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting |