Rst (ReStructuredText) символы 'и подчеркивания' эффект - PullRequest
Новая
       3

Rst (ReStructuredText) символы 'и подчеркивания' эффект

1 голос
/ 22 февраля 2012

Я пытаюсь использовать rst для документации, но я не могу найти хорошую и определенную ссылку. Каков порядок символов для подчеркивания и наложения в порядке размера шрифта (по возрастанию / убыванию)? Я прочитал статью в Википедии, в которой упоминается 

Header
======

Sub-header
----------

Но когда я пытаюсь сделать это в первом онлайн-редакторе (я не уверен, насколько это заслуживает доверия) и изменить порядок, размер шрифта (порядок заголовков) кажется, зависит от порядка, в котором эти заголовки приходят (т.е. первый получает <h1>, следующий получает <h2> и т. д.) независимо от используемых символов (- или =).

Кроме того, когда я использую их для наложения, они имеют разные размеры шрифта для шрифтов с подчеркиванием и с подчеркиванием и наложением (используя один и тот же символ, - или =). Другими словами, оверлайн также влияет на результат. Если используется другой символ, это также влияет на размеры шрифта. И чтобы увеличить путаницу, я видел использование таких символов, как * и #, и они тоже, кажется, влияют на размеры.

Но, попробовав со всеми из них, я все еще не могу сопоставить ни один из этих символов с определенным заголовком / размером шрифта. Я также не могу понять, какое влияние оказывает порядок их появления. И не забывать, как играет использование оверлайнов?

Ответы [ 2 ]

2 голосов
/ 23 февраля 2012

В reStructuredText (настоящим reST) есть 2 варианта разметки заголовка: 

with underline symbols
@@@@@@@@@@@@@@@@@@@@@@

и 

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
with both under and overline symbols
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Между ними нет предопределенного порядка, правило - первое вхождение - самый значимый заголовок, второй тип - второй значащий заголовок и т. Д.

Также, как вы и подозревали, то же самое относится и к каждому символу, который вы выбираете для подчеркивания или для подчеркивания.

Вы можете найти какое-то соглашение о том, какой символ использовать, но это более распространенный смысл, чем что-либо еще, поэтому следуйте тому, что лучше для вас работает.

0 голосов
/ 23 февраля 2012

Это не очень четкий ответ, но если у кого-то снова возникнут те же сомнения, я надеюсь, что это может быть полезно.

Кажется, что порядок важнее используемых символов. Мое наблюдение слишком странное, чтобы его можно было легко объяснить словами: первые два символа будут влиять на размер шрифта, т.е. первое вхождение дает наибольший размер текста (с надписью или без нее). 2-й символ будет иметь на один размер меньше (который равен первому символу при переключении над линией). при переключении надстрочного знака этого символа, дает размер текста, который будет равен первым символам (первое вхождение), то есть самым большим. После этих первых двух, следующие два символа дают уменьшающиеся размеры. После этого ни один символ не имеет никакого эффекта.

Позже я посмотрю код документации утилит python, который пояснит.

...