A2 & Oberon » Программирование » Творческие идеи и проекты » Инструмент для создание справочной системы

Страниц (6): « 1 2 3 [4] 5 6 »
 

31. BohdanT - 06 Января, 2009 - 00:15:11 - перейти к сообщению
lit-uriy пишет:
надо все таки инструмент делать.

Если кто то сделает html шаблоны, то я за парутройку дней сделаю.

Для начала давайте напишем себе ТЗ. Хорошо
32. MaDzi - 06 Января, 2009 - 00:28:45 - перейти к сообщению
В MODULE-2 был файл определений .DEF. Вроде как и в Обероне (классическом) есть подобное, по крайней мере в JOB (компилятор оберона в байт-код) есть. Думаю нужно смотреть в этом направлении и вынимать информацию можно из символьных (sym) файлов. Нам ведь важно то что модуль экспортирует и совершенно не важно (пока) что у него внутри.
33. lit-uriy - 06 Января, 2009 - 00:34:27 - перейти к сообщению
BohdanT пишет:
Если кто то сделает html шаблоны
а зачем шаблоны?

BohdanT пишет:
Для начала давайте напишем себе ТЗ
ну смотри это

Там навигационная шапка на всех страницах должна быть
Вместо:
Главная · Все классы · Основные классы · Классы по группам · Модули · Функции
должно быть:
Главная · Все типы · Основные типы · Типы по группам · Модули · Функции

На странице Модули привести список всех модулей (*.Mod) (мой вариант )
когда на них щелкаешь, то попадаешь в описание как здесь (мой вариант там еще сделать список переменных и процедур модуля отдельно закрытых отдельно открытых)

При щелчке на тип новая страница на подобии описания классов (мой вариант )
34. BohdanT - 06 Января, 2009 - 00:36:22 - перейти к сообщению
MaDzi
Немного раньше в этой теме обсуждалось, что в исходниках Аос заложены элементы автодокументации.
Это коментарии (** в JavaDoc стиле. Т.е. необходимо пропарсить все исходники и создать дерево модулей и их элементов с коментариями...

Это относительно не сложно сделать, но нужны заготовки html кусков, в которые будет вставлятся "выдраная" документация и в результате будет формироваться html документация...

т.е. что типа:
Header.tpl Body.tpl Footer.tpl, стили, иконки и т.д.
(Добавление)
lit-uriy
Во...все правильно, нужны шаблоны, для каждого элемента, что бы прога не занималась вставкой html тегов, а только:
1. взять нужный шаблон
2. вснуть в шаблон нужный текст
3. записать результат в выходной текст
35. lit-uriy - 06 Января, 2009 - 00:44:41 - перейти к сообщению
BohdanT пишет:
Header.tpl Body.tpl Footer.tpl, стили, иконки и т.д.

я могу дать оригинальные Qt'шные (html-ки и CSS).
В принципе html-ки можешь сам взять, тут:
http://svn.assembla.com/svn/qt4rtt/qt-4.3.5
только прежде чем все извлекать, учти что весит каталог 97метров
Возможно удобнее окажется экспортировать отдельные файлы (тебе ж сведения о версиях не нужны), а имена файлов смотри на домене документации на кросплатф орме
36. BohdanT - 06 Января, 2009 - 00:46:47 - перейти к сообщению
lit-uriy пишет:
я могу дать оригинальные Qt'шные (html-ки и CSS).
В принципе html-ки можешь сам взять, тут:
http://svn.assembla.com/svn/qt4rtt/qt-4.3.5
только прежде чем все извлекать, учти что весит каталог 97метров
Возможно удобнее окажется экспортировать отдельные файлы (тебе ж сведения о версиях не нужны), а имена файлов смотри на домене документации на кросплатф орме


Вот с этим я и прошу помочь!
Во первых нужно подумать, какие фичи реализовывать, что бы взять только нужное!
37. lit-uriy - 06 Января, 2009 - 00:47:07 - перейти к сообщению
CSS'ка во вложении
(Добавление)
BohdanT пишет:
какие фичи реализовывать

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

Для описания модулей и типов структура страницы одна и таже (соответствует порядку описания в самом Oberon'е):

Типы
Открытые типы
Открытые типы только для чтения
Закрытые типы

Свойства (переменные)
Открытые свойства
Открытые свойства только для чтения
Закрытые свойства


Процедуры
Открытые процедуры
Закрытые процедуры


в списке типов я добавил базовый тип (для удобства, в qt'ях такого небыло)

На странице описания типов, в начале должны быть:
От кого унаследован (кто базовый тип)
Кто от него унаследован (для кого он бязовый тип)
Ссылка на страницу содержащую все члены (свойства и процедуры) включая унаследованные.
38. MaDzi - 06 Января, 2009 - 00:54:24 - перейти к сообщению
BohdanT пишет:
MaDzi
Немного раньше в этой теме обсуждалось, что в исходниках Аос заложены элементы автодокументации.
Это коментарии (** в JavaDoc стиле. Т.е. необходимо пропарсить все исходники и создать дерево модулей и их элементов с коментариями...
...skip...

Это понятно. Я видел, там они даже свой диалект предлагают AUTOR, PURPOSE и т.п.
Гораздо важнее понять что в итоге требуется получить.
Лично мне не совсем улыбается иметь всё это в HTML да ещё и по образу QT (это мне совсем не нравится).
Хотелось бы иметь возможность пользоваться справкой в среде A2 и чтобы она была подобна инструментарию Visual Age of Java, где можно раскрыть дерево классов, посмотреть методы и свойства отдельного класса и т.п.
39. lit-uriy - 06 Января, 2009 - 00:56:10 - перейти к сообщению
MaDzi пишет:
посмотреть методы и свойства отдельного класса и т.п.
это есть в Qt'ях
40. BohdanT - 06 Января, 2009 - 01:00:25 - перейти к сообщению
MaDzi пишет:
Хотелось бы иметь возможность пользоваться справкой в среде A2 и чтобы она была подобна инструментарию Visual Age of Java, где можно раскрыть дерево классов, посмотреть методы и свойства отдельного класса и т.п.

это кстати уже реализовано в PET

Powered by ExBB
ExBB FM 1.0 RC1 by TvoyWeb.ru
InvisionExBB Style converted by Markus®

[Script Execution time: 0.0142]     [ Gzipped ]