Скрипты: система их названий и описаний
Скрипты: система их названий и описаний
John Doe
Предлагаю "окультурить" систему названий макросов и принять следующие правила для оформления макросов:
1. Имя файла макроса должно начинаться с области действия. Кстати, в Addons в именах макросов почему-то использованы "Edit" и "View" вместо "Editor" и "Viewer".
2. В шапке макроса рэмить имя творца и ссылку на источник, либо ветку обсуждения.
Предлагаю "окультурить" систему названий макросов и принять следующие правила для оформления макросов:
1. Имя файла макроса должно начинаться с области действия. Кстати, в Addons в именах макросов почему-то использованы "Edit" и "View" вместо "Editor" и "Viewer".
2. В шапке макроса рэмить имя творца и ссылку на источник, либо ветку обсуждения.
Last edited by AleXH on Fri 18 Jul, 2014 08:12, edited 1 time in total.
Re: Макросы: Система их названий и описаний
Аля шапки для userscript?
We are the Borg. You will be assimilated.
So Say We All!
So Say We All!
- John Doe
- Бюрократ
- Posts: 13861
- Joined: Wed 27 Apr, 2005 20:42
- Has thanked: 74 times
- Been thanked: 428 times
- Contact:
Re: Макросы: Система их названий и описаний
AleXH
Речь о штатных макросах из Addons?
Или вы предлагаете какое-то общее соглашение?
Речь о штатных макросах из Addons?
Или вы предлагаете какое-то общее соглашение?
Re: Макросы: Система их названий и описаний
Я только предлагаю и, естественно, ни на чём не настаиваю, просто высказываю соображения.
Да, общее соглашение, придерживаясь которого можно придать макросам в дистрибе и собственным наработкам более "цивилизованный" вид (менее кустарный). Плюс открыл скрипт и сразу будет видно кто создал скрипт и где смотреть его обновления, либо обсуждение его работы, глюков и тд.
Skirda, пару строк в начале скрипта, затем уже описание, если оно есть.
John Doe, в штатных скриптах в Addons в названиях использованы глаголы "View" и "Edit", хотя принято использовать существительные, а главное области действия называются "Viewer", "Editor", "Panel" и тд.
Да, общее соглашение, придерживаясь которого можно придать макросам в дистрибе и собственным наработкам более "цивилизованный" вид (менее кустарный). Плюс открыл скрипт и сразу будет видно кто создал скрипт и где смотреть его обновления, либо обсуждение его работы, глюков и тд.
Skirda, пару строк в начале скрипта, затем уже описание, если оно есть.
John Doe, в штатных скриптах в Addons в названиях использованы глаголы "View" и "Edit", хотя принято использовать существительные, а главное области действия называются "Viewer", "Editor", "Panel" и тд.
- John Doe
- Бюрократ
- Posts: 13861
- Joined: Wed 27 Apr, 2005 20:42
- Has thanked: 74 times
- Been thanked: 428 times
- Contact:
Re: Макросы: Система их названий и описаний
Что касается макросов из Addons, то пока только 6 из них имеют собственные темы для обсуждения.
Согласен что в комментариях url будет уместен.
Авторство большинства макросов установить проблематично, да и нужно ли.
С именами файлов не всё просто.
В некоторых случаях в имени используется имя клавиш(и), в некоторых выполняемое действие.
В одном файле могут находится макросы, запускаемые из разных макрообластей (во многих например аж 6).
Не всегда исходная макрообласть отражает смысл макроса. Например я бы сказал, что макрос Search.CtrlIns.lua предназначен для панелей.
Обратите внимание, что в шапке я когда-то выкладывал макросы, разложенные по папкам.
P.S.
Исходя из этого считаю что префиксы условны, и не вижу особого смысла переименовывать в Editor/Viewer.
Согласен что в комментариях url будет уместен.
Авторство большинства макросов установить проблематично, да и нужно ли.
С именами файлов не всё просто.
В некоторых случаях в имени используется имя клавиш(и), в некоторых выполняемое действие.
В одном файле могут находится макросы, запускаемые из разных макрообластей (во многих например аж 6).
Не всегда исходная макрообласть отражает смысл макроса. Например я бы сказал, что макрос Search.CtrlIns.lua предназначен для панелей.
Обратите внимание, что в шапке я когда-то выкладывал макросы, разложенные по папкам.
Code: Select all
Edit&View
Menu
Misc
Screens
Shell
Исходя из этого считаю что префиксы условны, и не вижу особого смысла переименовывать в Editor/Viewer.
- HaRT
- Moderator
- Posts: 10866
- Joined: Tue 30 Aug, 2005 17:21
- Has thanked: 221 times
- Been thanked: 358 times
Re: Макросы: Система их названий и описаний
AleXH
Зачем нужна конвенция для именования файлов с макросами, я ещё могу понять, хотя, как справедливо отмечено выше, с осуществлением не всё так прямолинейно.
А вот какая-то стандартизованная „шапка“ нужна, на мой взгляд, только для макросов из комплекта поставки. Из „независимых“ же скриптописателей кто захочет, тот и последует принятым соглашениям.
В любом случае, прежде чем выдумывать собственную конвенцию с нуля, хорошо бы рассмотреть популярные существующие; например, используемую в скриптах для GreaseMonkey (см., напр., OpenUserJS.org и UserScripts.org).
Зачем нужна конвенция для именования файлов с макросами, я ещё могу понять, хотя, как справедливо отмечено выше, с осуществлением не всё так прямолинейно.
А вот какая-то стандартизованная „шапка“ нужна, на мой взгляд, только для макросов из комплекта поставки. Из „независимых“ же скриптописателей кто захочет, тот и последует принятым соглашениям.
В любом случае, прежде чем выдумывать собственную конвенцию с нуля, хорошо бы рассмотреть популярные существующие; например, используемую в скриптах для GreaseMonkey (см., напр., OpenUserJS.org и UserScripts.org).
Фар есть инструмент, а не нянька. © 2009 DrKnS
Re: Макросы: Система их названий и описаний
Это необязательное соглашение, но если первые 4 строки в скрипте:
, то хоть понятно что это, откуда это и для чего это. Да, много скриптов бесхозных или собирательных, они могут оставаться и дальше анонимными, но новые хорошо бы окультурить. Сейчас John Doe приводит в порядок скрипты в Addons - имхо справедливо, если бы в шапке стоял бы его ник.
Re: Макросы: Система их названий и описаний
Полностью согласен, что героям самим решать, где им быть - на виду, или за углом.
- John Doe
- Бюрократ
- Posts: 13861
- Joined: Wed 27 Apr, 2005 20:42
- Has thanked: 74 times
- Been thanked: 428 times
- Contact:
Re: Макросы: Система их названий и описаний
Подумалось, что в LuaMacro можно сделать команду для регистрации скрипта, в которой (помимо уникального идентификатора) можно указать и прочие стандартные сведения:
Re: Макросы: Система их названий и описаний
Предлагаю ещё одно поле - nick:
Last edited by AleXH on Sat 05 Jul, 2014 14:21, edited 2 times in total.
- John Doe
- Бюрократ
- Posts: 13861
- Joined: Wed 27 Apr, 2005 20:42
- Has thanked: 74 times
- Been thanked: 428 times
- Contact:
Re: Макросы: Система их названий и описаний
Чем больше обязательных полей, тем меньше кому-то их захочется заполнять.
Re: Макросы: Система их названий и описаний
Достаточно ввести в движок фильтр соответствия стандарту и с подводной лодки уже никуда не деться
C другой стороны, если поля не заполнены, либо отсутствуют, то в общем списке MBA он будет выглядеть проигрышно по сравнению с правильно оформленными, что будет подталкивать автора сделать всё правильно.
К тому же, правильно заполнить поля - это мелочь по сравнению с написанием самого макроса.
C другой стороны, если поля не заполнены, либо отсутствуют, то в общем списке MBA он будет выглядеть проигрышно по сравнению с правильно оформленными, что будет подталкивать автора сделать всё правильно.
К тому же, правильно заполнить поля - это мелочь по сравнению с написанием самого макроса.
Re: Макросы: Система их названий и описаний
Если уж вводить в движок, то удобнее всего было бы так:
Часть полей info может быть необязательной, часть обязательной. Вот не помню, как это у плагинов
- John Doe
- Бюрократ
- Posts: 13861
- Joined: Wed 27 Apr, 2005 20:42
- Has thanked: 74 times
- Been thanked: 428 times
- Contact:
Re: Макросы: Система их названий и описаний
IgorZ
Дело вот в чём: скрипт может определять 20 макросов. А может не определять ни одного.
Т.е. регистрировать скрипт целесообразнее независимо.
Дело вот в чём: скрипт может определять 20 макросов. А может не определять ни одного.
Т.е. регистрировать скрипт целесообразнее независимо.