Help Template

Тема в разделе "Общие вопросы по лотус-технологиям", создана пользователем lmike, 17 апр 2012.

  1. lmike

    lmike нет, пердело совершенство
    Команда форума Lotus team

    Регистрация:
    27 авг 2008
    Сообщения:
    6.078
    Симпатии:
    300
    тут задумал создать БД хелпа, для приложения, вспоминая события многолетней давности попытался воспроизвести...
    отыскал ссылку http://www.ibm.com/developerworks/lotus/li...help/index.html
    но вот на ней и обломился - ибо ибиэм похачило свойже ресурс
    Т.о. как терь модно хэлпы-то создавать, шаблон х.з. где, в стандартной поставке - тоже на нашёл...
    или ибиэм решил что оно не надо делать приложения с "нормальным" хэлпом? B)
    коллеги! поделитесь современными тенденциями
     
  2. FixeR

    FixeR Гость

    CHM вам в помощь.
     
  3. lmike

    lmike нет, пердело совершенство
    Команда форума Lotus team

    Регистрация:
    27 авг 2008
    Сообщения:
    6.078
    Симпатии:
    300
    FixeR это в нотусе-то? B) http://ru.wikipedia.org/wiki/HTMLHelp
     
  4. hosm

    hosm * so what *

    Регистрация:
    18 май 2009
    Сообщения:
    2.450
    Симпатии:
    7
    вроде тут была ссылка от NetWood про доступный Lotus Sandbox - Lotus Sandbox, да и в нескольких темах он ее упоминал, посмотрите, может, найдете старый пример, о котором говорится в статье.
     
  5. VladSh

    VladSh начинающий
    Lotus team

    Регистрация:
    11 дек 2009
    Сообщения:
    1.251
    Симпатии:
    2
    Я когда-то давно брал шаблон справки ещё от R5 и допилил (во вложении). Косо, но как-то работает.
    /если вдруг будут ошибки, пишите, - я там дрянь всякую выпиливал, так что могут остаться тараканы))/

    Добавлено: хотя меня интересует, как можно JavaDoc на LS-код (библы и агенты) натравить..
     

    Вложения:

    • help.zip
      Размер файла:
      145,8 КБ
      Просмотров:
      5
  6. lmike

    lmike нет, пердело совершенство
    Команда форума Lotus team

    Регистрация:
    27 авг 2008
    Сообщения:
    6.078
    Симпатии:
    300
    спасибо всем откликнувшимся! бум смореть B)
     
  7. lmike

    lmike нет, пердело совершенство
    Команда форума Lotus team

    Регистрация:
    27 авг 2008
    Сообщения:
    6.078
    Симпатии:
    300
  8. FixeR

    FixeR Гость

    Нет-нет. Это просто как вариант. Сделать справку в отдельном файле chm.
    Гораздо проще, по-моему.
     
  9. lmike

    lmike нет, пердело совершенство
    Команда форума Lotus team

    Регистрация:
    27 авг 2008
    Сообщения:
    6.078
    Симпатии:
    300
    спасибо, но в смысле "простоты" - ОДФ будет лучше...
    здесь больше вопрос в интеграции и "нативности" хэлпа на платформе (LDN)
    вопрос возник из-за того, что раньше был шаблон, а в результате суеты ибиэм шаблон "исчезли", а с новыми ср-вами как-то проблематично
    ведь "новый" хэлп нотусни имеет несколько иной движок (я про эклипсовый двиг), но деталей по нему я не нашёл

    Добавлено: я про F1 - там к локалхоту (на 1526) обращение и рендеринг страниц
     
  10. VladSh

    VladSh начинающий
    Lotus team

    Регистрация:
    11 дек 2009
    Сообщения:
    1.251
    Симпатии:
    2
    lmike
    Прощу прощения, сейчас посмотрел, и увидел несколько траблов в шаблоне, формулы скрытия, профайлы брейкпоинтов и т.п. мелочи. Поправил и перевложил.

    Да, кстати, в этих IBM-шаблонах справки, которые они давали в публичный доступ, никогда не было действий создания доков, сам их добавлял.
     
  11. turumbay

    Регистрация:
    13 мар 2009
    Сообщения:
    625
    Симпатии:
    2
    Я некоторое время активно пользовался lsdoc. Код комментируется примерно так:
    Код (Text):
    '/**
    ' * Описалово краткое.
    ' *
    ' * Описалово полное ( много букв )
    ' *
    ' * @author turumbay
    ' * @param бла-бла
    ' * @return бла-бла
    ' */
    Function MyMegaFunction()
    End Function
    Инструмент представляет из себя лотусовую базу. В ней настраиваем пути к базам, для которых нужна документация, жмем кнопку и получаем javadoc. Открываем базу в браузере и наслаждаемся результатом. По крайне мере так оно работало в первой версии, щаз на сайте лежит вторая, которую не юзал.
    Из приятных мелочей: с первой версией шли кнопки для тулбара, вставляющие "рыбу" комментария ( трюк с WScript ). Восьмерки, с ее шаблонами кода, тогда не было, и кнопки были мрачно удобны. В общем классный инструмент.
     
  12. VladSh

    VladSh начинающий
    Lotus team

    Регистрация:
    11 дек 2009
    Сообщения:
    1.251
    Симпатии:
    2
    По lsdoc.
    Скачал последнюю версию из 2.00 beta 4, ntf-файл датирован 08.12.2009.

    В форме "(Database)" была ошибка.
    в Options заменил Use на: Use "AppSLDesign7".
    в Queryrecalc:
    - описал dbdesign как DesignBase;
    - строку
    Set dbdesign = CreateDatabaseDesign(db)
    заменил на
    Set dbdesign = New DesignBase(db)
    после этого стало работать.

    настройки:
    1. Создать конфигурационный документ для БД - действие "Create -> LotusScript.doc Configuration".
    2. Прописать Hostname для корректного открытия в браузере - действие "Database Setup".

    использование:
    3. Нажать действие "Build LotusScript.doc".
    4. Нажать действие "Preview in Web-Browser".

    Засада в том, что дока генерится, но описания методов не выводятся. Хоть "восьмёрошный", хоть JavaDoc'овский синтаксис.
    Конечно хотелось бы использовать "восьмёрошный", но, как я понял, парсинг зашит в Java-библах и не настраивается (там нет source-кода).
     
  13. turumbay

    Регистрация:
    13 мар 2009
    Сообщения:
    625
    Симпатии:
    2
    Скачал с lsdoc.org поставил на локал. Прямо в шаблоне lsdoc_200.ntf создал конфигурация для нее же. Документация построилась, описания методов подтягиваются. Можно посмотреть на примере Class SortedVector.
    <div class="sp-wrap"><div class="sp-head-wrap"><div class="sp-head folded clickable">В коде так</div></div><div class="sp-body"><div class="sp-content">
    Код (Text):
    '/**
    ' * Extension of the Vector class to make the Vector sortable.
    ' *
    ' */
    Public Class SortedVector As Vector
    'declarations
    Private pAddedElements As Integer

    '/**
    ' * Constructor.
    ' */
    Public Sub New(), Vector()
    Me.pAddedElements = -1
    End Sub

    '/**
    ' * Adds an element to the Vector sorting the elements after
    ' * the element has been added.
    ' *
    ' * @see Vector#AddElement
    ' */
    Public Sub AddElement(element As Variant)
    'call super
    Call Vector..AddElement(element)

    'increment counter
    Me.pAddedElements = Me.pAddedElements + 1

    'sort if more than one element
    If Me.pAddedElements > 0 Then
    Call Me.pSortElements()
    End If
    End Sub
    Как оно генерится в javadoc - см. в аттаче.
    Т.е. вроде бы все работает как положено, а отсутствие поддержки комментов, сгенеренных по стандарному шаблону DDE можно компенсировать перенастройкой этих самых шаблонов.
    На форме действительно косяк, но если не лазить в дизайн ( читай - не перекомпилировать ) - то работает :)
     

    Вложения:

    • lsdoc.png
      lsdoc.png
      Размер файла:
      24,2 КБ
      Просмотров:
      97
  14. VladSh

    VladSh начинающий
    Lotus team

    Регистрация:
    11 дек 2009
    Сообщения:
    1.251
    Симпатии:
    2
    turumbay
    Ничего не получается. Думает и всё. При нажатии «Preview in Web-Browser» или «Documentation Index» открывает страницу с ошибкой 404.

    to all
    Есть ли уже что-то альтернативное?
     
  15. VladSh

    VladSh начинающий
    Lotus team

    Регистрация:
    11 дек 2009
    Сообщения:
    1.251
    Симпатии:
    2
    Разбираюсь, к сожалению, сам.

    1. БД "LS.doc"
    Действие "Build LS.doc", как оказалось, выполёвывало ошибку
    <div class="sp-wrap"><div class="sp-head-wrap"><div class="sp-head folded clickable">java.security.AccessControlException: Access denied (java.util.logging.LoggingPermission control)</div></div><div class="sp-body"><div class="sp-content">at java.security.AccessController.checkPermission(AccessController.java:132)
    at java.lang.SecurityManager.checkPermission(SecurityManager.java:544)
    at COM.ibm.JEmpower.applet.AppletSecurity.superDotCheckPermission(AppletSecurity.ja
    va:1449)
    at COM.ibm.JEmpower.applet.AppletSecurity.checkPermission(AppletSecurity.java:1617)
    at COM.ibm.JEmpower.applet.AppletSecurity.checkPermission(AppletSecurity.java:1464)
    at java.util.logging.LogManager.checkPermission(LogManager.java:297)
    at java.util.logging.Handler.checkPermission(Handler.java:406)
    at java.util.logging.Handler.setLevel(Handler.java:400)
    at java.util.logging.Logger.initHandler(Logger.java:468)
    at java.util.logging.Logger.getHandlers(Logger.java:484)
    at java.util.logging.Logger.log(Logger.java:1127)
    at java.util.logging.Logger.info(Logger.java:954)
    at org.lsdoc.FeatureRegistry.addFeature(FeatureRegistry.java:229)
    at JavaAgent.NotesMain(Unknown Source)
    at lotus.domino.AgentBase.runNotes(Unknown Source)
    at lotus.domino.NotesThread.run(Unknown Source)Не знаю, правильно сделал или нет, но добавли в ...\Notes\jvm\lib\security\java.policy в секцию grant { ... } строку:
    <!--shcode--><pre><code class='java'>permission java.util.logging.LoggingPermission "control";[/CODE]заработало. Т.е. документы описания в базе создаёт.

    В логе, здесь же, в базе, создало документ с записью:
    что бы это значило, неясно.

    С открытием документации есть некоторые проблемы, но это уже здесь.

    2. Eclipse-плагин под Domino Designer "DDE_LSDoc_Plugin".
    Он работает с вышеозначенной БД.

    Трабл 1-й: плагин почему-то генерирует не такой урл, как генерирует база; пример:
    http://localhost/utills/lsdoc.nsf/0/test_index.html
    а вот такой:
    http://localhost:7899/lsdoc/test_index.html
    Не заработал, пока в IE не снизил уровень безопасности на "Местная интрасеть | Защищённый режим: выключен".
    Как подменить в плагине формирование урла, кто разберётся, отпишите пожалуйста; настройки плага я не нашёл.

    Трабл 2-й: т.к. у меня ID на русском, а документация создаётся и потом открывается по уникальному ключу, автоматически генерируемом по @Unique, то плаг не понимает кириллических кодировок, и вместо "test" в урле кракозябры.
    Всвязи с этим переделал базку на вычисление этого ключа = Title, в подписи к полю указал, чтобы наименование писали латиницей; пофиксил указанные в предыдущих сообщениях баги.
    Русские комменты из плагина, кстати, тоже отображаются кракозябрами. Кто знает как пофиксить, отпишитесь.
    Updated: по кракозябрам в содержимом сгенерированных страниц отмена; надо в контекстном меню на странице выбрать "Кодировка -> Юникод (UTF-8)".
     

    Вложения:

    • lsdoc.zip
      Размер файла:
      1,1 МБ
      Просмотров:
      2
  16. VladSh

    VladSh начинающий
    Lotus team

    Регистрация:
    11 дек 2009
    Сообщения:
    1.251
    Симпатии:
    2
    Ещё на names.nsf в лог выплюнуло вот такую
    <div class="sp-wrap"><div class="sp-head-wrap"><div class="sp-head folded clickable">мессюгу</div></div><div class="sp-body"><div class="sp-content">{ROOT}{WARNING}: The supplied data isn't a valid LotusScript property - throwing IllegalArgumentException
    {ROOT}{SEVERE }: Exception trying to parse database
    Exception: java.lang.IllegalArgumentException: The supplied data isn't a valid LotusScript property.
    at org.lsdoc.language.ls.parser.PropertyParser.parse(PropertyParser.java:108)
    at org.lsdoc.language.ls.parser.PropertyParser.parse(PropertyParser.java:68)
    at org.lsdoc.language.ls.parser.Parser.parse(Parser.java:320)
    at org.lsdoc.dbdesign.parser.AbstractElementParser.findCodeElements(AbstractElement
    Parser.java:136)
    at org.lsdoc.dbdesign.parser.ScriptLibraryParser.parse(ScriptLibraryParser.java:75)
    at org.lsdoc.Parser$2.added(Parser.java:398)
    at org.lsdoc.elementobserver.simple.SimpleObserver.activateListener(SimpleObserver.
    java:44)
    at org.lsdoc.elementobserver.BaseObserver.activateListeners(BaseObserver.java:109)
    at org.lsdoc.elementobserver.BaseObserver.addElement(BaseObserver.java:173)
    at org.lsdoc.dxl.DxlParser.parse(DxlParser.java:406)
    at org.lsdoc.dxl.DxlParser.parse(DxlParser.java:330)
    at org.lsdoc.dxl.DxlParser.parse(DxlParser.java:280)
    at org.lsdoc.Parser.doParse(Parser.java:245)
    at org.lsdoc.Parser.parseDatabase(Parser.java:97)
    at org.lsdoc.runner.notes.NotesAgent.NotesMain(NotesAgent.java:133)
    at org.lsdoc.runner.notes.DcNotesAgent.execute(DcNotesAgent.java:40)
    at JavaAgent.NotesMain(Unknown Source)
    at lotus.domino.AgentBase.runNotes(Unknown Source)
    at lotus.domino.NotesThread.run(Unknown Source)В настройках выбрал лишь те элементы дизайна, которые мне нужны, и всё отработало.
    Вероятно некоторые новые (а может и нет) объекты БД не поддерживает.
     
Загрузка...

Поделиться этой страницей