Skip to content

Commit

Permalink
GEODE-3396 Provide pub-tools support for product name & version varia…
Browse files Browse the repository at this point in the history
…bles. Adjustments to accommodate Bookbinder changes.
  • Loading branch information
davebarnes97 committed Aug 8, 2017
1 parent 79cf78c commit b775c84
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions geode-book/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ sections:
subnav_template: geode-subnav

template_variables:
geode_product_name_long: Apache Geode
geode_product_name: Geode
geode_product_version: 1.2
product_name_long: Apache Geode
product_name: Geode
product_version: 1.2
support_url: http://geode.apache.org/community
product_url: http://geode.apache.org/
book_title: Apache Geode Documentation
Expand Down
11 changes: 6 additions & 5 deletions geode-docs/CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ For flexibility, the product name (a long version and a short one) and version a

```
template_variables:
- geode_product_name_long: Apache Geode
- geode_product_name: Geode
- geode_product_version: 1.2
- product_name_long: Apache Geode
- product_name: Geode
- product_version: 1.2
```

Expand All @@ -79,15 +79,16 @@ Instead of:

Do this:

<% set_title(geode_product_name_long, geode_product_version, "Documentation") %>
<% set_title(product_name_long, product_version, "Documentation") %>

Why? Because the `title:` construct is not Ruby code, it's YAML, and it cannot interpret Ruby variables.

**Cautions:**

- Begin with `<%`, not `<%=`. (We're invoking a function, not printing its value.)
- Do not put a space before the opening parenthesis (use `set_title(` not `set_title (`.)
- **Do not** quote the three product variable names (`geode_product_name`, `geode_product_name_long`, and `geode_product_version`). **Do** quote all other text.
- **Do not** quote the three product variable names (`product_name`, `product_name_long`, and `product_version`). **Do** quote all other text.
- This feature requires Bookbinder v10.1.7 (Aug 2017) or later.



0 comments on commit b775c84

Please sign in to comment.