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

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

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

Post by John Doe »

Latest post of the previous page:

Также отсутствуют callplugin(), mmode(2,), window.scroll().
Не описана работа с "точными строками" (verbatim strings).
User avatar
Raistlin
Posts: 731
Joined: Wed 16 Mar, 2005 16:01
Has thanked: 3 times
Been thanked: 1 time

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

Post by Raistlin »

John Doe wrote:Я против, т.к. это не даёт общей картины, и создаёт впечатление будто в разных функциях элементы могут нумероваться по-разному.
Это энциклопедия, а не беллетристика. Общая картина не должна быть превалирующей, важнее дать точные и исчерпывающие данные по конкретному интересующему вопросу. Если после ознакомления с конкретной статьей осталась необходимость в экспериментах - статья написана плохо.
John Doe wrote:Все элементы в макроязыке, вообще все, за исключением строк, нумеруются с единицы.
Стоки являются единственным исключением, это на мой взгляд ничем не оправданно, и лишь способствует путанице.
Оправдано, не оправдано - сейчас уже без разницы. Есть объективная реальность: в одних функциях так, в других - так. Поэтому рассуждения про "все элементы" - это демагогия, до которой читающему энциклопедию дела нет.
Magically yours
Raistlin
User avatar
John Doe
Бюрократ
Posts: 12888
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 38 times
Been thanked: 295 times

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

Post by John Doe »

Raistlin wrote:Если после ознакомления с конкретной статьей осталась необходимость в экспериментах - статья написана плохо.
© Если статью написать так, чтобы она была понятна и идиоту, то только идиот её и захочет прочитать.
Raistlin wrote:...это демагогия, до которой читающему энциклопедию дела нет.
© Резкость суждений суть признак незрелости.
Я почему-то воздержался от подобных характеристик в сторону ваших излияний.
User avatar
Raistlin
Posts: 731
Joined: Wed 16 Mar, 2005 16:01
Has thanked: 3 times
Been thanked: 1 time

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

Post by Raistlin »

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

Интересно было бы узнать мнение других по вопросу: "куда писать про общие вещи", ибо фундаментальный.
Magically yours
Raistlin
Maximus5
Posts: 3294
Joined: Sun 11 Nov, 2007 02:03
Been thanked: 7 times
Contact:

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

Post by Maximus5 »

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

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 »

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

xmpp:kildor@jabber.ru
User avatar
Raistlin
Posts: 731
Joined: Wed 16 Mar, 2005 16:01
Has thanked: 3 times
Been thanked: 1 time

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

Post by Raistlin »

В раздел про print() предлагаю добавить:
Примечание: функция игнорирует режим замены, всегда работает в режиме вставки.
Magically yours
Raistlin
User avatar
John Doe
Бюрократ
Posts: 12888
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 38 times
Been thanked: 295 times

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

Post by John Doe »

Предлагаю актуализированный кусок документации о макросах, из Энциклопедии (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: 6167
Joined: Thu 23 Mar, 2006 21:36
Location: Israel
Has thanked: 31 times
Been thanked: 330 times

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

Post by Shmuel »

Работа проделана немалая, но смотрится на данный момент не очень. Действительно нужен специалист.
User avatar
John Doe
Бюрократ
Posts: 12888
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 38 times
Been thanked: 295 times

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

Post by John Doe »

Наложения текста исправлены
User avatar
John Doe
Бюрократ
Posts: 12888
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 38 times
Been thanked: 295 times

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

Post by John Doe »

Попробовал скрестить со стилем github.

Может понадобиться очистка кэша.
Shmuel
Posts: 6167
Joined: Thu 23 Mar, 2006 21:36
Location: Israel
Has thanked: 31 times
Been thanked: 330 times

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

Post by Shmuel »

John Doe wrote: Sun 26 Nov, 2017 22:42Попробовал скрестить со стилем github.
Стало намного лучше (на мой субъективный взгляд).
Что не нравится - в подсветке Lua идентификаторы слишком бледные (комменты - и то намного ярче).
User avatar
John Doe
Бюрократ
Posts: 12888
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 38 times
Been thanked: 295 times

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

Post by John Doe »

Исправил
User avatar
sToLp
Posts: 938
Joined: Thu 23 Jul, 2009 10:16
Has thanked: 107 times
Been thanked: 12 times

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

Post by sToLp »

А нельзя ли в web`овской версии примеры ещё и файлом приаттачить?
Для удобства и чтобы избежать сбоев при копи-пасте.
User avatar
John Doe
Бюрократ
Posts: 12888
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 38 times
Been thanked: 295 times

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

Post by John Doe »

sToLp wrote: Mon 27 Nov, 2017 23:12чтобы избежать сбоев при копи-пасте
Не должно быть никаких сбоев.

А идея может и неплохая, думал об этом. Но не всё однозначно.
Логично если каждый пример можно скачать отдельно, особенно учитывая что они не только на странице примеров.
И тут мне пока не очень понятно, как это должно выглядеть. Тупо ссылка "скачать" возле каждого мне кажется несколько уродливо.

И другой момент это соотношение с макросами из Addons, которые сейчас отдельно, а неплохо бы всё это хозяйство как-то объединить..
User avatar
sToLp
Posts: 938
Joined: Thu 23 Jul, 2009 10:16
Has thanked: 107 times
Been thanked: 12 times

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

Post by sToLp »

John Doe wrote: Tue 28 Nov, 2017 08:45И другой момент это соотношение с макросами из Addons, которые сейчас отдельно, а неплохо бы всё это хозяйство как-то объединить..
Если макросы с примерами будут помещаться вот хоть в отдельную подпапку Addons, то и надобности прикреплять их к странице сайта не будет. А лишь привести информацию о том, где их можно взять.
Post Reply

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