Энциклопедия: улучшение раздела о макросах

Здесь обсуждается всё, что касается макросов.
User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Re: Энциклопедия: улучшение раздела о макросах

Post by John Doe » Wed 19 Jan, 2011 18:58

Latest post of the previous page:

Raistlin wrote:Я не знаю, в каком месте ты это вставил, - факт тот, что там, где речь о глобальных переменных, нет никаких замечаний - ни твоих, ни негодных.
Естественно. Надо добавить, в виде примечания.
Raistlin wrote:Только вот оправдано ли это, в частности, для Энциклопедии?
Даже если раздавать права на запись Энциклопедии, то явно не всем.
Raistlin wrote:Что после этого сделать с моими наработками, опубликованными выше?
Вы переоцениваете свой пока ещё не внесённый вклад.
Пока правил я, несколько страниц тоже обновились, но мне почему-то не составило труда интегрировать изменения.
Raistlin wrote:У кого тут лишнее время есть в чужих наработках копаться?
Судя по всему у меня.

P.S.
И переменные я тоже поправлю, пользуясь вашими предложениями (вероятно не всеми).
Патч мне для этого не понадобится, не надо переживать.

User avatar
Raistlin
Posts: 698
Joined: Wed 16 Mar, 2005 16:01
Location: St. Petersburg
Has thanked: 1 time
Been thanked: 1 time
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Raistlin » Wed 19 Jan, 2011 20:51

John Doe wrote:Даже если раздавать права на запись Энциклопедии, то явно не всем.
Все их и не захотят иметь. Это не виши и не баги - прямой пользы от правок Энциклопедии тому, кто правит, нет.
John Doe wrote:
Raistlin wrote:Что после этого сделать с моими наработками, опубликованными выше?
Вы переоцениваете свой пока ещё не внесённый вклад.
Не нужно читать у меня между строк то, чего там нет. Свои наработки я привел только в качестве примера.
John Doe wrote:Пока правил я, несколько страниц тоже обновились, но мне почему-то не составило труда интегрировать изменения.
Из этого не следует, что такой подход - правильный. Уверен ли ты, что авторы изменений полностью удовлетворены тем, как ты их интегрировал?
John Doe wrote:
Raistlin wrote:У кого тут лишнее время есть в чужих наработках копаться?
Судя по всему у меня.
Вот и выходит, что, несмотря на отсутствие доступа на запись на svn, ты вершишь судьбу Энциклопедии.
Я не спорю, курирование необходимо, однако право отозвать изменения, если они негативны, - это одно, а полномочия решать, что из предложенного использовать, а что - нет, - это другое. Впрочем, не знаю, может, народу нравится именно второй подход.
Magically yours
Raistlin

User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Re: Энциклопедия: улучшение раздела о макросах

Post by John Doe » Wed 19 Jan, 2011 22:21

John Doe wrote:Из этого не следует, что такой подход - правильный. Уверен ли ты, что авторы изменений полностью удовлетворены тем, как ты их интегрировал?
Уверен на 100%, а если бы сомневался, то не постеснялся бы спросить.
Если есть более правильный подход - сам с удовольствием возьму на вооружение.
John Doe wrote:Вот и выходит, что, несмотря на отсутствие доступа на запись на svn, ты вершишь судьбу Энциклопедии.
Так вперёд, присоединяйся, и тоже начинай вершить её судьбу, вакансий ещё достаточно.

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

Maximus5
Posts: 3292
Joined: Sun 11 Nov, 2007 02:03
Been thanked: 4 times
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Maximus5 » Wed 19 Jan, 2011 22:48

Хорошо, конечно, что теперь указано
Для строковых функций: нумерация символов в строке начинается с 0 (см. index(), rindex(), substr()).
но все-таки в самом низу страницы этому примечению не место.
Может это замечание передвинуть сразу после заголовка Строковые функции?

User avatar
Raistlin
Posts: 698
Joined: Wed 16 Mar, 2005 16:01
Location: St. Petersburg
Has thanked: 1 time
Been thanked: 1 time
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Raistlin » Wed 19 Jan, 2011 23:05

Maximus5 wrote:Хорошо, конечно, что теперь указано
Для строковых функций: нумерация символов в строке начинается с 0 (см. index(), rindex(), substr()).
но все-таки в самом низу страницы этому примечению не место.
Может это замечание передвинуть сразу после заголовка Строковые функции?
На мой взгляд, ему место в описании каждой функции. И там, где нумерация начинается с 1, тоже нужно так и написать.
Про других не знаю, а я, открыв страницу с функциями, ищу нужную мне и читаю именно ее описание. Не найдя полной информации, я скорее начну экспериментировать "на кошках", чем метаться по странице в поисках дополнительных замечаний.
Magically yours
Raistlin

User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Re: Энциклопедия: улучшение раздела о макросах

Post by John Doe » Thu 20 Jan, 2011 00:06

Raistlin wrote:На мой взгляд, ему место в описании каждой функции.
Я против, т.к. это не даёт общей картины, и создаёт впечатление будто в разных функциях элементы могут нумероваться по-разному.
Raistlin wrote:И там, где нумерация начинается с 1, тоже нужно так и написать.
Все элементы в макроязыке, вообще все, за исключением строк, нумеруются с единицы.
Стоки являются единственным исключением, это на мой взгляд ничем не оправданно, и лишь способствует путанице.
Maximus5 wrote:Может это замечание передвинуть сразу после заголовка Строковые функции?
Но тогда логично и в прочих разделах подвинуть аналогичные замечания. Возможно.

Maximus5
Posts: 3292
Joined: Sun 11 Nov, 2007 02:03
Been thanked: 4 times
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Maximus5 » Thu 20 Jan, 2011 00:10

В области "Свойства и функции для работы с диалогами" отсутсвует "Dlg.Info.Id"

User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Re: Энциклопедия: улучшение раздела о макросах

Post by John Doe » Thu 20 Jan, 2011 00:14

Также отсутствуют callplugin(), mmode(2,), window.scroll().
Не описана работа с "точными строками" (verbatim strings).

User avatar
Raistlin
Posts: 698
Joined: Wed 16 Mar, 2005 16:01
Location: St. Petersburg
Has thanked: 1 time
Been thanked: 1 time
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Raistlin » Thu 20 Jan, 2011 00:18

John Doe wrote:Я против, т.к. это не даёт общей картины, и создаёт впечатление будто в разных функциях элементы могут нумероваться по-разному.
Это энциклопедия, а не беллетристика. Общая картина не должна быть превалирующей, важнее дать точные и исчерпывающие данные по конкретному интересующему вопросу. Если после ознакомления с конкретной статьей осталась необходимость в экспериментах - статья написана плохо.
John Doe wrote:Все элементы в макроязыке, вообще все, за исключением строк, нумеруются с единицы.
Стоки являются единственным исключением, это на мой взгляд ничем не оправданно, и лишь способствует путанице.
Оправдано, не оправдано - сейчас уже без разницы. Есть объективная реальность: в одних функциях так, в других - так. Поэтому рассуждения про "все элементы" - это демагогия, до которой читающему энциклопедию дела нет.
Magically yours
Raistlin

User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Re: Энциклопедия: улучшение раздела о макросах

Post by John Doe » Thu 20 Jan, 2011 00:30

Raistlin wrote:Если после ознакомления с конкретной статьей осталась необходимость в экспериментах - статья написана плохо.
© Если статью написать так, чтобы она была понятна и идиоту, то только идиот её и захочет прочитать.
Raistlin wrote:...это демагогия, до которой читающему энциклопедию дела нет.
© Резкость суждений суть признак незрелости.
Я почему-то воздержался от подобных характеристик в сторону ваших излияний.

User avatar
Raistlin
Posts: 698
Joined: Wed 16 Mar, 2005 16:01
Location: St. Petersburg
Has thanked: 1 time
Been thanked: 1 time
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Raistlin » Thu 20 Jan, 2011 00:47

John Doe wrote:Если статью написать так, чтобы она была понятна и идиоту, то только идиот её и поймёт (с).
Не знаю, чей это (c), но его истинность позволю себе поставить под сомнение. Еще аргументы против исчерпывающей инфы для каждой функции есть?
John Doe wrote:
Raistlin wrote:...это демагогия, до которой читающему энциклопедию дела нет.
Резкость суждений суть признак незрелости (с).
Я почему-то воздержался от подобных характеристик в сторону ваших излияний.
Принимаю любые характеристики - главное, пусть они имеют под собой основания. И свою тоже готов обосновать. Откуда следует, что
Все элементы в макроязыке, вообще все, за исключением строк, нумеруются с единицы.
? Особенно учитывая, что во всех функциях, вообще во всех, работающих с панелями, без всяких исключений, нумерация панелей начинается с нуля.

Интересно было бы узнать мнение других по вопросу: "куда писать про общие вещи", ибо фундаментальный.
Magically yours
Raistlin

Maximus5
Posts: 3292
Joined: Sun 11 Nov, 2007 02:03
Been thanked: 4 times
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Maximus5 » Thu 20 Jan, 2011 00:55

Ну, мне кажется, что

Code: Select all

S=substr(V,N1[,N2]) Возвращает подстроку из выражения V начиная с позиции N1 (начиная с 0) длиной N2.
все-же более удобно для восприятия, нежели "Замечание" где-то на странице.

Kildor
Posts: 1515
Joined: Wed 16 Mar, 2005 06:26
Location: Новосибирск
Been thanked: 1 time
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Kildor » Thu 20 Jan, 2011 05:00

> Это энциклопедия, а не беллетристика. Общая картина не должна быть превалирующей, важнее дать точные и исчерпывающие данные по конкретному интересующему вопросу. Если после ознакомления с конкретной статьей осталась необходимость в экспериментах - статья написана плохо.
Полностью поддерживаю.
Если какие-то функции ведут себя +/- одинаково, но при этом слегка разно, необходимо в каждой функции писать особенность её поведения — именно в каждой. Особенно, если таки появится индекс всех функций.
Ты мне не выкай!
«ФарФорум не для пользователей!»
Upd:
P.S. Я просто поддерживаю беседу.» © Народ.

xmpp:kildor@jabber.ru

User avatar
Raistlin
Posts: 698
Joined: Wed 16 Mar, 2005 16:01
Location: St. Petersburg
Has thanked: 1 time
Been thanked: 1 time
Contact:

Re: Энциклопедия: улучшение раздела о макросах

Post by Raistlin » Tue 17 May, 2011 09:04

В раздел про print() предлагаю добавить:
Примечание: функция игнорирует режим замены, всегда работает в режиме вставки.
Magically yours
Raistlin

User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Энциклопедия: улучшение раздела о макросах

Post by John Doe » Sat 25 Nov, 2017 17:16

Предлагаю актуализированный кусок документации о макросах, из Энциклопедии (src).
Прошу заинтересованных проверить на отсутствие ошибок.

Принимаются советы и пожелания.

Однозначно требуется помощь по стилям.
Визуально сейчас главная проблема в представлении definition lists.
Я конечно скопипастил что-то из сети, но результат неудовлетворительный: есть наложения
текста столбцов.

Однако специалист нужен.

Задачи на будущее:
  • Избавиться от дико вложенных описаний.
    Полагаю, для сложных функций надо создать отдельные статьи.
    Возможно это надо сделать вообще для всех элементов (не уверен).
  • Определиться со структурой, и интегрировать с macroapi_manual, добавив также и
    оставшуюся документацию из Энциклопедии
  • Гиперссылки на элементы.
  • Привести в порядок стили.
  • Конвертировать в hlf
  • ???
Last edited by John Doe on Sun 26 Nov, 2017 16:22, edited 1 time in total.

Shmuel
Posts: 5918
Joined: Thu 23 Mar, 2006 21:36
Location: Israel
Has thanked: 23 times
Been thanked: 229 times

Энциклопедия: улучшение раздела о макросах

Post by Shmuel » Sat 25 Nov, 2017 18:00

Работа проделана немалая, но смотрится на данный момент не очень. Действительно нужен специалист.

User avatar
John Doe
Бюрократ
Posts: 12527
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 33 times
Been thanked: 233 times

Энциклопедия: улучшение раздела о макросах

Post by John Doe » Sun 26 Nov, 2017 17:19

Наложения текста исправлены

Post Reply

Return to “Обсуждение макросов”