This site has been retired. For up to date information, see handbook.gnome.org or gitlab.gnome.org.


[Home] [TitleIndex] [WordIndex

Yelp » Tools »

yelp-new

Create a new file from a template. You can quickly create a new page or other file from a template. This is useful when many of your pages have a common layout or structure. You must pass at least two arguments: the identifier of the template, and the ID of the file to create. The second argument is used both for the base file name of the new file and for the id attribute. You can optionally pass a page title as the third argument.

Template files can be installed with yelp-new or they can be kept locally in the same directory. Local templates are useful if you have common page styles that are specific to your project. To get a list of available templates, run yelp-new --help.

You can create your own template files. Just create a file with the .tmpl extension appended. You can also use the --tmpl option on yelp-new to copy an existing template to the current directory without substituting, allowing you to build off of it for your own template.

Output files are created by substituting special markers in the template.

You can also pass the --stub option to create a .page.stub file instead of a regular .page file.


2024-10-23 10:58