Documentación de JSesh

Overview of JSesh Appendix C: developer's guide Developer's guide: JSesh 8

Developer's guide: JSesh 8

If you know how to program in Java, you can use JSesh as a library for your own programs. JSesh 8 is a major rewrite of the libraries, and its API is much cleaner than the one of JSesh 7.

Warning: JSesh 8 is still young. The API has changed a lot, and may change again before it is frozen. Please experiment with it and report problems and suggestions, but expect to update the code you write now.

JSesh 8 requires Java 25, and is built with Gradle.

This guide is organised around concrete use cases:

Getting the code: getting and building the sources;
Using JSesh in your project: the Gradle (or Maven) dependencies;
Core concepts: the main classes, and the way JSesh 8 builds immutable objects;
Rendering: producing bitmaps, SVG, or drawing on a Graphics2D;
Parsing and documents: reading, writing and converting Manuel de Codage texts;
Swing components: embedding the editor in a Swing interface;
Resources and fonts: fonts, sign database and glossary;
Exporting: PDF, SVG, RTF and other formats;
Quick reference;
How to: short recipes.

If you already have code written for JSesh 7, see Moving from JSesh 7 to JSesh 8.

The demos

The jsesh-demos project contains small, independent, ready-to-run Gradle projects showing how to use the library. I strongly recommend getting them: most of the code in this guide comes from them.

Demo	Shows how to
`bitmapDemo`	produce PNG pictures
`svgExportDemo`	produce SVG files
`lowleveldrawing`	go from a Manuel de Codage string to a picture step by step
`gui`	build Swing hieroglyphic fields
`multipleSignSources`	use signs coming from several folders

The JSesh repository also contains a folder, 00_Documents/documentation, with the programmer's documentation used to write this guide. It may be a little ahead of this one.