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