Автор Тема: DH - Dynamic Help  (Прочитано 6738 раз)

0 Пользователей и 1 Гость просматривают эту тему.

Оффлайн gregaz [?]

  • AutoIt Гуру
  • *****
  • Сообщений: 1166
  • Репутация: 298
  • Пол: Мужской
    • Награды
DH - Dynamic Help
« Создано: Сентябрь 24, 2013, 18:15:31 »
AutoIt: 3.3.8.1
Версия: 1.2

Категория: Утилита

Описание: Утилита предназначена для создания динамического Help'a нескольких UDF с возможностью быстрого переключения с одной на другую.
   В своей работе использует UDF : IniVirtual от Azjio.

Возможности:
   *   Создание дерева функций, использованных в UDF
         Варианты:
            - с разделением на разделы (регионы)
            - без разделения
   *   Возможность просмотра  Include-файлов, использованных в  UDF
   *   Возможность просмотра содержимого всего UDF
   *   Возможность просмотра содержимого отдельного раздела (региона) UDF (при наличии разделения на регионы в UDF)
   *   Возможность просмотра содержимого каждой отдельной функции
         Варианты просмотра :
            -   только содержание функции
            -   описание функции (с кратким содержанием функции)

            -   фрейм функции (описание + содержание)
   *   Возможность добавления новых UDF в Ini-базу
   *   Возможность удаления UDF из Ini-базы
   *   Возможность оперативного переключения с одной UDF Ini-базы на другую
            - Примечание. При этом отражаются все изменения , произошедшие в UDF
   *   Возможность просмотра любых AutoIt-скриптов.
        *      Возможность добавления файлов
        *      Возможность добавления папки
        *      Возможность Ресайза линией                   ( 28.09.2013 )
        *      Возможность форматирования au3-файла  (10.10.2013 )
Файл : Dynamic Help v0.4.1
            Dynamic Help v0.5  (Комплект в Архиве 7z) 28.09.2013
            Dinamic Help(SCI) v1.2    10.10.2013
История версий:
(нажмите для показа/скрытия)

Пример :
(нажмите для показа/скрытия)

Скриншот:
Нажмите для отображения изображения в оригинальном размере.

Источник: http://autoit-script.ru
Автор: gregaz
« Последнее редактирование: Октябрь 10, 2013, 18:10:37 от gregaz »
Самая большая проблема – её сформулировать. 

Русское сообщество AutoIt

DH - Dynamic Help
« Отправлен: Сентябрь 24, 2013, 18:15:31 »

Оффлайн CreatoR [?]

  • Администратор
  • *
  • Сообщений: 7827
  • Репутация: 2288
  • Пол: Мужской
  • AutoIt is simple, subtle, elegant
    • CreatoR's Lab
    • Награды
  • Версия AutoIt: 3.3.10.2
Re: DH - Dinamic Help
« Ответ #1, Отправлен: Сентябрь 24, 2013, 19:34:27 »
gregaz  [?]
Цитировать
Скриншот:
Следует прятать под тег thumb а не img, исправил.

По поводу названия. Если имелось в виду Динамический..., то правильнее Dynamic.
По поводу Полезняшки... это скорее пример, перенёс.


Правила, Поиск, Супер тема


AutoIt is simple, subtle, elegant.


«Не оказываю тех. поддержку через ПМ/ICQ, и по электронной почте - для этого есть форум. (C)»
«Законы Мэрфи неоспоримы!»


Мои работы

Оффлайн CreatoR [?]

  • Администратор
  • *
  • Сообщений: 7827
  • Репутация: 2288
  • Пол: Мужской
  • AutoIt is simple, subtle, elegant
    • CreatoR's Lab
    • Награды
  • Версия AutoIt: 3.3.10.2
Re: DH - Dinamic Help
« Ответ #2, Отправлен: Сентябрь 24, 2013, 19:44:16 »
А вообще полезная утилита получилась.

Из пожеланий:

* Добавить вкладки для открываемых файлов библиотеки (чтобы можно было переключаться между ними удобно).
* Вместо комментированного заголовка, выводить пропарсенный список.
* Если будет добавлено предыдущее, то можно ещё добавить поддержку редактирования заголовка функции.

Оффлайн gregaz [?]

  • AutoIt Гуру
  • *****
  • Сообщений: 1166

  • Автор темы
  • Репутация: 298
  • Пол: Мужской
    • Награды
Re: DH - Dynamic Help
« Ответ #3, Отправлен: Сентябрь 24, 2013, 21:09:06 »
CreatoR  [?]
Цитировать
* Добавить вкладки для открываемых файлов библиотеки (чтобы можно было переключаться между ними удобно).
Имеется ввиду заменить элементы Radio вкладками подобно обычной справке ?

Цитировать
Вместо комментированного заголовка, выводить пропарсенный список.
А что это даст ?
Идея создания утилиты была в том, чтобы иметь возможность оперативно просмотреть описания ф-ий, в какой бы форме они не присутствовали в UDF.
Ведь не секрет то, что у авторов UDF ,  особого желания создавать справку к ней не замечается (за редким исключением).
Описания к функциям составляют по разному, что затруднит парсинг.
Можно наверное обрабатывать описания стандартной формы, а остальные выдавать без обработки.
 

Русское сообщество AutoIt

Re: DH - Dynamic Help
« Ответ #3 Отправлен: Сентябрь 24, 2013, 21:09:06 »

Оффлайн AZJIO [?]

  • VIP
  • *
  • Сообщений: 2725
  • Репутация: 1140
    • мой сайт
    • Награды
  • Версия AutoIt: 3.3.8.1
Re: DH - Dynamic Help
« Ответ #4, Отправлен: Сентябрь 24, 2013, 23:27:52 »
gregaz
Не понял откуда, но у меня появился файл Date.au3 в списке, а в ini строка "Date.au3=Date.au3" (без пути) и при клике на нём AutoIt3 падает. Нормально, хотя в 3.3.9.21 заголовочную информацию вырезают, скоро там не будет описание функций.
Последнее время я делаю прыжок к функции и смотрю описание и код. Оно есть в SciTE.

При первом запуске не плохо бы определить путь к Include и предоставить выбор файлов оттуда.

Оффлайн CreatoR [?]

  • Администратор
  • *
  • Сообщений: 7827
  • Репутация: 2288
  • Пол: Мужской
  • AutoIt is simple, subtle, elegant
    • CreatoR's Lab
    • Награды
  • Версия AutoIt: 3.3.10.2
Re: DH - Dynamic Help
« Ответ #5, Отправлен: Сентябрь 25, 2013, 00:38:51 »
gregaz  [?]
Цитировать
Имеется ввиду заменить элементы Radio вкладками подобно обычной справке ?
Нет, просто убрать Active и подобное, вместо этого позволить загружать более одной библиотеки одновременно.
Подобно открытию множества файлов в текст. редакторе.

Цитировать
А что это даст ?
Удобочитаемость как минимум, а как максимум(?) см. третьи пункт в моём списке :).

Цитировать
Идея создания утилиты была в том, чтобы иметь возможность оперативно просмотреть описания ф-ий, в какой бы форме они не присутствовали в UDF.
Ничего не мешает добавить опцию в настройки, где будет указан режим вывода заголовка.

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

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

Оффлайн joiner [?]

  • Расмус-бродяга
  • AutoIt Гуру
  • *****
  • Сообщений: 2797
  • Репутация: 472
  • Пол: Мужской
    • Награды
  • Версия AutoIt: 3.3.12.0
Re: DH - Dynamic Help
« Ответ #6, Отправлен: Сентябрь 25, 2013, 01:13:01 »
AZJIO  [?]
Цитировать
При первом запуске не плохо бы определить путь к Include и предоставить выбор файлов оттуда.
тут поддерживаю. сделать выбор папки с библиотеками. а в одиночном выборе , все-таки, включить возможность выбора нескольких библиотек.
и по внешнему виду - при запуске программы как х86 на системе х64 нет значков в колонке со списком функций. если программу запустить как х64, то значки как на скрине. так и должно быть? они пропадают при обновлении. точнее некоторые.



Добавлено: Сентябрь 25, 2013, 06:26:51
я для себя чуть переделал меню и функции выбора папки или файла библиотеки
меню:
(нажмите для показа/скрытия)

функции:
(нажмите для показа/скрытия)
« Последнее редактирование: Сентябрь 25, 2013, 06:26:51 от joiner, Причина: Объединение сообщений »
Были времена, когда солнце было ярче, трава зеленее, а водка сорокоградуснее

Оффлайн gregaz [?]

  • AutoIt Гуру
  • *****
  • Сообщений: 1166

  • Автор темы
  • Репутация: 298
  • Пол: Мужской
    • Награды
Re: DH - Dynamic Help
« Ответ #7, Отправлен: Сентябрь 25, 2013, 10:00:04 »
Всем спасибо за замечания.
В принципе здесь я хотел показать саму идею, а не способ реализации, который оставляет желать лучшего.
Круг выполняемых задач можно расширять.
Я предполагал выполнить добавление папок (спасибо joiner).
Можно добавить папку Избранное
Можно добавить и тематические папки
Несложно выполнить это на Scintilla, что позволит использовать Folding и расцветку тегов.
Не знаю стоит ли усложнять ?

Одно замечу : .
Даже при отсутствии описания часто приходится заглядывать в UDF для просмотра формата параметров ф-ии и возвращаемого значения.
Для этого достаточно первой и предпоследней строки ф-ии.

Особенно это касается  самопальных UDF, которые мы используем.
Именно для просмотра этих UDF я и предполагал использовать Dynamic Help
Попутно появилась возможность просмотра стандартных UDF.

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


Добавлено: Сентябрь 25, 2013, 10:12:40
Если есть желающие, предлагаю принять участие в модернизации утилиты.
« Последнее редактирование: Сентябрь 25, 2013, 16:35:45 от gregaz, Причина: Объединение сообщений »

Русское сообщество AutoIt

Re: DH - Dynamic Help
« Ответ #7 Отправлен: Сентябрь 25, 2013, 10:00:04 »

Оффлайн joiner [?]

  • Расмус-бродяга
  • AutoIt Гуру
  • *****
  • Сообщений: 2797
  • Репутация: 472
  • Пол: Мужской
    • Награды
  • Версия AutoIt: 3.3.12.0
Re: DH - Dynamic Help
« Ответ #8, Отправлен: Сентябрь 25, 2013, 11:22:03 »
gregaz  [?]
Цитировать
В принципе здесь я хотел показать саму идею
сама идея хороша. во всяком случае, для меня. я частенько просматриваю включаемые библиотеки через редактор скриптов. а тут можно открыть уже целое хранилище.
что очень хотелось бы увидеть, так это раскраску кода в программе.
добавить возможность редактирования скриптов в окне программы. ведь можно добавить в базу и свои скрипты. почему бы нет? :)
думаю что стоит продолжать улучшать программу. как дополнительный инструмент AutoIT.

Оффлайн gregaz [?]

  • AutoIt Гуру
  • *****
  • Сообщений: 1166

  • Автор темы
  • Репутация: 298
  • Пол: Мужской
    • Награды
Re: DH - Dynamic Help
« Ответ #9, Отправлен: Сентябрь 25, 2013, 14:31:12 »
Обновил до v0.4.1

v0.4.1 -    25.09.2013     
            * Добавлена возможность добавления нескольких UDF (Joiner)
            * Добавлена возможность всех UDF каталога (Joiner)
            * Изменен принцип установки иконок на TreeView
            * Устранены мелкие недостатки



Добавлено: Сентябрь 25, 2013, 14:33:47
AZJIO  [?]
Цитировать
Не понял откуда, но у меня появился файл Date.au3 в списке, а в ini строка "Date.au3=Date.au3" (без пути) и при клике на нём AutoIt3 падает

Откуда появилась не могу понять , если падает при двойном клике, то это я устранил проверкой на существование файла.
А при одинарном вообще не должен был???

Оффлайн AZJIO [?]

  • VIP
  • *
  • Сообщений: 2725
  • Репутация: 1140
    • мой сайт
    • Награды
  • Версия AutoIt: 3.3.8.1
Re: DH - Dynamic Help
« Ответ #10, Отправлен: Сентябрь 25, 2013, 14:38:53 »
gregaz  [?]
Цитировать
Если есть желающие, предлагаю принять участие в модернизации утилиты.
Я пока такие же действия выполняю через свою утилиту JumpToString или через плагин к Notepad++ - FunctionList.dll оба они выдают список функций и по клику делают переход к функции для её просмотра, а также, как я говорил выше, и что это ещё лучше - выделить двойным кликом имя функции и вызвать горячую клавишу прыжок, автоматически открывает необходимый UDF и переходит к функции в ней. И просмотр сохраняет всю мощь редактора.
Поэтому пока не вижу необходимости выбирать иной способ просмотра описания функции.

Для SciTE аналогичное выполняют утилита SciTEJump и горячая клавиша Ctrl+J  "Jump To Function Prod" и возврат - "JumpBack"  Ctrl+Shift+J.
« Последнее редактирование: Сентябрь 25, 2013, 14:51:22 от AZJIO »

Оффлайн gregaz [?]

  • AutoIt Гуру
  • *****
  • Сообщений: 1166

  • Автор темы
  • Репутация: 298
  • Пол: Мужской
    • Награды
Re: DH - Dynamic Help
« Ответ #11, Отправлен: Сентябрь 25, 2013, 14:45:42 »
joiner  [?]
Цитировать
при запуске программы как х86 на системе х64 нет значков в колонке со списком функций. если программу запустить как х64, то значки как на скрине. так и должно быть?

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


[?]
Цитировать
что очень хотелось бы увидеть, так это раскраску кода в программе.

Чуть позже попробую представить (по крайней мере в личку, если нужно) . Есть у меня UDF по Scintille, но она не публиковалась, т.к. надо корректировать. Хотя сам пользуюсь давно.
Цитировать
добавить возможность редактирования скриптов в окне программы. ведь можно добавить в базу и свои скрипты.

Конечно можно, правда это уже вобщем то другой инструмент. Наверное все в одну кучу не стоит. А отдельным инструментом на этом принципе вполне





Добавлено: Сентябрь 25, 2013, 14:50:26
AZJIO  [?]
Цитировать
Для SciTE аналогичное выполняют SciTEJump и Ctrl+J  "Jump To Function Prod"
Цитировать
Поэтому пока не вижу необходимости выбирать иной способ просмотра описания функции.

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

Оффлайн AZJIO [?]

  • VIP
  • *
  • Сообщений: 2725
  • Репутация: 1140
    • мой сайт
    • Награды
  • Версия AutoIt: 3.3.8.1
Re: DH - Dynamic Help
« Ответ #12, Отправлен: Сентябрь 25, 2013, 14:57:26 »
gregaz  [?]
Цитировать
Если есть желающие, предлагаю принять участие в модернизации утилиты.
Ну вот ссылки подходящие
парсить au3 http://www.autoitscript.com/forum/topic/152146-au3-script-parsing-related-functions/
Code Scanner - http://www.autoitscript.com/forum/topic/153368-code-scanner/

Оффлайн joiner [?]

  • Расмус-бродяга
  • AutoIt Гуру
  • *****
  • Сообщений: 2797
  • Репутация: 472
  • Пол: Мужской
    • Награды
  • Версия AutoIt: 3.3.12.0
Re: DH - Dynamic Help
« Ответ #13, Отправлен: Сентябрь 25, 2013, 16:29:20 »
gregaz  [?]
Цитировать
В последней версии я немного изменил концепцию получения иконок.
теперь с иконками все нормально в любой битности запуска скрипта

Оффлайн gregaz [?]

  • AutoIt Гуру
  • *****
  • Сообщений: 1166

  • Автор темы
  • Репутация: 298
  • Пол: Мужской
    • Награды
Re: DH - Dynamic Help
« Ответ #14, Отправлен: Сентябрь 28, 2013, 11:58:17 »
Обновление:
v0.5 -    28.09.2013
     Добавлено :
          * Возможность добавления папки (всех UDF каталога)
          * Возможность Ресайза линией
          * Переключение форматов перенесено в Меню
          * Улучшен внешний вид
          * Устранены отдельные недостатки
« Последнее редактирование: Сентябрь 28, 2013, 14:53:37 от gregaz »

Русское сообщество AutoIt

Re: DH - Dynamic Help
« Ответ #14 Отправлен: Сентябрь 28, 2013, 11:58:17 »

 

Похожие темы

  Тема / Автор Ответов Последний ответ
1 Ответов
399 Просмотров
Последний ответ Июль 03, 2017, 16:02:20
от inververs