Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakartaee-platform-dev] Image formats in the specification

Hi,
I agree with Markus that SVG is nice, but each editor throws wrinkles into the generated SVG.  When we did the first couple images that needed modification (https://github.com/eclipse-ee4j/jakartaee-platform/pull/217), I verified that the resulting images could be modified via Inkscape (https://inkscape.org/).  This seems like a nice open-source, semi-easy-to-use vector graphics editor.

I didn't realize that AsciiDoctor had a solution for images.  If someone wants to compare or demonstrate this solution as compared to SVG (using one of the existing diagrams in the Platform spec), I'd be very interested in learning more.

---------------------------------------------------
Kevin Sutter
STSM, Jakarta EE and MicroProfile architect @ IBM
e-mail:  sutter@xxxxxxxxxx     Twitter:  @kwsutter
phone: tl-553-3620 (office), 507-253-3620 (office)    
LinkedIn:
https://www.linkedin.com/in/kevinwsutter

Part-time schedule: Tue, Wed, Thu (off on Mon and Fri)




From:        Dmitri Cerkas via jakartaee-platform-dev <jakartaee-platform-dev@xxxxxxxxxxx>
To:        'jakartaee-platform developer discussions' <jakartaee-platform-dev@xxxxxxxxxxx>
Cc:        Dmitri Cerkas <dmitricerkas@xxxxxxxxx>
Date:        06/03/2021 02:42
Subject:        [EXTERNAL] Re: [jakartaee-platform-dev] Image formats in the specification
Sent by:        "jakartaee-platform-dev" <jakartaee-platform-dev-bounces@xxxxxxxxxxx>




Ok. When the final decision is made let me know that this is how I begin the image conversion to the new format also for other specifications of Jakarta EE.

Dmitri.



On Thursday, June 3, 2021, 09:00:12 AM GMT+2, Markus Karg <markus@xxxxxxxxxxxxxxx> wrote:


Clearly moving away from binary image formats is a huge benefit as it allows to diff them, which is very nice.
But as least people write SVGs manually, the diff is not very self-explanatory: Drawing software often completely rewrites the SVG or adds clutter.
So I see a source-based image format the most useful.
While I do not know Asciidoctor very well, I think it is exactly what we should strive for.
If Jakarta EE spec moves to Asciidoctor and this works well, I could imagine that most Jakarta specs would follow.
-Markus
 
 
Von:jakartaee-platform-dev [mailto:jakartaee-platform-dev-bounces@xxxxxxxxxxx] Im Auftrag von Ivar Grimstad
Gesendet:
Donnerstag, 3. Juni 2021 08:14
An:
jakartaee-platform-dev@xxxxxxxxxxx
Betreff:
[jakartaee-platform-dev] Image formats in the specification

 
Hi,
 
I can't remember if we reached any conclusion for how to handle the images, diagrams, and illustrations in the specification document.
 
Currently, there is a pull request for replacing the PNGs with SVGs [1] that needs some feedback.
Does this conversion step help now? Or should we move directly to a text-based format to generate the diagrams from the Asciidoc to make editing easier? Something like AsciiDoctor Diagram [2]?
 
Ivar
 
[1] https://github.com/eclipse-ee4j/jakartaee-platform/pull/365
[2] https://asciidoctor.org/docs/asciidoctor-diagram/
 
--

Ivar Grimstad

Jakarta EE Developer Advocate | Eclipse Foundation Eclipse Foundation- Community. Code. Collaboration.


_______________________________________________
jakartaee-platform-dev mailing list

jakartaee-platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakartaee-platform-dev_______________________________________________
jakartaee-platform-dev mailing list
jakartaee-platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakartaee-platform-dev





Back to the top