abjad-book — Abjad v1.1.1 documentation

### Navigation

- index
- modules |
- next |
- previous |
- Project Abjad »
- Abjad v1.1.1 documentation »

# `abjad-book`

`abjad-book` is an independent application included in every installation of Abjad. `abjad-book` allows you to write Abjad code in the middle of documents written in HTML, LaTeX or ReST. We created `abjad-book` to help us document Abjad. Our work on `abjad-book` was inspired by `lilypond-book`, which does for LilyPond much what `abjad-book` does for Abjad.

## HTML with embedded Abjad

To see `abjad-book` in action, open a file and write some HTML by hand. Add some Abjad code to your HTML between open and close <abjad> </abjad> tags.

    <html>

    <p>This is an <b>HTML</b> document.</p>

    <p>The code is standard hypertext mark-up.</p>

    <p>Here is some music notation generated automatically by Abjad:</p>

    <abjad>
    v = Voice(construct.scale(8))
    Beam(v)
    write_ly(v, 'example-1') <hide
    show(v)
    </abjad>

    <p>And here is more ordinary <b>HTML</b>.</p>

    </html>

Save your the file with the name `example.html.raw`. You now have an HTML file with embedded Abjad code.

In the terminal, call `abjad-book` on `example.html.raw`.

    $ abjad-book example.html.raw example.html

    Parsing file...
    Rendering "example-1.ly"...

The application opens `example.html.raw`, finds all Abjad code between <abjad> </abjad> tags, executes it, and then creates and inserts image files of music notation accordingly.

Open `example.html` with your browser.

That’s all there is to it. `abjad-book` lets you open a file and type HTML by hand with Abjad sandwiched between the special <abjad> </abjad> tags described here. Run `abjad-book` on such a hybrid file to create pure HTML with images of music notation created by Abjad.

Note

`abjad-book` makes use of ImageMagick’s convert application to crop and scale PNG images generated for HTML and ReST documents. For LaTeX documents, `abjad-book` uses `pdfcrop` for cropping PDFs.

## Using `abjad-book` on other document types

You can call `abjad-book` on LaTeX and ReST documents, too.

Examples coming soon.

### Navigation

- index
- modules |
- next |
- previous |
- Project Abjad »
- Abjad v1.1.1 documentation »