https://github.com/firebirdsql/firebird-documentation

Firebird documentation
https://github.com/firebirdsql/firebird-documentation

database documentation firebird release-notes sql

Last synced: 2 days ago
JSON representation

Firebird documentation

• Host: GitHub
• URL: https://github.com/firebirdsql/firebird-documentation
• Owner: FirebirdSQL
• Created: 2017-11-12T10:33:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T17:07:22.000Z (16 days ago)
• Last Synced: 2024-10-29T18:35:55.115Z (16 days ago)
• Topics: database, documentation, firebird, release-notes, sql
• Language: JavaScript
• Homepage: https://www.firebirdsql.org/en/firebird-rdbms/
• Size: 69 MB
• Stars: 34
• Watchers: 14
• Forks: 14
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
Firebird documentation

----------------------

After checking out the firebird-documentation repository, and if your

Java environment is set up correctly, open a command window and go to

the directory containing the firebird-documentation repository. Then

give one of these commands:

```

./gradlew                         [ Unix    ]

gradlew                           [ Windows ]

```

to get an overview of compilable targets.

If that worked, try e.g.:

```

./gradlew asciidocHtml             [ Unix    ]

gradlew asciidocHtml               [ Windows ]

```

to build the HTML version of the docs.

(Note: the HTML pages will wind up in build/docs/asciidoc/html/en/firebirddocs)

To build a specific document, or a document from another set, or another

language, you can specify:

````

gradlew asciidocHtml --docId=gbak

gradlew asciidocPdf --baseName=refdocs --docId=fblangref25

gradlew asciidocHtml --language=de

````

To get more information on a task, use

```

./gradlew help --task=asciidocHtml [ Unix    ]

gradlew help --task=asciidocHtml   [ Windows ]

```

Warning: if you build the asciidocPdf target, you might get some error

messages. Don't let that discourage you. Just look at the last

output lines: if it says BUILD SUCCESSFUL there, everything's fine.

The `docbookHtml` and `docbookPdf` tasks are available to build documentation

that has not been migrated to AsciiDoc. However, if you feel the need to build

those documents, it might be an indication they need to be migrated. Please

ask for guidance or help on the [firebird-devel list](https://groups.google.com/g/firebird-devel).

If you have any questions, *first* get the Docbuilding Howto at:

  https://www.firebirdsql.org/en/reference-manuals/

If your question isn't answered there, post a message to the Firebird

Development list. You can use this page to subscribe:

  https://groups.google.com/g/firebird-devel