firebirdsql / jaybird-manual

Jaybird JDBC Driver Java Programmer's Manual

jaybird-manual

Jaybird JDBC Driver Java Programmer's Manual

Manual for Jaybird, the Firebird JDBC driver.

Snapshot build of manual

You can see the latest snapshot build of the manual on https://firebirdsql.github.io/jaybird-manual/jaybird_manual.html. We also provide a print-friendly PDF on https://firebirdsql.github.io/jaybird-manual/jaybird_manual.pdf.

These documents are automatically built for each change on master.

Style

Line breaking convention: a single sentence per line, no line breaks within a sentence. If a line becomes too long, take that as a hint to rewrite (if possible).

NOTE: The previous convention was 100 characters per line. Only apply the single sentence per line style per paragraph when making changes in that paragraph.

Sourcecode examples: indent 2 spaces, continuations: 4 spaces

How to build

Run ./gradlew or its full equivalent ./gradlew clean asciidoctor. Add asciidoctorPdf for the PDF version.

Building the documentation requires Java 9 or higher, use of Java 17 or higher is advisable.

Supporting information

This project uses asciidoctor.

Reporting bugs

Please report bugs or corrections through issues or create a pull request with your improvements.

jaybird-manual's Issues

Use Asciidoc instead of markdown

Markdown is rather limited (and annoying) when it comes to tables and some other functionality like callouts. For a manual these limitations get in the way. I've looked at restructuredText and asciidoc, and I've decided to switch to asciidoc.

Add reference section documenting complete JDBC URL syntax

Add reference section documenting complete JDBC URL syntax as of Jaybird 5. Also look at moving some parts of the User manual section Obtaining a connection to this reference section.