[devel] Master Manual: style guidelines

[devel] Master Manual: style guidelines

[Michael Shigorin]

[-- Attachment #1: Type: text/plain, Size: 1953 bytes --]

	Здравствуйте.
Нужно стандартизировать стиль оформления Master Manual (в плане
typing conventions).

Предлагаю избитые, но привычные:

italics -- термин
courier -- команды, набираемые в строке; ключевые слова (?)
sans serif -- пункты меню

Я постараюсь "причесать" первые страницы мануала в таком ключе
(по крайней мере там, где совсем просится -- но консистентно) и
прокомментировать.

--- JAAR: HB & MO, in that order ---

>> Кстати, может, соберемся скопом да вычитаем Мастера? Эй, кто тут
>> себя больно грамотным мнит? :))

HB> Мастера и Маргариту, говорите, хотите вычитать? Вот Вам несколько
HB> полезных ;-) советов:

HB> 1. Заменяя существительные местоимениями, позаботьтесь
HB>    о правильном его согласовании.

...

- тире и дефис-четыре разных вещи. Тире в русском письменном тексте
  бывает только длинное (m-dash) и всегда отбивается справа и слева
  пробелами (желательно, короткими), а короткое (n-dash) тире
  используется лишь для обозначения интервалов между численными или
  именными значениями ("3--4 бутылко-дня", "поезд Москва--Сидней" и
  т.п.) и в этом случае пробелами не отбивается вовсе.

- переходность русских глаголов часто отличается от переходности
  английских, даже если у них общая этимология (например, "to start" -
  переходный, а "стартовать" - отнюдь, причем адекватным переводом
  переходного "to start" вполне может быть "запускать");

- обращение к читателю ("вы", "ваш", "вам"...) - опасный риторический
  прием, и даже если его использовать, не стоит капитализировать
  первые буквы - в русской культуре такое оформление применяется
  только в личных письмах и рекламе ваксы ("Мы заботимся о Вас и Ваших
  сапогах!");

- кавычки-<<елки>> сильно лучше кавычек-``лапок'', а знак дюйма " -
  вообще не кавычка. Вложенные кавычки лучше оформлять ``лапками''.
  Третьего уровня вложения кавычек не бывает.

- ...

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ http://visa.chem.univ.kiev.ua/~mike/

[-- Attachment #2: Type: application/pgp-signature, Size: 232 bytes --]

[devel] Re: Master Manual: style guidelines

[Mikhail Zabaluev]

[-- Attachment #1: Type: text/plain, Size: 854 bytes --]

Hello Michael,

On Sat, Jan 26, 2002 at 08:48:43PM +0200, Michael Shigorin wrote:
>
> 	Здравствуйте.
> Нужно стандартизировать стиль оформления Master Manual (в плане
> typing conventions).

Гм... а я свою главу в DocBook XML накатал.
Придется приложить еще и свои stylesheets :)

> - кавычки-<<елки>> сильно лучше кавычек-``лапок'', а знак дюйма " -
>   вообще не кавычка. Вложенные кавычки лучше оформлять ``лапками''.
>   Третьего уровня вложения кавычек не бывает.

Точно, спасибо за напоминание. Надо поискать, как бишь там лапки
называются в character entities.

P.S. Главу о Postfix собираюсь запостить сегодня вечером.

-- 
Stay tuned,
  MhZ                                     JID: mookid@jabber.org
___________
You can tune a piano, but you can't tuna fish.

You can tune a filesystem, but you can't tuna fish.
		-- from the tunefs(8) man page

[-- Attachment #2: Type: application/pgp-signature, Size: 232 bytes --]

Re: [devel] Re: Master Manual: style guidelines

[Michael Shigorin]

[-- Attachment #1: Type: text/plain, Size: 579 bytes --]

On Sun, Jan 27, 2002 at 02:09:24PM +0300, Mikhail Zabaluev wrote:
> > Нужно стандартизировать стиль оформления Master Manual (в плане
> > typing conventions).
> Гм... а я свою главу в DocBook XML накатал.
> Придется приложить еще и свои stylesheets :)
Кстати говоря, Mandrake свои книжки вроде в docbook и катает.
Что-то подсказывает, что они могут быть правее ;-)

2smi: насколько окончательным для "полировки" (в т.ч. по
читабельности) является тот вариант, который Вы мне дали?

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ http://visa.chem.univ.kiev.ua/~mike/

[-- Attachment #2: Type: application/pgp-signature, Size: 232 bytes --]

Re: [devel] Re: Master Manual: style guidelines

[Andrey Astafiev]

On Sun, Jan 27, 2002 at 03:37:41PM +0200, Michael Shigorin wrote:
> On Sun, Jan 27, 2002 at 02:09:24PM +0300, Mikhail Zabaluev wrote:
> > > Нужно стандартизировать стиль оформления Master Manual (в плане
> > > typing conventions).
> > Гм... а я свою главу в DocBook XML накатал.
> > Придется приложить еще и свои stylesheets :)
> Кстати говоря, Mandrake свои книжки вроде в docbook и катает.
> Что-то подсказывает, что они могут быть правее ;-)
> 
> 2smi: насколько окончательным для "полировки" (в т.ч. по
> читабельности) является тот вариант, который Вы мне дали?

а можно мне тоже глянуть на документацию?
бтв, на выходных поустанавливал Мастер --
баги пришлю завтра. немного смущает количество
ошибок в переводе при установке на русском.
если вышлете файл перевода, мог бы в меру сил
и возможостей поправить.


--
andrei at tvcell d0t ru

Re: [devel] Master Manual: style guidelines

[smi]

Michael Shigorin wrote:

> 	Здравствуйте.
> Нужно стандартизировать стиль оформления Master Manual (в плане
> typing conventions).
> 
> Предлагаю избитые, но привычные:
> 
> italics -- термин
> courier -- команды, набираемые в строке; ключевые слова (?)
> sans serif -- пункты меню
> 
> Я постараюсь "причесать" первые страницы мануала в таком ключе
> (по крайней мере там, где совсем просится -- но консистентно) и
> прокомментировать.


Правка стилей, верстка и проч. будут делаться по трем томам единообразно. Сейчас главное 
привести в порядок текст.


> 
> --- JAAR: HB & MO, in that order ---
> 
> 
>>>Кстати, может, соберемся скопом да вычитаем Мастера? Эй, кто тут
>>>себя больно грамотным мнит? :))
>>>
> 
> HB> Мастера и Маргариту, говорите, хотите вычитать? Вот Вам несколько
> HB> полезных ;-) советов:
> 
> HB> 1. Заменяя существительные местоимениями, позаботьтесь
> HB>    о правильном его согласовании.
> 
> ...
> 
> - тире и дефис-четыре разных вещи. Тире в русском письменном тексте
>   бывает только длинное (m-dash) и всегда отбивается справа и слева
>   пробелами (желательно, короткими), а короткое (n-dash) тире
>   используется лишь для обозначения интервалов между численными или
>   именными значениями ("3--4 бутылко-дня", "поезд Москва--Сидней" и
>   т.п.) и в этом случае пробелами не отбивается вовсе.
> 
> - переходность русских глаголов часто отличается от переходности
>   английских, даже если у них общая этимология (например, "to start" -
>   переходный, а "стартовать" - отнюдь, причем адекватным переводом
>   переходного "to start" вполне может быть "запускать");
> 
> - обращение к читателю ("вы", "ваш", "вам"...) - опасный риторический
>   прием, и даже если его использовать, не стоит капитализировать
>   первые буквы - в русской культуре такое оформление применяется
>   только в личных письмах и рекламе ваксы ("Мы заботимся о Вас и Ваших
>   сапогах!");
> 
> - кавычки-<<елки>> сильно лучше кавычек-``лапок'', а знак дюйма " -
>   вообще не кавычка. Вложенные кавычки лучше оформлять ``лапками''.
>   Третьего уровня вложения кавычек не бывает.
> 
> - ...


Согласен. Будем вычищать.

Алексей Смирнов