[hwd]

Выкладываю свой вариант шаблона оформления плагинов AutoCAD. В прикреплённом архиве находится упакованный архив чистого шаблона и CHM-файл, в котором подробно разжёвано всё, что касается работы с данным шаблоном. Если кратко, то в основу шаблона положены следующие моменты:

• Ориентация на коллективную работу
• Самодокументирование приложения
• Автоматическая синхронизация содержимого документации в соответствии с состоянием настроек
• Простая возможность расширения существующего перечня локализаций
• Возможность программной/пакетной обработки плагинов
• Получение исчерпывающей информации о приложении открытием файла readme.html
• Управление сразу всеми имеющимися версиями приложения (скомпилированными под разные AutoCAD)

Если ещё более кратко, то шаблон построен на связке XML + XSD + XSLT.

Конструктивные замечания/пожелания приветствуются. Могу выложить примеры плагинов, упакованных в данный шаблон, но это уже не сегодня.

UPD. Обновил архив - исправил серьёзную опечатку и добавил пример группирования и отображения команд.

UPD2. Завернул в шаблон программу Александра Ривилиса. Прикреплён внизу как DwgConvert.zip. Нужно распаковать архив и открыть файл readme.html.

UPD3. Перезалил оба архива. Внёс в шаблон некоторые правки, касающиеся визуального отображения, добавил в оглавление readme.html ещё один раздел, с помощью которого можно попадать в каталог нужной версии программы. Внёс изменения в chm-файл мануала.

UPD4. Перезалил оба архива. Внёс в шаблон некоторые правки, касающиеся визуального отображения, а так же расширил логику динамического формирования панели навигации readme.html - теперь в него можно добавлять произвольное количество групп с произвольным количеством позиций (помимо уже существующих). Частично изменил структуру и содержимое каталогов, например - в каталоге ./support находится только то, что не требует изменения (т.е. разработчику туда можно не заглядывать). Внёс соответствующие изменения в chm-файл мануала. Соответственно изменённому шаблону модифицировал пример приложения, построенного в соответствии с шаблоном.

UPD5. Перезалил оба архива. В шаблоне внёс изменение в файл appinfo.xslt, чтобы в таблицах имена команд, каталогов и файлов выделялись жирным шрифтом (так их легче читать), а так же исправил одну опечатку. Во второй архив добавил ещё два примера. Всё, более примеров выкладывать не буду - достаточно трёх.

UPD6. Перезалил оба архива. В шаблонах внёс некоторые изменения в файлы XSD, а так же в файл versions.xml, для возможности корректного описания LISP-программ. В архив samples, по просьбам телезрителей добавил пример упаковки LISP-сборника. В тот же архив упаковал и ещё одно приложение от Александра Ривилиса. В примере упаковки LISP-программ я, в качестве опять же примера, в таблицу загрузок добавил несколько записей, указав, что загружать следует все файлы с расширениями lsp, fas и vlx, хотя на самом деле в примере имеются только lsp-файлы.

[gomer]

улыбнуло

[hwd]

Сообщение от gomer улыбнуло

Как-то быстро тебя "улыбнуло", там в одной только документации 68 листов.

[Askarov]

Ниче не понял

[gomer]

Сообщение от hwd Как-то быстро тебя "улыбнуло"

не потому ли мегософтверные гиганты запихивают свои так называемые лицензионные соглашения в текстовый формат, чтоб их мог прочитать даже самый тупой юзер
зачем юзеру версия модуля, которую он не сможет подгрузить?
может не прав, но каталог bin - пережиток прошлого, атавизм дос, а вот где папка Help не понятно
насчет "правильного" решения... программист на лисп просто зашьет текстовый файл в модуль vlx и будет читать оттуда
насчет настроек... тут дело вкуса, реестр, ini, xml у каждого свои плюсы и минусы
насчет автоматической правки справки, ну, да, большая лень - реактивный двигатель прогресса
имхо. как-то уж слишком много эксэмеля...

[hwd]

2 gomer
ты ничего не понял.

[Do$]

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

[ShaggyDoc]

hwd, ты все правильно сделал. Такая система, безусловно, нужна. Вот только кому?

Само собой, что в первую очередь себе. Ты её будешь придерживаться и будешь делать хорошие, унифицированные "плагины" (как ты их называешь).

А ещё кому? Много ли у нас .NET-программистов? Много ли "всяких разных" программистов, работающих именно в MS Visual Studio 2010? Чтобы XSD и XSLT использовать? Можешь хотя бы оценочно назвать количество? 1? 10? 100000?

Или у тебя есть фирма с кучкой .NET-программистов? Которых надо "привести к общему знаменателю"?

А много ли таких "плагинов" вообще сделано? Хотя бы лично тобой? В России? В мире? Сколько именно, хотя бы примерно?
Можно примерный тематический список? А много ли таких плагинов сваливается на "адмнистраторов САПР" со стороны? Много ли таких "администраторов" вообще? 1? 10? 100000?

И какого уровня эти "плагины", чтобы на них затрачивать такие усилия по унификации и документированию? Уровня "dellayer" или, например, 3D-моделирования "чего угодно", или хотя бы уровня СПДС? А то вот мне попадалось .NET-приложение, которое ажно IP-адрес машины определяет и выводит в красивой рамочке.

Думаю, что эта, в принципе очень полезная работа, пока делается с прицелом на далекое-далекое будущее. Но тогда её надо на китайском документировать. А остальным пока "не в коня корм". Хотя я бы порекомендовал всем, кто берется за .NET-программирование, придерживаться этого "шаблона". Даже для "Hello Word".

По сути же шаблона мне кажется, что здесь обязательно должен быть и "шаблон" сценария инсталлятора.

В конце концов даже полумифического Администратора САПР не должны интересовать внутренние потроха "плагина". Он (или доверенный пользователь) должен просто запустить инсталлятор, который сам разложит все компоненты "куда положено", запишет в настройки "что надо", вставит необходимое в меню AutoCAD.

Чтобы пользователю только оставалось нажимать кнопки и получать райское наслаждение.

[hwd]

Само собой, что в первую очередь себе. Ты её будешь придерживаться и будешь делать хорошие, унифицированные "плагины" (как ты их называешь). А ещё кому? Много ли у нас .NET-программистов? Много ли "всяких разных" программистов, работающих именно в MS Visual Studio 2010? Чтобы XSD и XSLT использовать? Можешь хотя бы оценочно назвать количество?

Этот шаблон создан не с прицелом на .NET - его можно использовать и для приложений написанных на Auto LISP, Visual LISP, VBA. В файле справки я писал, что рекомендую править XML файлы в IDE MS Visual Studio 2010, но на самом деле не принципиально в чём вы будете их править, но будет весьма удобно, если используемый вами редактор поддерживает проверку валидности XML на соответствие подключенных к нему XSD файлов. Я понимаю, что те, кто пишет на VBA или LISP не смогут воспользоваться указанной мною IDE, но они смогут использовать любую другую по их усмотрению.

Насчёт "кому это нужно" - это нужно и организации и пользователям, хотя они этого могут и не осознавать. Поясню... Если оформление приводится к единому знаменателю, то и пользователям будет проще работать с ними, т.к. они знают, что открыв readme.html они найдут всё, что им нужно. Более того - они уже знают, где именно в readme.html им следует искать интересующую их информацию. Такое оформление позволяет создавать приложения, которые управляли бы уже существующими плагинами и теми, которые появятся позднее. Например, можно написать приложение, которое отобразит пользователю полный перечень ключевых слов и словосочетаний, ассоциированных с командами, написанными во всех плагинах, построенных на основе шаблона. Юзер выбирает то, что ему нужно и автоматом будут открываться в браузере нужные страницы справок соответствующих плагинов с указанием команд, соответствующих его выбору. Т.о. пользователь может искать нужный ему функционал, не перелопачивая для этого кучу имеющихся приложений.

А много ли таких "плагинов" вообще сделано? Хотя бы лично тобой? В России? В мире? Сколько именно, хотя бы примерно?

Вы не поняли меня. Данный шаблон - представляет собой вариант обёртки, в которую можно упаковывать не только новые, но и уже существующие программы, используемые в организации. При этом писать код не потребуется - нужно просто внести в шаблон нужную информацию о программе. Чуть позже я покажу примеры упакованных в этот шаблон приложений. Это приложения написанные на ObjectARX, Auto LISP, Visual LISP и .NET. Я упакую в него приложения Александра Ривилиса, VVA, ну и парочку своих. Выложу их для наглядности, чтобы на конкретных примерах можно было пощупать как это работает.

По сути же шаблона мне кажется, что здесь обязательно должен быть и "шаблон" сценария инсталлятора.

Инсталлятор невозможен в принципе. Это ведь не приложение, а лишь обёртка. Каждый разработчик для своего приложения может создавать различного рода иерархию файлов и каталогов. Чтобы завернуть это в шаблон, нужно понимать, что делаешь. Если, к примеру, автор в текстовом файле всё в одном месте прописал: перечень команд, системные требования и т.п., то как инсталлятор узнает где какая информация и выдернет её, чтобы заполнить в шаблон? Сейчас ведь все пишут как им Бог на душу положит, а значит упаковку каждого приложения придётся делать вручную. Да, это придётся сделать один раз, но много времени это не займёт и оно того стоит (имхо). И ещё - упаковкой занимается не пользователь, а разработчик! Т.е. он сам своё творение упаковывает в шаблон. Пользователь юзает готовый результат. Если упаковывать нужно и чужой код, который уже имеется у юзеров, то этим может заняться администратор CAD или человек, выполняющий его обязанности.

И какого уровня эти "плагины", чтобы на них затрачивать такие усилия по унификации и документированию?

это приложения, которые написаны в самой компании, либо притащенные юзерами из инета.

То, что я выложил в топике - это предложенный мною вариант оформления программ, написанных для AutoCAD. Если получаю плагин, оформленный в соответствии с данным шаблоном, то точно знаю, что скопировав его в нужный каталог мне более ничего делать не придётся, т.к. автозагрузчик далее сам разберётся каким пользователям, что и для какой версии автокада следует загружать для того, чтобы плагин заработал.

Я не утверждаю, что это панацея. Это всего лишь один из готовых, уже работающих вариантов. Я отдаю себе отчёт в том, что основная масса программистов не интересуется подобными темами (к сожалению), а из тех, кто интересуется - далеко не все правильно поймут то, что я предложил (скорее всего в виду сумбурности моего изложения). Но возможно, что найдутся и такие, кого обозначенная тема заинтересует и предоставленный мною материал будет полезен.

Чуть позднее я в этом топике выложу примеры приложений, упакованных в обозначенный шаблон. Если и это не поможет понять суть шаблона, значит не дано мне понятно излагать свои идеи.

[ShaggyDoc]

но будет весьма удобно, если используемый вами редактор поддерживает проверку валидности XML на соответствие подключенных к нему XSD файлов.

А ты знаком хоть с каким-то таким редактором? Я их вроде бы все испробовал. И ничего лучше обычного Notepad ++ не обнаружил.
XSD придумала Microsoft сначала для себя. Потом этот стандарт признали. Но без него прекрасно можно обойтись, что подавляющее большинство программистов и делает. Как и без MSXML обходятся.

Вот я сейчас заканчиваю программу, в которой должен быть экспорт в XML на основе 24 вложенных XSD. Пробовал с MSXML, раз уж он XSD поддерживает, и отказался. Слишком все по-Майкросовтовски неуклюже получается. Но это несущественные детали.

Так как все-таки насчет количества Net-приложений и Net-программистов? "Скока в штуках"?

[hwd]

Сообщение от ShaggyDoc А ты знаком хоть с каким-то таким редактором? Я их вроде бы все испробовал. И ничего лучше обычного Notepad ++ не обнаружил.

дома я часто использую Notepad++. Вы можете подгрузить к нему модуль, который будет проверять ваш XML файл на предмет валидности для указанного вами XSD - я себе его подгрузил и регулярно использую. Работать с XML можно и в бесплатной MS Visual Studio Express, либо в MonoDevelop, SharpDevelop - было бы желание. Те, кто хотят - ищут возможности, а те кто не хочет... их никто не заставляет.

Сообщение от ShaggyDoc XSD придумала Microsoft сначала для себя. Потом этот стандарт признали. Но без него прекрасно можно обойтись, что подавляющее большинство программистов и делает. Как и без MSXML обходятся.

Я никого не заставляю использовать XML. В шаблоне я его использую, поскольку в некоторой степени владею этими технологиями XML, XSD, XSLT, и отдаю себе отчёт в том, какими возможностями они обладают. Вести религиозные войны на тему того, что XML зло, а ini - добро, я не хочу, поскольку это бессмысленно.

Сообщение от ShaggyDoc Так как все-таки насчет количества Net-приложений и Net-программистов? "Скока в штуках"?

В нашей компании я единственный программист. Сколько написал программок для пользователей - не считал, и считать не собираюсь.

UPD Завернул в шаблон программу Александра Ривилиса. Прикреплён в самом первом сообщении топика как DwgConvert.zip. Нужно распаковать архив и открыть файл readme.html.

UPD2 Перезалил оба архива. Внёс в шаблон некоторые правки, касающиеся визуального отображения, добавил в оглавление readme.html ещё один раздел, с помощью которого можно попадать в каталог нужной версии программы. Внёс изменения в chm-файл мануала.

[gomer]

Сообщение от hwd основная масса программистов не интересуется подобными темами

Конечно, нам же удобнее писать абы как, с учетом цейтнота, привязывая свои мега творения к диску с буквой зю

Сообщение от hwd притащенные юзерами из инета

ну, таким товарищам никакой менеджер не нужен, они себе кнопку нарисуют и будут пользоваться, хоть котом в мешке

Сообщение от hwd Я никого не заставляю использовать XML

не заставляете, но настойчиво предлагаете ^_^

Сообщение от hwd Сколько написал программок для пользователей - не считал, и считать не собираюсь.

трудно понимаемая фраза в контексте всего вышесказанного

Сообщение от ShaggyDoc "Скока в штуках"?

как минимум мод+ от модиса, а больше я и не знаю... творение сие, хоть и жутко недопиленное и абы как талантливое, но работоспособное и весьма перспективное

Сообщение от hwd Если оформление приводится к единому знаменателю, то и пользователям будет проще работать с ними, т.к. они знают, что открыв readme.html они найдут всё, что им нужно. Более того - они уже знают, где именно в readme.html им следует искать интересующую их информацию.

как тупому юзеру мне не хочется знать таких сложных вещей, я знаю кнопку F1, в любой момент я ее могу нажать и хочу получить информацию о команде, че де и как, В автокаде есть такая возможность, правда не все программисты ее используют, а вы про программы, управляющие программами, а как насчет нажать Alt+Я и Ф и получить окошко Конструктора Ферм? У кого есть такое? А как насчет нормального редактора псевдонимов команд?

Сообщение от hwd автозагрузчик далее сам разберётся каким пользователям, что и для какой версии автокада следует загружать для того, чтобы плагин заработал.

те есть открываю я автокад, а мне дюжина сообщений, мол не хотите ли ознакомиться возможностями новых модулей принесенных Васей Пупкиным из инета? и вот я сижу закрываю эти окошки ознакамливаюсь с возможностями (как вариант просто забываю про них), а время то течет и все 10 автокадов на моей машине ждут моих рук...
Кстати автодеск вроде уже добавила возможность скачивания модулей из песочницы, ну и как бороться с такими нестандартными приложениями?

[hwd]

2 gomer
то, что я предложил в начале топика - это готовый результат, который можно пощупать. то, что ты написал выше - это словоблудие. тебя никто не заставляет использовать это. адресовано тем, кому интересно.

[gomer]

Сообщение от hwd то, что ты написал выше - это словоблудие

У мну ридми не открылся пришлось все выкладывать на диск...
hwd, поражаюсь вашему трудолюбию
я вот грешным делом подумывал сложить библиотечки А.Ривилиса в папочку {MyApp} сделать менюшку {MyApp.mns}, прописать макросы и подсказки, прописать загрузку библиотечек в {MyApp.mnl} и добавить папку {MyApp} в пути поддержки... и было б мне счастье, да вот как-то руки не доходят, хотя на все про все у мну вышло бы пол часа времени, максимум

[hwd]

ключевой момент не то, что всё собрано в readme.html, а то, что всю информацию о приложении можно получить программно, т.к. шаблон представляет собой своего рода типовой интерфейс.

[gomer]

а разве нельзя программно извлекать инфу из самой библиотеки, это самая достоверная информация: производитель, версия, язык, описание...

[hwd]

Сообщение от gomer а разве нельзя программно извлекать инфу из самой библиотеки, это самая достоверная информация: производитель, версия, язык, описание...

Вот некоторый список вопросов:

1. как ты из них извлечёшь информацию о том, нужно ли в File Search Path добавлять каталоги поиска, и если нужно, то какие?
2. Как ты из них узнаешь, регистрируют ли они сами себя в реестре на предмет автозагрузки (чтобы не грузить то, что и без тебя будет грузиться)?
3. Как ты узнаешь, какие именно из библиотек нужно загружать и в какой последовательности? ведь нередко грузить нужно одну-две, а уже те, в свою очередь, тянут остальные вагоны.
4. Как ты узнаешь перечень определённых в библиотеке команд и ключевых слов, связанных с ней?

[gomer]

1. Все равно придется добавлять по определению
2. и 3. это разные весчи: одиночный модуль, которому вовсе не нужна автозагрузка (а если она есть, то это тот еще гемор) и комплексный вагон, который монополизирует автокад и сам себя контроллирует, на программном, а не файловом уровне
4. вопрос не ко мне... но как то же автокад это делает

[Дима_]

Я думаю пока ты (или еще кто) не напишешь гуишку для "полуавтоматической" обертки такой "сопроводиловкой" + программу для автоматической установки/манипулирования софта(ом), на его основе, количество человек пользующимся твом шаблоном будет стремиться к единице. Ибо разбираться в кучке чужих XML'ов - никто на это время тратить не будет - Крыс как-то предлагал, весьма толковый и НЕСЛОЖНЫЙ "формат" оформления лисп программ - им и то, по факту, больше ни кто не пользуеться, а уж это творение и подавно. Скажу, честно, я хоть и прекрасно умею пользоваться XML'ом - искренне считаю, что это формат НЕ ДЛЯ РУЧНОЙ ПРАВКИ - только софтовой, оно-же как и весь "софт" предолагающий изменение настроек "дружелюбным" XML редактором - есть "сыроделка."

[ShaggyDoc]

как ты из них извлечёшь информацию о том, нужно ли в File Search Path добавлять каталоги поиска, и если нужно, то какие?

Правильная программа с инсталлятором сделает это сама

Как ты из них узнаешь, регистрируют ли они сами себя в реестре на предмет автозагрузки (чтобы не грузить то, что и без тебя будет грузиться)?

Правильная программа с инсталлятором сделает это сама

Как ты узнаешь, какие именно из библиотек нужно загружать и в какой последовательности? ведь нередко грузить нужно одну-две, а уже те, в свою очередь, тянут остальные вагоны.

Правильная программа с инсталлятором сделает это сама

Как ты узнаешь перечень определённых в библиотеке команд и ключевых слов, связанных с ней?

Правильная программа с инсталлятором сделает это сама. Сделает нормальное меню, панели инструментов. А "перечень команд" будет в этом меню. А перечень "ключевых слов" будет выводиться при работе в командной строке и в контекстном меню. И в правильной программе имеется правильный файл справки, который не надо где-то разыскивать.

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

Инсталлятор невозможен в принципе

Это самое большое твое заблуждение. Так как

В нашей компании я единственный программист. Сколько написал программок для пользователей - не считал, и считать не собираюсь.

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