Обсуждение:Ruby/Справочник

Источник

FTR и AIUI, первоисточником данного материала является поставляемая с самой реализацией Ruby документация, доступная на условиях одной из двух лицензий (на выбор лицензиата.) Одной из этих лицензий является 2-пунктная лицензия BSD, совместимая (IIUC) с требуемой Викиучебником CC BY-SA, но также требующая (как, впрочем, и действующее законодательство) ссылки на источник. Представляется, что такой ссылкой может быть, в частности:

• http://ruby-doc.org/ — Help and documentation for the Ruby programming language.

(Еще раз напомню участникам о необходимости всегда упоминать первоисточник при переносе материала в Викиучебник — вне зависимости от обстоятельств такого переноса. В противном случае, материал де факто публикуется от имени участника, что может быть расценено как плагиат.)

— Ivan Shmakov (о ▞ в) 19:00, 20 октября 2013 (UTC)

Вопросы для обсуждения

1. Во время описания формата метода есть масса проблем. Предлагаемая ri система описаний формата -- ужасна и требует переработки. В частности, необходимо разработать форму при которой стало бы ясно о классе того или иного параметра. Например, Integer.+( Numeric ) #-> Numeric. При этом, не обойтись без стандартной системы, но имена параметров уже можно подбирать строго по значению.
2. Необходимо убрать в описании методов описание его алиасов. Для это есть Шаблон:Идентичные методы

Rubynovich

Машинный перевод невозможен, советую даже не пробовать. Ссылки вроде работают, например Ruby/Справочник/Time#Time#+. Разбиение — хорошо, но можно сделать страницу, где как «шаблоны» будут вставлены все подстраницы Справочника. Чтоб был вариант читателю «скачать весь справочник одной страницей». Вставлять так: {{:Название обычной страницы}}. Ramir

машинный перевод попробовал и продлил себе жизнь часов на пять. =) Поэтому придется переводить долго и нудно самому. За идею с объединением — спасибо, попробую. Думаю, что создам отдельную страницу для скачивания и общего обзора (хотя страничка будет весить больше мегабайта). Rubynovich 13:13, 28 апреля 2007 (UTC)

Ага, я тоже в своё время накачивал мышцы живота с этим бабелфишем. Ramir 00:06, 29 апреля 2007 (UTC)

А что если методы сделать отдельными страницами? ИМХО так можно будет использовать описание методов прямо в основном тексте учебника... Правда, лучше это делать не сейчас, а уже после перевода. Как идейка? Rubynovich 19:11, 28 апреля 2007 (UTC)

Идейка классненькая, но работы, кажется, много по разбиению. Да и уместны ли формальные описания методов посреди учебника? Но поскольку я вчера приделал скрывалку, теперь можно делать вот так:

Много всего

Проба 1

Вот те раз!

Это можно скрывать

Ramir 00:06, 29 апреля 2007 (UTC)

• А ссылаться из содержания на такую скрывалку можно? Например, вот на эту:

Array::[]

Array::[](...)

Возвращает новый массив, заполненный указанными объектами.

Array.[]( 1, 'a', /^A/ )
Array[ 1, 'a', /^A/ ]
[ 1, 'a', /^A/ ]

Красиво, но я столько человеко-часов затратил на wiki-преобразование... =) Rubynovich 07:34, 29 апреля 2007 (UTC)

Ссылки работать будут, если делать заголовки заголовками (неважно, вики или HTML) Ramir

Но я правильно понял, что придется отказаться от wiki-разметки? Или хотя бы от ее части... Rubynovich 08:31, 29 апреля 2007 (UTC)

Вовсе нет. Из вики-разметки не работают, видимо, только заголовки. Для исправления надо лишь переписать Шаблон:Скрывалка или… по его шаблону сделать новый шаблон. Ramir 09:35, 29 апреля 2007 (UTC)

Проба 2

(Шаблон:Скрывалка с пустой остающейся частью)

Array::[]

Array::[](...)

Возвращает новый массив, заполненный указанными объектами.

Array.[]( 1, 'a', /^A/ )
Array[ 1, 'a', /^A/ ]
[ 1, 'a', /^A/ ]

Ладно, хватит играться с этими джаваскриптами

Скрывалку, вижу, надо переписывать и на уровне джаваскрипта, и переоформлять в ЦСС. Это надо обсуждать в Обсуждение:Скрывалка, а тут же вернёмся к вопросам по теме. Ramir

• Стоит ли продолжать в том же духе? Rubynovich 10:06, 29 апреля 2007 (UTC)

  А что там особенного? Ramir

  Наши «любимые» maccuBы

  Вопрос наболевший. Мне они (да и тебе, видимо) очень милы, и даже легче читаются. Но жалоб поступило много. Хотя… те, кому нравится, просто читают и не жалуются, поэтому однозначно о мнении общественности судить нельзя. Поэтому отвечу сухим административным: «администрация Викиучебника одобряет это нововведение, но иных вариантов не запрещает». Ramir

  Я склоняюсь к тому, что надо ориентироваться на «полупрофессиональную» аудиторию, которых эти приемы просто бесят =)) Поэтому я пока их использовать не буду, а дальше будет видно... Не понравится — исправим! Rubynovich 10:41, 29 апреля 2007 (UTC)

Несколько общих соображений

В подзаголовках: разделитель имён класса и метода

Что в названиях подзаголовков означают октоторпы и двойные двоеточия (::). Кажется, что, по крайней мере для первых, вместо нужна точка. Ramir

Это обозначение информационной системы ri (из которой берется англоязычный вариант). А точка будет неправильным подходом, так как таким образом невозможно отличить метод объекта и метод класса. Rubynovich 10:39, 29 апреля 2007 (UTC)

А ещё по-моему, излишне много черт: после заголовка, после правила (перед описанием). Ramir

А мне нравится... это опять же взято из справочной системы ri (с поправкой на wiki). Rubynovich 10:39, 29 апреля 2007 (UTC)

Многовато труда

Рубинович, надо бы для перевода помощников призвать: труд скучный, почти машинный. Если не помощников, то хотя бы ценителей. Это первый ли в истории перевод справочника по Руби на русский язык? Если да — то нужно огласить! Ramir

Не первый, но наиболее успешный! =) Своих студентов оповестил, но сейчас сессия у многих. Rubynovich 10:37, 29 апреля 2007 (UTC)

Шаблоны

В результате тщательной проверки Ri появилась идея создать несколько шаблонов. Все они будут перечислены здесь:

• Шаблон:Справочник один из самых важных, но пока не готов. Он позволяет проставлять ссылку на класс или метод справочника. Но пока только методы объектов, а не класса, но над этой проблемой мы подумаем потом.

1й параметр — название класса

2й параметр — название метода

3ему параметру надо передать ::, чтобы сослаться на метод класса

Справочник

String

[[Ruby/Справочник/String

1. String.split|String
2. String.split]]

[[Ruby/Справочник/Float

1. Float

induced_from|Float

1. Float

induced_from]]

• Шаблон:Опасный метод используется для пометки методов, которые изменяют исходный объект.

1й параметр - название класса. Есть подозрение, что от него можно избавиться

2й параметр - название метода, который рекомендуется использовать

Rubynovich

• Шаблон:Похожие методы используется для перечисления методов, которые имеют схожую функциональность. Как сделать его для разных классов я пока не знаю

1й параметр - название класса. Надо от него избавляться, но вот как?!

2й-6й параметры - названия методов, которые рекомендуется посмотреть

Полезно посмотреть на метод scan, который имеет схожую функциональность

Полезно посмотреть на методы strip, lstrip и rstrip, которые имеют схожую функциональность

Rubynovich

• Шаблон:Идентичные методы используется, когда метод имеет несколько имен (alias)

1й параметр - название класса. Надо от него избавляться, но вот как?!

2й-6й параметры - список имен метода

Методы size и length — абсолютно идентичны, то есть являются именами одного и того же метода

Rubynovich

• Шаблон:Устаревший метод используется, когда надо пометить метод, который не рекомендован к использованию

1й параметр - название класса

2й параметр - имя, которое рекомендуется использовать

Rubynovich

• Шаблон:Необходима библиотека используется, когда для работы метода необходимо подключение библиотеки

1й и единственный параметр — название библиотеки