Re: [platform-doc-dev] Improving code snippet visual effect in doc

[Michael Valenta <Michael_Valenta@xxxxxxxxxx>]

I agree. What I was trying to get at
is that I think we need to separate the snipet (HTML) from the presentation
(CSS) in order to ensure that the style of all snipets is consistent across
all doc pages. This would allow the style to be adjusted as required without
modifying each snipet. I didn't see anything on the website of the tool
that indicated that was possible so if we agree that this is a requirement,
then we would need to modify the tool.

Incidently, I did find an on-line conversion
tool at the site that allows you to create the html for a snipet (i.e.
without downloading anything). This would definitely be handy for creating
snipets for wiki/blog entries. If we agreed that, for instance, the Eclipse
style they provide was adequate and we didn't anticipate ever needing to
change the style, we could generate snipets without even installing anything.

Michael

Olivier Thomann/Ottawa/IBM@IBMCA
Sent by: platform-doc-dev-bounces@xxxxxxxxxxx

07/06/2007 11:50 AM

Please respond to
"Platform Documentation discussions." <platform-doc-dev@xxxxxxxxxxx>

To	"Platform Documentation discussions." <platform-doc-dev@xxxxxxxxxxx>
cc
Subject	Re: [platform-doc-dev] Improving code snippet visual effect in doc

The tool I mentionned has an Eclipse plugin that seems
pretty easy to use. 
It also offers several target format (using css, inlined fonts, ...).
If the tool doesn't offer what we need out of the box we might consider
extending it. This it is CPL, this might be doable.

I just would like to see "nicer" code snippets which looks more
like the 
way to code is displayed inside Eclipse's java editor.

Olivier




Michael Valenta/Ottawa/IBM@IBMCA 
Sent by: platform-doc-dev-bounces@xxxxxxxxxxx
2007-06-07 11:44
Please respond to
"Platform Documentation discussions." <platform-doc-dev@xxxxxxxxxxx>


To
"Platform Documentation discussions." <platform-doc-dev@xxxxxxxxxxx>
cc

Subject
Re: [platform-doc-dev] Improving code snippet visual effect in doc







Olivier, 

This makes sense to me. What I think would be useful is the ability to
convert a snipet of code from an editor into HTML that uses classes to
identify the syntactic elements (perhaps using a Copy Special operation
or 
something similar). Then the look could be tailored through a CSS file.
The ability to generate the CSS from the Eclipse preferences would make
tailoring the look easier. 

Michael 



Olivier Thomann/Ottawa/IBM@IBMCA 
Sent by: platform-doc-dev-bounces@xxxxxxxxxxx 
07/06/2007 11:12 AM 

Please respond to
"Platform Documentation discussions." <platform-doc-dev@xxxxxxxxxxx>


To
platform-doc-dev@xxxxxxxxxxx 
cc

Subject
[platform-doc-dev] Improving code snippet visual effect in doc








Hi,

I noticed that all code snippets are in blue.
Personnally I prefer much more code snippets with syntax coloring. There
are tools like http://www.java2html.de/ that easily allows colors to be
used to improve the visual effect of the code snippets. java2html has a
CPL license, so it should not be a problem to use it for Eclipse doc. It
even has an Eclipse style.

This tool is just an example. I am sure there are other tools to achieve
the same result (get syntax coloring for code snippets).

I would like to propose to use such a tool to create the code snippets
inside Eclipse doc. Not for 3.3, but post 3.3.

Any comments?

Olivier
_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-doc-dev
_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-doc-dev


_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-doc-dev