| <!DOCTYPE html> |
| <html> |
| <!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ --> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022), |
| a documentation system that can produce both online information and a |
| printed manual from a single source using semantic markup. |
| |
| Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc. |
| |
| Permission is granted to copy, distribute and/or modify this document |
| under the terms of the GNU Free Documentation License, Version 1.3 or |
| any later version published by the Free Software Foundation; with no |
| Invariant Sections, with no Front-Cover Texts, and with no Back-Cover |
| Texts. A copy of the license is included in the section entitled |
| "GNU Free Documentation License". --> |
| <title>@value Example (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="@value Example (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="@value Example (GNU Texinfo 6.8dev)"> |
| <meta name="resource-type" content="document"> |
| <meta name="distribution" content="global"> |
| <meta name="Generator" content="texi2any"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| |
| <link href="index.html" rel="start" title="Top"> |
| <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> |
| <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> |
| <link href="_0040set-_0040clear-_0040value.html" rel="up" title="@set @clear @value"> |
| <link href="_0040inlineifset-_0040inlineifclear.html" rel="prev" title="@inlineifset @inlineifclear"> |
| <style type="text/css"> |
| <!-- |
| div.example {margin-left: 3.2em} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="subsection-level-extent" id="g_t_0040value-Example"> |
| <div class="nav-panel"> |
| <p> |
| Previous: <a href="_0040inlineifset-_0040inlineifclear.html" accesskey="p" rel="prev"><code class="code">@inlineifset</code> and <code class="code">@inlineifclear</code></a>, Up: <a href="_0040set-_0040clear-_0040value.html" accesskey="u" rel="up">Flags: <code class="code">@set</code>, <code class="code">@clear</code>, conditionals, and <code class="code">@value</code></a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> |
| </div> |
| <hr> |
| <h4 class="subsection" id="g_t_0040value-Example-1">15.5.4 <code class="code">@value</code> Example</h4> |
| |
| <a class="anchor" id="value-Example"></a> |
| <p>You can use the <code class="code">@value</code> command to minimize the number of |
| places you need to change when you record an update to a manual. |
| See <a class="xref" href="GNU-Sample-Texts.html">GNU Sample Texts</a>, for the full text of an example of using this |
| to work with Automake distributions. |
| </p> |
| <p>This example is adapted from <cite class="cite"><a data-manual="make" href="https://www.gnu.org/software/make/manual/html_node/index.html#Top">The GNU Make Manual</a></cite>. |
| </p> |
| <ol class="enumerate"> |
| <li> Set the flags: |
| |
| <div class="example"> |
| <div class="group"><pre class="example-preformatted">@set EDITION 0.35 Beta |
| @set VERSION 3.63 Beta |
| @set UPDATED 14 August 1992 |
| @set UPDATE-MONTH August 1992 |
| </pre></div></div> |
| |
| </li><li> Write text for the <code class="code">@copying</code> section (see <a class="pxref" href="_0040copying.html"><code class="code">@copying</code>: Declare Copying Permissions</a>): |
| |
| <div class="example"> |
| <div class="group"><pre class="example-preformatted">@copying |
| This is Edition @value{EDITION}, |
| last updated @value{UPDATED}, |
| of @cite{The GNU Make Manual}, |
| for @code{make}, version @value{VERSION}. |
| |
| Copyright … |
| |
| Permission is granted … |
| @end copying |
| </pre></div></div> |
| |
| </li><li> Write text for the title page, for people reading the printed manual: |
| |
| <div class="example"> |
| <div class="group"><pre class="example-preformatted">@titlepage |
| @title GNU Make |
| @subtitle A Program for Directing Recompilation |
| @subtitle Edition @value{EDITION}, … |
| @subtitle @value{UPDATE-MONTH} |
| @page |
| @insertcopying |
| … |
| @end titlepage |
| </pre></div></div> |
| |
| <p>(On a printed cover, a date listing the month and the year looks less |
| fussy than a date listing the day as well as the month and year.) |
| </p> |
| </li><li> Write text for the Top node, for people reading the Info file: |
| |
| <div class="example"> |
| <div class="group"><pre class="example-preformatted">@ifnottex |
| @node Top |
| @top Make |
| |
| This is Edition @value{EDITION}, |
| last updated @value{UPDATED}, |
| of @cite{The GNU Make Manual}, |
| for @code{make}, version @value{VERSION}. |
| @end ifnottex |
| </pre></div></div> |
| |
| <p>After you format the manual, the <code class="code">@value</code> constructs have been |
| expanded, so the output contains text like this: |
| </p> |
| <div class="example"> |
| <div class="group"><pre class="example-preformatted">This is Edition 0.35 Beta, last updated 14 August 1992, |
| of `The GNU Make Manual', for `make', Version 3.63 Beta. |
| </pre></div></div> |
| </li></ol> |
| |
| <p>When you update the manual, you change only the values of the flags; you |
| do not need to edit the three sections. |
| </p> |
| |
| </div> |
| <hr> |
| <div class="nav-panel"> |
| <p> |
| Previous: <a href="_0040inlineifset-_0040inlineifclear.html"><code class="code">@inlineifset</code> and <code class="code">@inlineifclear</code></a>, Up: <a href="_0040set-_0040clear-_0040value.html">Flags: <code class="code">@set</code>, <code class="code">@clear</code>, conditionals, and <code class="code">@value</code></a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> |
| </div> |
| |
| |
| |
| </body> |
| </html> |