Re:VIEW catalog.yml Guide

This article describes Re:VIEW catalog file catalog.yml.

What's catalog.yml

Catalog file shows the structure of files to generate books (such as PDF or EPUB) in Re:VIEW format. Now we use catalog.yml as catalog file.

How to write catalog.yml

In catalog.yml, you can write PREDEF(frontmatter), CHAPS(bodymatter), APPENDIX(appendix) and POSTDEF(backmater). CHAPS is required.

  PREDEF:
    - intro.re
  
  CHAPS:
    - ch01.re
    - ch02.re
  
  APPENDIX:
    - appendix.re
  
  POSTDEF:
    - postscript.re

You can add parts in body to use CHAPS in a hierarchy. You can use both title name and file name to specify parts.

  CHAPS:
    - ch01.re
    - TITLE_OF_PART1:
      - ch02.re
      - ch03.re
    - pt02.re:
      - ch04.re

(For old version user: there is no PART. You write them in CHAPS.)

About earlier version

In version 1.x, Re:VIEW use 4 files PREDEF, CHAPS, POSTDEF, PART as catalog files.

You can convert there files with review-catalog-converter. When using it, you should compare with these files and the generated file catalog.yml.