Скрипты: система их названий и описаний

Здесь обсуждается всё, что касается макросов.
AleXH
Posts: 1000
Joined: Sun 12 Apr, 2009 05:21
Been thanked: 1 time

Скрипты: система их названий и описаний

Post by AleXH » Fri 27 Jun, 2014 05:52

John Doe
Предлагаю "окультурить" систему названий макросов и принять следующие правила для оформления макросов:

1. Имя файла макроса должно начинаться с области действия. Кстати, в Addons в именах макросов почему-то использованы "Edit" и "View" вместо "Editor" и "Viewer".
2. В шапке макроса рэмить имя творца и ссылку на источник, либо ветку обсуждения.
Last edited by AleXH on Fri 18 Jul, 2014 08:12, edited 1 time in total.

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

Re: Макросы: Система их названий и описаний

Post by Skirda » Fri 27 Jun, 2014 07:16

Аля шапки для userscript?
We are the Borg. You will be assimilated.
So Say We All!

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

Re: Макросы: Система их названий и описаний

Post by John Doe » Fri 27 Jun, 2014 08:00

AleXH
Речь о штатных макросах из Addons?
Или вы предлагаете какое-то общее соглашение?

AleXH
Posts: 1000
Joined: Sun 12 Apr, 2009 05:21
Been thanked: 1 time

Re: Макросы: Система их названий и описаний

Post by AleXH » Fri 27 Jun, 2014 08:31

Я только предлагаю и, естественно, ни на чём не настаиваю, просто высказываю соображения.

Да, общее соглашение, придерживаясь которого можно придать макросам в дистрибе и собственным наработкам более "цивилизованный" вид (менее кустарный). Плюс открыл скрипт и сразу будет видно кто создал скрипт и где смотреть его обновления, либо обсуждение его работы, глюков и тд.

Skirda, пару строк в начале скрипта, затем уже описание, если оно есть.

John Doe, в штатных скриптах в Addons в названиях использованы глаголы "View" и "Edit", хотя принято использовать существительные, а главное области действия называются "Viewer", "Editor", "Panel" и тд.

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

Re: Макросы: Система их названий и описаний

Post by John Doe » Fri 27 Jun, 2014 09:21

Что касается макросов из Addons, то пока только 6 из них имеют собственные темы для обсуждения.
Согласен что в комментариях url будет уместен.

Авторство большинства макросов установить проблематично, да и нужно ли.

С именами файлов не всё просто.
В некоторых случаях в имени используется имя клавиш(и), в некоторых выполняемое действие.

В одном файле могут находится макросы, запускаемые из разных макрообластей (во многих например аж 6).

Не всегда исходная макрообласть отражает смысл макроса. Например я бы сказал, что макрос Search.CtrlIns.lua предназначен для панелей.

Обратите внимание, что в шапке я когда-то выкладывал макросы, разложенные по папкам.

Code: Select all

Edit&View
Menu
Misc
Screens
Shell
P.S.
Исходя из этого считаю что префиксы условны, и не вижу особого смысла переименовывать в Editor/Viewer.

User avatar
HaRT
Moderator
Posts: 9088
Joined: Tue 30 Aug, 2005 17:21
Location: Санкт-Петербург
Has thanked: 90 times
Been thanked: 157 times

Re: Макросы: Система их названий и описаний

Post by HaRT » Fri 27 Jun, 2014 15:28

AleXH
Зачем нужна конвенция для именования файлов с макросами, я ещё могу понять, хотя, как справедливо отмечено выше, с осуществлением не всё так прямолинейно.
А вот какая-то стандартизованная „шапка“ нужна, на мой взгляд, только для макросов из комплекта поставки. Из „независимых“ же скриптописателей кто захочет, тот и последует принятым соглашениям.
В любом случае, прежде чем выдумывать собственную конвенцию с нуля, хорошо бы рассмотреть популярные существующие; например, используемую в скриптах для GreaseMonkey (см., напр., OpenUserJS.org и UserScripts.org).
Фар есть инструмент, а не нянька. © 2009 DrKnS

AleXH
Posts: 1000
Joined: Sun 12 Apr, 2009 05:21
Been thanked: 1 time

Re: Макросы: Система их названий и описаний

Post by AleXH » Wed 02 Jul, 2014 21:37

Это необязательное соглашение, но если первые 4 строки в скрипте:
  1. -- HaRT (c) :)
  2. -- http://....
  3. -- описание скрипта
  4.  
  5. сам код скрипта
, то хоть понятно что это, откуда это и для чего это. Да, много скриптов бесхозных или собирательных, они могут оставаться и дальше анонимными, но новые хорошо бы окультурить. Сейчас John Doe приводит в порядок скрипты в Addons - имхо справедливо, если бы в шапке стоял бы его ник.

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

Re: Макросы: Система их названий и описаний

Post by John Doe » Wed 02 Jul, 2014 22:14

Описание у всех макросов есть.
Ссылки для нескольких макросов проставить можно.
А имена героев — вот здесь.

AleXH
Posts: 1000
Joined: Sun 12 Apr, 2009 05:21
Been thanked: 1 time

Re: Макросы: Система их названий и описаний

Post by AleXH » Wed 02 Jul, 2014 22:37

Полностью согласен, что героям самим решать, где им быть - на виду, или за углом.

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

Re: Макросы: Система их названий и описаний

Post by John Doe » Fri 04 Jul, 2014 23:37

Подумалось, что в LuaMacro можно сделать команду для регистрации скрипта, в которой (помимо уникального идентификатора) можно указать и прочие стандартные сведения:
  1. regscript {
  2.   name = "Macro Browser alt.",
  3.   author = "JD",
  4.   description = "Альтернативный обозреватель макросов",
  5.   version = "1.3",
  6.   url = "http://forum.farmanager.com/viewtopic.php?f=15&t=7964",
  7.   uid = "C5CB672A-104B-4402-B501-B31FC34714D0",
  8. }

AleXH
Posts: 1000
Joined: Sun 12 Apr, 2009 05:21
Been thanked: 1 time

Re: Макросы: Система их названий и описаний

Post by AleXH » Sat 05 Jul, 2014 12:49

Предлагаю ещё одно поле - nick:
  1. regscript {
  2.   nick = "MBA",
  3.   name = "Macro Browser alt.",
  4.   description = "Альтернативный обозреватель макросов",
  5.   version = "1.3",
  6.   author = "JD",
  7.   url = "http://forum.farmanager.com/viewtopic.php?f=15&t=7964",
  8.   uid = "C5CB672A-104B-4402-B501-B31FC34714D0"
  9. }
Last edited by AleXH on Sat 05 Jul, 2014 14:21, edited 2 times in total.

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

Re: Макросы: Система их названий и описаний

Post by John Doe » Sat 05 Jul, 2014 12:54

Чем больше обязательных полей, тем меньше кому-то их захочется заполнять.

AleXH
Posts: 1000
Joined: Sun 12 Apr, 2009 05:21
Been thanked: 1 time

Re: Макросы: Система их названий и описаний

Post by AleXH » Sat 05 Jul, 2014 12:58

Достаточно ввести в движок фильтр соответствия стандарту и с подводной лодки уже никуда не деться :D

C другой стороны, если поля не заполнены, либо отсутствуют, то в общем списке MBA он будет выглядеть проигрышно по сравнению с правильно оформленными, что будет подталкивать автора сделать всё правильно.

К тому же, правильно заполнить поля - это мелочь по сравнению с написанием самого макроса.

IgorZ
Posts: 609
Joined: Wed 13 Jul, 2011 03:32
Has thanked: 9 times
Been thanked: 42 times

Re: Макросы: Система их названий и описаний

Post by IgorZ » Fri 11 Jul, 2014 06:55

Если уж вводить в движок, то удобнее всего было бы так:
  1. Macro {
  2.   info = {
  3.     shortname = "MBA"; -- такое название более конвенциональное
  4.     name = "Macro Browser alt.";
  5. --    description = "Альтернативный обозреватель макросов"; -- думаю, не нужно, есть основное
  6.     version = "1.3";
  7.     author = "JD";
  8.     url = "http://forum.farmanager.com/viewtopic.php?f=15&t=7964";
  9.     uid = "C5CB672A-104B-4402-B501-B31FC34714D0";
  10.     minfarversion = "3.0.4000"; -- весьма нужная информация. Может, появится и проверка при загрузке
  11.   };
  12.   area = ... -- дальше, как обычно
  13. }
Часть полей info может быть необязательной, часть обязательной. Вот не помню, как это у плагинов

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

Re: Макросы: Система их названий и описаний

Post by John Doe » Fri 11 Jul, 2014 10:09

IgorZ
Дело вот в чём: скрипт может определять 20 макросов. А может не определять ни одного.
Т.е. регистрировать скрипт целесообразнее независимо.

IgorZ
Posts: 609
Joined: Wed 13 Jul, 2011 03:32
Has thanked: 9 times
Been thanked: 42 times

Re: Макросы: Система их названий и описаний

Post by IgorZ » Mon 14 Jul, 2014 03:50

John Doe wrote:IgorZ
Дело вот в чём: скрипт может определять 20 макросов. А может не определять ни одного.
Т.е. регистрировать скрипт целесообразнее независимо.
Но регистрируются в Far-е макросы, а не скрипты. В общем, неоднозначный вопрос, согласен. Идея моего предложения заключалась в том, чтобы ещё больше приблизить макросы к плагинам. Поскольку по возможностям они уже почти сравнялись.

Post Reply

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