Book Configuration Specification

André Alves Garzia
Download the eBook

Table Of Contents

  1. Introduction
  2. Using TOML
  3. Metadata Section
  4. Default values
  5. Title
  6. Subtitle
  7. Date
  8. Identifier
  9. Cover
  10. Language
  11. License
  12. Author Section
  13. Default values
  14. Name
  15. Bio
  16. Photo
  17. Book Section
  18. Default values
  19. Enabled
  20. Theme
  21. Frontmatter and Backmatter
  22. Chapters
  23. Important remarks
  24. Table of Contents Section
  25. Default values
  26. Prefix
  27. Label
  28. Match
  29. Important remarks
  30. Publisher Section
  31. Default values
  32. Name
  33. Bio
  34. Link
  35. Site Section
  36. Default values
  37. Enabled
  38. Theme
  39. Frontmatter, Chapters, and Backmatter
  40. Blurb
  41. Landing
  42. Download
  43. Site Actions
  44. Site labels
  45. WebMonetization Section
  46. Default values
  47. Endpoint
  48. Call To Action Section
  49. Default values
  50. cta
  51. url
  52. label
  53. Links Section
  54. Default values
  55. cta
  56. url
  57. label
  58. Using YAML
  59. Why We Prefer TOML over YAML
  60. Sample configuration using YAML
  61. Using JSON
  62. Why We Prefer TOML over JSON
  63. Sample configuration using JSON
  64. Final Remarks and Moving On

Call To Action Section

Some people might find the actions in the above the fold for the website too restrictive for their needs. By default, the site only sports buttons for Downloading the eBook, Reading it online, and Viewing the Table of Contents. Using the CTA section, you can add your own buttons. Combining CTA items and the site configuration, you can disable the buttons you do not want and add new buttons.

The Call To Action section can be repeated inside the configuration. Each item you add becomes a new button.

[[cta]]
url = "http://example.com"
label = "Visit Example Site"

[[cta]]
url = "http://kobo.com"
label = "Get it from Kobo"

In the example above, there are two Call To Action items. They will become two buttons in the above the fold area of the website.

Default values

The CTA has an empty default value. It is only present if you add it.

cta

You can add as many Call To Action sections you want, remember that repeatable sections are enclosed in double square brackets.

[[cta]]

url

This is the URL the button links to. One good usage is adding links to purchase the book in other stores such as your own store, Kobo, or Amazon.

url = "https://my-own-store.com/my-book/purchase"

label

This is the label for the button associated with that section.

label = "Purchase my eBook, plz"
←
→