From 51b38ad8b63871c15eef6d438f6ea0ed8fbb99e6 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Tue, 24 Aug 2010 21:35:52 +0100 Subject: [PATCH] Doc: CG: discuss useful scripts. node-menuify.py for the docs, and .bib stuff for the website. --- Documentation/contributor/doc-work.itexi | 29 ++++++++------------ Documentation/contributor/website-work.itexi | 6 ++++ 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index cab96b90a4..abd8c1654f 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -1353,34 +1353,29 @@ scripts/auxiliar/cg-section.sh doc-work Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized for your installation. -@subheading Stripping whitespace +@subheading Stripping whitespace and generating menus -@c TODO: should this be documented elsewhere? It's useful for -@c more than just docs. -To remove extra whitespace from the ends of lines, run +@warning{This script assumes that the file conforms to our doc +policy; a few files still need work in this regard.} + +To automatically regenerate @code{@@menu} portions and strip +whitespace, use: @example -scripts/auxiliar/strip-whitespace.py Documentation/FILENAME +scripts/auxiliar/node-menuify.py @var{FILENAME} @end example -@subheading Sectioning commands - -@warning{These commands add whitespace.} +@subheading Stripping whitespace only -The emacs @code{M-x texinfo-all-menus-update} command will -regenerate @@menu blocks. This can also be run with this -command-line script: +@c TODO: should this be documented elsewhere? It's useful for +@c more than just docs. +To remove extra whitespace from the ends of lines, run @example -#!/bin/sh -emacs $1 -batch -f texinfo-all-menus-update -f save-buffer +scripts/auxiliar/strip-whitespace.py Documentation/FILENAME @end example -@noindent -(save the above as something like @command{texinfo-menus.sh}, make -it executable, then run @command{texinfo-menus.sh foo.itely}) - @subheading Updating doc with @command{convert-ly} diff --git a/Documentation/contributor/website-work.itexi b/Documentation/contributor/website-work.itexi index 4d71c32e97..ba1ddcb039 100644 --- a/Documentation/contributor/website-work.itexi +++ b/Documentation/contributor/website-work.itexi @@ -39,6 +39,12 @@ subsections or subsubsections. link to any pieces of automatically generated documentation, like the IR or certain NR appendices. +@item +The bibliography in Community->Publications is generated automatically +from @file{.bib} files; formatting is done automatically by +@file{texi-web.bst}. + +@item @dots{} @item -- 2.39.5