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

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

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

Post by John Doe » Thu 02 Sep, 2010 17:37

Эта тема служит для предложения улучшений в разделе о макросах.
Что сделано
Что не сделано
Прочие проблемы
Что ещё можно сделать

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

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

Post by John Doe » Tue 14 Sep, 2010 10:57

В данный момент в статье functions.html описаны ~65 макрофункций.
Простое их перечисление (без описания) уже занимает целую страницу:


В общем, ориентироваться в ~100кб текста проблематично.
Если расположить все статьи Энциклопедии в порядке убывания размера, то можно увидеть что functions.html это самая большая статья, и даже следующая за ней farcolors.html в 3 раза меньше.

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

P.S.
Пока готовил сообщение нашёл пару багов:

Max Rusov
Posts: 3632
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 1 time
Been thanked: 10 times

Re: Энциклопедия: улучшение functions.html

Post by Max Rusov » Tue 14 Sep, 2010 11:26

А мне еще непонятно деление на "функции" и "состояния". Почему такие по смыслу близкие вещи как

panel.setpath и APanel.Path/PPanel.Path

отнесены к совершенно разным категориям? Очень неудобно, честно говоря.

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Tue 14 Sep, 2010 11:37

Деление в общем понятно, но вероятно действительно имеет смысл в Энциклопедии делить в первую очередь по назначению.
Т.е. разбить на "Макросредства для работы с панелями", "Макросредства для работы в редакторе" и т. п.
А уже внутри соответствующих статей делить на функции/состояния/булевы состояния.

User avatar
Skirda
Posts: 3474
Joined: Wed 16 Mar, 2005 11:01
Been thanked: 4 times

Re: Энциклопедия: улучшение functions.html

Post by Skirda » Tue 14 Sep, 2010 12:56

патч на мантис.
только в разные файлы разные "макросредства"
We are the Borg. You will be assimilated.
So Say We All!

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Tue 14 Sep, 2010 17:27

Предлагается черновик раздела, объединяющего булевы состояния, свойства и функции.

Заинтересованных прошу посмотреть следующее:
  • Как оно в целом, преимущества и недостатки по сравнению с исходным вариантом, что можно улучшить.
  • Как лучше озаглавить статьи, пункты оглавления, и сами файлы.
Нерешённые вопросы:
  • Страница general.html всё ещё очень большая.
    Нужна какая-то навигация внутри страницы. Например в виде содержания.
    Альтернатива: убрать под спойлеры большие таблицы параметров и другие детали.
Attachments
macro.zip
RC6
(179.58 KiB) Downloaded 207 times
Last edited by John Doe on Thu 01 Jan, 1970 01:00, edited 0 times in total.
Reason: RC6

Max Rusov
Posts: 3632
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 1 time
Been thanked: 10 times

Re: Энциклопедия: улучшение functions.html

Post by Max Rusov » Wed 15 Sep, 2010 08:53

1. Термин "Состояние" мне кажется неудачным. ItemCount - это уж точно не "состояние". Предлагаю использовать термин "Свойство".
2. Булевы состояния (свойства) и просто состояния - объединить.
3. Для функций с длинным описанием (типа date) лучше завести отдельные топики, чтобы в таблице осталось только общее описание, как в группе "Макрокоманды".

По мелочам:

4. В область по панелям попали состояния диалогов.
5. Командную строку, наверное, лучше выделить в отдельный топик.
6. key, waitkey (akey, flock ???), лучше перенести в раздел "Взаимодействие с пользователем"

User avatar
Skirda
Posts: 3474
Joined: Wed 16 Mar, 2005 11:01
Been thanked: 4 times

Re: Энциклопедия: улучшение functions.html

Post by Skirda » Wed 15 Sep, 2010 12:23

1 и 2 - да
3 - не "с длиннннными описаниями", а на каждую функцию свой html, так будет разумнее
4 - бывает :-)
5 - угу
6 - угу

давай патч :-)
We are the Borg. You will be assimilated.
So Say We All!

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Wed 15 Sep, 2010 12:42

Max Rusov wrote:2. Булевы состояния (свойства) и просто состояния - объединить.
А смысл?
И как именно? Тупо слить таблицы -- будет выглядеть странно.
Skirda wrote:3 - не "с длиннннными описаниями", а на каждую функцию свой html, так будет разумнее
Давайте не надо. Просто оставим как есть, в табличке.
Skirda wrote:давай патч :-)
Рано. Может не все высказались.
И см. выше список ещё нерешённых вопросов.

Max Rusov
Posts: 3632
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 1 time
Been thanked: 10 times

Re: Энциклопедия: улучшение functions.html

Post by Max Rusov » Wed 15 Sep, 2010 13:07

John Doe wrote:
Max Rusov wrote:2. Булевы состояния (свойства) и просто состояния - объединить.
А смысл?
И как именно? Тупо слить таблицы -- будет выглядеть странно.
А какой смысл их делить? Чем они отличаются, кроме типа возвращаемого значения? Таблицы можно слить не "тупо", а сохраняя смысловую группировку. Например:

Panel.Empty
Panel.ItemCount
...
Panel.Selected
Panel.SelCount
...
Panel.BOF/EOF
Panel.CurPos
John Doe wrote:Давайте не надо. Просто оставим как есть, в табличке.
Объективно неудобно искать функцию, когда не знаешь точно как она называется, а просто ищешь по предполагаемому функционалу...

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Wed 15 Sep, 2010 14:22

Новый черновик (на прежнем месте)
  • Сгруппировал всё в раздел "Состояния, свойства, функции: по областям".
  • Состояния переименовал в свойства (сам об этом давно мечтал)
  • Командную строку выделил в cmdline.html
  • Все зависящие от контекста "обобщённые" состояния и свойства выделил в context_dep.html
  • Для мышиной возни отвёл отдельный раздел таблички (в common.html)
  • waitkey и key перенёс, но большого смысла это не имеет, вся классификация крайне зыбка.
    (Например print редко используется для взаимодействия с пользователем).
Состояния и свойства (пока) не объединял.

User avatar
Skirda
Posts: 3474
Joined: Wed 16 Mar, 2005 11:01
Been thanked: 4 times

Re: Энциклопедия: улучшение functions.html

Post by Skirda » Wed 15 Sep, 2010 14:32

Что есть Number?
Это к тому, что шапки таблиц куда дел?
We are the Borg. You will be assimilated.
So Say We All!

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Wed 15 Sep, 2010 14:39

Skirda wrote:Это к тому, что шапки таблиц куда дел?
Местами копипаста поела, исправлю.
Max Rusov wrote: А какой смысл их делить? Чем они отличаются, кроме типа возвращаемого значения? Таблицы можно слить не "тупо", а сохраняя смысловую группировку.
Не знаю, давайте обсудим.
Лично мне очень удобно видеть все логические состояния отдельно.
Отдельно -- потому что у них несколько другой способ использования.

Их мало, и теперь они на страничке в самом начале, никому не мешают.

А вообще, если принять вашу точку зрения, то и функции вполне можно объединить со свойствами.
Кое-где разницы между ними действительно не видно:

Code: Select all

Menu.Value
Menu.GetValue()
Max Rusov wrote:
John Doe wrote:Давайте не надо. Просто оставим как есть, в табличке.
Объективно неудобно искать функцию, когда не знаешь точно как она называется, а просто ищешь по предполагаемому функционалу...
Это про Date или про Состояния, или про что?

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Wed 15 Sep, 2010 16:48

Очередная редакция:
  • Мелочи: подправил заголовки таблиц, описание в функции mmode(), орфографию в substr().
  • Подправил содержание, озаглавил страницы (<title> и <h1>).
Текущие вопросы:
  1. Хотелось бы окончательно утвердить названия раздела и статей как они выглядят в оглавлении, и в названиях файлов:
  2. Просьба также обратить внимание на заголовки (<h1>).
  3. Сейчас названия страниц (<title>) идентичны заголовкам.
    Раньше к заголовку добавлялось "- Макросы", в текущем виде это наверно бессмысленно (или как?)
  4. Есть функция общая для диалогов и меню (checkhotkey).
    Объединять разделы не хочется. Предлагаю подробно описать в каком-то одном разделе, а во втором только сослаться.

Max Rusov
Posts: 3632
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 1 time
Been thanked: 10 times

Re: Энциклопедия: улучшение functions.html

Post by Max Rusov » Wed 15 Sep, 2010 17:21

1. Неудачно настроены ширины столбцов: столбцы с именем/типом слишком широкие, в результате в столбце описания все сворачивается во много строк. Если описания функций не выносить в отдельные топики, то хоть столбец описания надо сделать шире, таблицы сократятся по высоте.
2. Опять предложу не использовать термин "состояние", не надо плодить сущности. Не хотите объединять таблицы - пусть будут "Логические свойства". Иначе придется объяснять чем состояние отличается от свойства.
3. Топик "для панелей"
Замечания
В состояних панели префикс APanel. относится к активной панели, PPanel. к пассивной.

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

Re: Энциклопедия: улучшение functions.html

Post by John Doe » Wed 15 Sep, 2010 17:52

Max Rusov wrote:1. Неудачно настроены ширины столбцов:
Что поменять (конкретные числа)?
Max Rusov wrote:пусть будут "Логические свойства".
Ок.
Замечания
В состояних панели префикс APanel. относится к активной панели, PPanel. к пассивной.
Будет: "Префикс APanel. относится к активной панели, PPanel. к пассивной."

P.S.
Просьба всё-таки рассмотреть и "Текущие вопросы"

Post Reply

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