Archi Forum

Archi => General Archi Discussion => Topic started by: jabo59 on June 18, 2016, 14:43:57 PM

Title: Rich Text in Documentation
Post by: jabo59 on June 18, 2016, 14:43:57 PM
Hi,

I'm looking for the possibility to use rich text in the property Documentation. Is this feature planned for upcoming versions?

Kind regards,
jabo59
Title: Re: Rich Text in Documentation
Post by: Phil Beauvoir on June 19, 2016, 10:53:53 AM
It might be a nice feature for a future version of Archi. Should it be RTF or HTML?
Title: Re: Rich Text in Documentation
Post by: theunsfvo on June 20, 2016, 13:58:03 PM
I would say HTML but either would help greatly in generating pre-formatted documentation and save time in editing later...
Title: Re: Rich Text in Documentation
Post by: Phil Beauvoir on June 20, 2016, 14:03:01 PM
I guess users would want some kind of WYSIWYG Editor? Or edit raw HTML? Then would need to find open source HTML Java Editor?
Title: Re: Rich Text in Documentation
Post by: theunsfvo on June 20, 2016, 15:28:41 PM
On second thought, RTF would probably easier to implement and provide the basics needed. HTML is maybe more a nice to have for the more technically inclined users that prefer that syntax.
Title: Re: Rich Text in Documentation
Post by: Jean-Baptiste Sarrodie on June 20, 2016, 19:37:08 PM
Hi,

My 2 cts on this: not RTF please, HTML is clearly better as it can easily be converted or even used as if from jasterreport.

Another option is to use plain text but include a markdown renderer.

Regards,

JB
Title: Re: Rich Text in Documentation
Post by: Phil Beauvoir on June 20, 2016, 19:39:30 PM
The issues for me is this - I'm not going to write a HTML or RTF editor plug-in. I've tried that before in other projects and it's a nightmare. If there is a nice plugin that can be easily integrated then good. In this case, it makes for a nice contribution if anyone is up for it.
Title: Re: Rich Text in Documentation
Post by: Jean-Baptiste Sarrodie on June 20, 2016, 19:48:45 PM
Well, there's the rich tect editor from the nebula project (http://www.eclipse.org/nebula/widgets/richtext/richtext.php) but I'm not sure it will looks good.

IMHO -> plain text with markdown is good :-)

JB
Title: Re: Rich Text in Documentation
Post by: Hervé on June 20, 2016, 22:54:12 PM
Hi,

RTF or HTML would be a very good idea. But now that I have a look to Jasper Reports to automate my documentation (as it is integrated into Archi), I'm wondering how it will be able to handle this ...

Best regards
Hervé
Title: Re: Rich Text in Documentation
Post by: Jean-Baptiste Sarrodie on June 21, 2016, 19:15:52 PM
Hi,

Jasperreport comes with its own HTML engine so that it can use HTML easily.

Regards,

JB