Re[3]: К вопросу о форматтере
От: Centaur Россия  
Дата: 22.08.12 09:47
Оценка: 1 (1)
Здравствуйте, ShaggyOwl, Вы писали:

SO>1. Жирный, курсив, подчёркивание, зачёркивание, верхний и нижний индексы — только с помощью двойных символов **bold**, //italic// и т.д. Аргументация — одиночные символы время от времени встречаются в простом тексте и неочевидный результат форматирования обязательно будет сбивать с толку новичков. По выбранным символам комментариев нет.


Против. Нужно, чтобы одиночные символы в простом тексте не считались за маркеры форматирования.

Неформально, чтобы понять, может ли пара символов интерпретироваться как маркеры форматирования, нужно попробовать заменить их на скобки. Если при этом получается недопустимая по правилам типографики последовательность — значит, не может.

Примеры:
foo*bar — нет (отсутствует парность)
*foo* bar — (foo) bar — да
*foo *bar — (foo )bar — нет: у скобки не может быть пробела с внутренней стороны и не может быть буквы с внешней
foo* bar* — foo( bar — нет, по тем же причинам
foo*bar*baz — нет
foo*bar baz*quux — нет
foo *bar baz* quux — да
foo *bar*. — foo (bar). — да
*Foo bar.* Baz quux frob. — (Foo bar.) Baz quux frob. — да


Случаи, когда требуется выделить часть слова, считаю редкими и предлагаю обсудить отдельно на примерах. Сразу парочку контрпримеров, где выделение части слова не нужно:
* ударение: неправильно — напис/а/л; правильно — написа́л (и да, давайте сменим шрифт с Verdan’ы, пока не все ещё проапгрейдились)
* исправление орфографии: неправильно — «не к/а/рова, а к/о/рова», правильно — проигнорировать или написать в личку

SO>2. Заголовки. ИМХО, более интуитивно простыми будут восклицательные знаки, но против знаков равенства особых возражений нет. Отсутствие знаков с правой стороны от заголовка — большой плюс.


Я за == с игнорированием знаков справа.

SO>3. Списки. Важно добавить уровни


+1.

SO>4. Ссылки

SO>[[a link]]
SO>[[a link|with title]]
SO>Изображения сделать на основе ссылок (конкретное предложение будет чуть позже).

+1.

SO>5. Код и цитирование

SO>Какие альтернативы есть? Тут ошибиться в выборе нельзя, иначе потом будет мучительно больно.

Trac: (shebang-конвенция активно не нравится!)
{{{
#!php
…
}}}


bbcode-style: (да, считаю для фрагментов кода допустимым)
[[php]
[[/php]


старый Confluence:
{code=php}
{code}


новый Confluence: (слишком многословно)
{code:language=php}
{code}


Bruce Eckel–style: (Thinking in C++/Java)
//:
//#


Неудачные варианты: классический Markdown, классическая Ward’s Wiki (индентация).

А кроме того, я полагаю, что можно перенести синтаксическую раскраску на клиента: в HTML отдавать <pre><code class="language-php">, а клиентский скрипт пусть расставляет все span’ы.


Цитирование вещь неочевидная. Fido-style префиксы (FML>) хороши для гейтования в NNTP, но желателен алгоритм reflow при перецитировании. В идеале, должно быть можно взять сообщение, применить на него алгоритм цитирования (приклеивающий префикс FML> к оригинальным строкам и увеличивающий уровень вложенности в цитированных), затем вставить свои новые строки (возможно, с разметкой) в любом месте, и получившееся должно быть валидным сообщением. В частности, должен работать пример:

VP> {{{ c++
VP> #include <iostream>
VP> 
VP> void main()

В C++ функция {{main}} должна возвращать {{int}}.

VP> {
VP>     std::cout << "Hello World!\n";
VP> }
VP> }}}

Ожидаемое поведение:
<blockquote data-attribution="VP"><pre><code class="language-cpp">#include &lt;iostream&gt;

void main()</code></pre></blockquote>
<p>В C++ функция <code>main</code> должна возвращать <code>int</code>.
<blockquote data-attribution="VP"><pre><code class="language-cpp">{
    std::cout << "Hello World!\n";
}</code></pre></blockquote>
Re[8]: Синтаксис заголовков
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 09:58
Оценка:
Здравствуйте, dеnisko, Вы писали:

D>Насчет писанины зависит от того, как ты хочешь реализовывать. Если ползать чем-то типа saxа по тексту


Под писаниной я понимаю, что писать при наборе текста много. Никто не будет выписывать длинные теховские теги в форумном сообщении.

AVK>>Я пока склоняюсь к тому, чтобы разрешить только выделение болдом внутри кода.

D>А к переформатированию как относишься?

Вменяемый форматтер только для одного мейнстрим языка — это минимум человекомесяцы работы.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[3]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 10:17
Оценка:
Здравствуйте, ShaggyOwl, Вы писали:

SO>1. Жирный, курсив, подчёркивание, зачёркивание, верхний и нижний индексы — только с помощью двойных символов **bold**, //italic// и т.д. Аргументация — одиночные символы время от времени встречаются в простом тексте и неочевидный результат форматирования обязательно будет сбивать с толку новичков. По выбранным символам комментариев нет.


Видимо да, придется.

SO>3. Списки. Важно добавить уровни


Да, тут просто я не уверен на 100% пока в синтаксисе.

SO>4. Ссылки

SO>[[a link]]
SO>[[a link|with title]]

А чем предложенное не устраивает?

SO>Изображения сделать на основе ссылок (конкретное предложение будет чуть позже).


Вроде бы так и есть сейчас.

SO>5. Код и цитирование

SO>Какие альтернативы есть? Тут ошибиться в выборе нельзя, иначе потом будет мучительно больно.

Альтернатив не очень много. Помимо двойных и тройных {} я встречал 4-5 символов =, но это писать больше. В маркдауне используется grave accent, но у некоторых этот символ используется для переключения раскладки. Еще есть выделение кода 4 пробелами с начала строки, тут я вообще затрудняюсь оценить, насколько оно удобно. Ббшный [code][/code] тоже применяется, но он очень многословен. Остальные варианты довольно экзотичны, но если кто знает какой интересный вариант — можно обсудить.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 10:39
Оценка: 15 (1)
Добавил синтаксис для таблиц, учел некоторые пожелания. Ссылка та же — https://bitbucket.org/andrewvk/rsdn.format/wiki/Specification
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[4]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 10:46
Оценка:
Здравствуйте, Centaur, Вы писали:

C>А кроме того, я полагаю, что можно перенести синтаксическую раскраску на клиента: в HTML отдавать <pre><code class="language-php">, а клиентский скрипт пусть расставляет все span’ы.


Мысль, конечно, интересная, особенно интересная тем, что можно что нибудь готовое использовать, типа highlight.js. Но требования к клиенту, если мы раскраску хотим, существенно повышаются. И добавление нового языка будет несколько проблематично (nemerle, скажем, точно готового нет, а ведь захотят некоторые). С другой стороны, всегда ведь можно раскраску сразу в генераторе html прикрутить позже.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[4]: К вопросу о форматтере
От: ShaggyOwl Россия http://www.rsdn.org
Дата: 22.08.12 11:03
Оценка:
Здравствуйте, AndrewVK, Вы писали:
SO>>4. Ссылки
SO>>[[a link]]
SO>>[[a link|with title]]
AVK>А чем предложенное не устраивает?
О квадратных скобках.
http://www.wikicreole.org/wiki/LinksReasoning
Классическое решение для вики — ссылка в одинарных или двойных квадратных скобках.

О двойных квадратных скобках.
С учётом того, что на рсдн в обычном тексте вполне могут мелькать одинарные квадратные скобки (индексы в контейнерах, отрезки, диапазоны), то имеет смысл сделать двойные скобки. Двойные квадратные скобки тоже могут встречаться в обычном тексте, но предполагаю, существенно реже.

Оформление ссылок (внутренние и внешние):
http://www.wikimatrix.org/syntax.php?i=138
http://www.wikimatrix.org/syntax.php?i=139
Хорошо там, где мы есть! :)
Re[5]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 11:33
Оценка:
Здравствуйте, ShaggyOwl, Вы писали:

SO>Классическое решение для вики — ссылка в одинарных или двойных квадратных скобках.


Есть одна проблема — сиволов [|] нет в русской раскладке. Но чем их заменить у меня идей нет. Двойными или тройными обычными скобками?
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[6]: К вопросу о форматтере
От: dеnisko  
Дата: 22.08.12 12:33
Оценка:
Здравствуйте, AndrewVK, Вы писали:

AVK>Здравствуйте, ShaggyOwl, Вы писали:


SO>>Классическое решение для вики — ссылка в одинарных или двойных квадратных скобках.


AVK>Есть одна проблема — сиволов [|] нет в русской раскладке. Но чем их заменить у меня идей нет. Двойными или тройными обычными скобками?

Может, кавычками (если ты их не забил уже), а цитата частный случай ссылки?
Re[7]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 12:46
Оценка:
Здравствуйте, dеnisko, Вы писали:

AVK>>Есть одна проблема — сиволов [|] нет в русской раскладке. Но чем их заменить у меня идей нет. Двойными или тройными обычными скобками?

D>Может, кавычками (если ты их не забил уже)

Блочная цитата использует.

D>, а цитата частный случай ссылки?


Ничего общего вроде бы. Блочная цитата это то, что сейчас выделяется тегом [q]. А одинарные кавычки в русской раскладке отсутствуют.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 13:14
Оценка:
Еще такой вопрос — в некоторых форматтерах есть такая штука как плашки. Насколько оно нам нужно?
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[2]: К вопросу о форматтере
От: adontz Грузия http://adontz.wordpress.com/
Дата: 22.08.12 13:16
Оценка:
Здравствуйте, AndrewVK, Вы писали:

AVK>Еще такой вопрос — в некоторых форматтерах есть такая штука как плашки. Насколько оно нам нужно?


Что это вообще?
A journey of a thousand miles must begin with a single step © Lau Tsu
Re[3]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 13:33
Оценка:
Здравствуйте, adontz, Вы писали:

A>Что это вообще?


Шаблонное форматирование. Т.е. ты описываешь шаблон, без параметров или с каким то их количеством, и потом просто используешь его по имени с передачей значений параметров, если необходимо.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[4]: К вопросу о форматтере
От: adontz Грузия http://adontz.wordpress.com/
Дата: 22.08.12 13:37
Оценка:
Здравствуйте, AndrewVK, Вы писали:

A>>Что это вообще?

AVK>Шаблонное форматирование. Т.е. ты описываешь шаблон, без параметров или с каким то их количеством, и потом просто используешь его по имени с передачей значений параметров, если необходимо.

Макросы что ли? Ну, по идее, любое форматирование может рассматриваться как частный случай макроса.
A journey of a thousand miles must begin with a single step © Lau Tsu
Re[5]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 13:39
Оценка:
Здравствуйте, adontz, Вы писали:

A>Макросы что ли?


Можно и так сказать

A> Ну, по идее, любое форматирование может рассматриваться как частный случай макроса.


Тогда это метамакрос.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[6]: К вопросу о форматтере
От: ShaggyOwl Россия http://www.rsdn.org
Дата: 22.08.12 14:55
Оценка:
Здравствуйте, AndrewVK, Вы писали:

AVK>Есть одна проблема — сиволов [|] нет в русской раскладке. Но чем их заменить у меня идей нет. Двойными или тройными обычными скобками?


Мдямс. Об этом я как-то не подумал.
С другой стороны, насколько это необходимо? Ориентируясь на собственный опыт — раскладка меняется постоянно, десятки раз на дню: документы, комментарии, заметки и тексты, часть поисковых запросов пишутся на русском; адреса в браузере, код, команды в консоли, часть запросов в гугл — на английском, соответственно нажатие alt+shift уже отработано до автоматизма.
Хорошо там, где мы есть! :)
Re[2]: К вопросу о форматтере
От: ShaggyOwl Россия http://www.rsdn.org
Дата: 22.08.12 15:01
Оценка:
Здравствуйте, AndrewVK, Вы писали:

AVK>Еще такой вопрос — в некоторых форматтерах есть такая штука как плашки. Насколько оно нам нужно?

Пока неясно
Хорошо там, где мы есть! :)
Re[8]: К вопросу о форматтере
От: dеnisko  
Дата: 22.08.12 15:09
Оценка:
Здравствуйте, AndrewVK, Вы писали:

D>>, а цитата частный случай ссылки?


AVK>Ничего общего вроде бы. Блочная цитата это то, что сейчас выделяется тегом [q]. А одинарные кавычки в русской раскладке отсутствуют.

Ну любая цитата может рассматриваться как частный случай ссылки без указания источника (что в общем сейчас и происходит).
Т.е.

Как сказал Иван иваныч блаблабла

по сути дела означает

Как сказал Иван иваныч блаблабла [ссылка на то, где он это сказал]

Другое дело, что это не спасет нас от переключения раскладки, но поможет сэкономить один тэг / символ.
Re[2]: К вопросу о форматтере
От: Centaur Россия  
Дата: 22.08.12 15:36
Оценка: +1
Здравствуйте, AndrewVK, Вы писали:

AVK>Добавил синтаксис для таблиц, учел некоторые пожелания. Ссылка та же — https://bitbucket.org/andrewvk/rsdn.format/wiki/Specification


А вот ещё. Вот это *вообще* не будет работать:

Внутри блока кода вместо одинарного символа * следует использовать двойной **


Так никто не будет делать. Код копипейстится откуда-нибудь, где его проверяли на то, что он компилируется (или не компилируется) и работает (не работает), после чего его не трогают.

Допустимый способ выделения чего-либо в программном коде — подстрочное подчёркивание или стрелочка в комментарии:

VP> Подскажите, почему не компилируется?

VP> #include <iostream>
VP>
VP> void main()
//  ^^^^ так делать нельзя!
VP> {
VP>     cout << "Hello World!\n";
//      ^ std::
VP> }

Re[9]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 16:48
Оценка:
Здравствуйте, dеnisko, Вы писали:

D>Ну любая цитата может рассматриваться как частный случай ссылки без указания источника (что в общем сейчас и происходит).


Смысл этой словесной эквилибристики? URL и цитата куска текста — совершенно разные сущности, даже если по русски их можно обозвать одним словом.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Re[7]: К вопросу о форматтере
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 22.08.12 16:48
Оценка:
Здравствуйте, ShaggyOwl, Вы писали:

SO>С другой стороны, насколько это необходимо?


Необходимость переключения раскладки существенно замедляет набор и делает его менее комфортным, а так же иногда приводит к ошибкам с не той раскладкой. Поэтому мне кажется, что в часто используемых конструкциях без смены раскладки желательно обойтись. При этом для редких вещей, типа суперскрипта, это уже не так важно.
... << RSDN@Home 1.2.0 alpha 5 rev. 65 on Windows 7 6.1.7601.65536>>
AVK Blog
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.