Блог

Мне нужен модуль документации в моем приложении OpenXava. В основном это делается для того, чтобы пользователь мог ознакомиться с руководством в случае сомнений.

Я думаю, в формате HTML.

Я видел в документации OpenXava возможность создания модуля документации: https://openxava.org/OpenXavaDoc/docs/application_en.html#Application-Documentation module

Но он работает только с Liferay или WebSphere Portal.

Есть ли способ сделать это без Liferay или WebSphere Portal?

Это правда, что модули документации доступны только на портале, однако справочная система работает без портала, и я думаю, что это именно то, что вы ищете. Его можно активировать, настроив некоторые свойства в xava.properties.

Обратите внимание на раздел справки в следующем документе:

https://openxava.org/OpenXavaDoc/docs/customizing_en.html#Customizing-Xava Properties Settings

Что-то подобное в xava.properties может сработать для вас:

 helpAvailable=true
helpPrefix=help/
 

Если справка находится в папке под названием «справка» внутри вашего приложения.

Также вы можете разместить справку на другом сервере:

 helpPrefix=https://www.example.com/help
 

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

 helpPrefix=https://www.example.com/myapplication/help_
 

Где он ищет help_en.html, help_es.html или help_fr.html, в зависимости от языка браузера.