From c0b7451ffe2869421d448f3500190441d0ab4de4 Mon Sep 17 00:00:00 2001 From: Carl Sorensen Date: Thu, 16 Jul 2009 10:07:27 -0600 Subject: [PATCH] Add information about snippets and translations --- Documentation/devel/programming-work.itexi | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Documentation/devel/programming-work.itexi b/Documentation/devel/programming-work.itexi index c8684d3a54..1170949402 100644 --- a/Documentation/devel/programming-work.itexi +++ b/Documentation/devel/programming-work.itexi @@ -743,6 +743,21 @@ If the developer does not feel qualified to write the documentation, a documentation editor will be able to write it from the regression tests. +If the modification changes the input syntax so that inline snippets in +the documentation need to be changed, you will need to change the +snippets in both the english version of the documentation and any +translated versions. If you do not change the snippets in all +translations, older versions of the snippet may be included +when the documentation is built. + +If lsr snippets need to be changed, the snippet should be copied to +input/new and modified there. The portions of the snippet that +are added by makelsr.py should be removed. The changed snippet +will then be included in all versions of the documentation. + +If non-snippet text is changed in the english documentation, no +corresponding changes should be made in the translated documentation. + @subsection Write convert-ly rule If the modification changes the input syntax, a convert-ly rule -- 2.39.5