From owner-freebsd-doc@FreeBSD.ORG Sun Sep 19 19:05:30 2004 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 8ADD716A4CE; Sun, 19 Sep 2004 19:05:30 +0000 (GMT) Received: from abigail.blackend.org (blackend.org [212.11.35.229]) by mx1.FreeBSD.org (Postfix) with ESMTP id 43A8D43D4C; Sun, 19 Sep 2004 19:05:29 +0000 (GMT) (envelope-from marc@blackend.org) Received: from abigail.blackend.org (localhost [127.0.0.1]) i8JJ5KPS009248; Sun, 19 Sep 2004 21:05:20 +0200 (CEST) (envelope-from marc@abigail.blackend.org) Received: (from marc@localhost) by abigail.blackend.org (8.12.11/8.12.11/Submit) id i8JJ5Jxg009247; Sun, 19 Sep 2004 21:05:19 +0200 (CEST) (envelope-from marc) Date: Sun, 19 Sep 2004 21:05:19 +0200 From: Marc Fonvieille To: Giorgos Keramidas Message-ID: <20040919190519.GG60807@abigail.blackend.org> References: <414C2915.8000309@elvandar.org> <20040919172514.GD2907@gothmog.gr> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20040919172514.GD2907@gothmog.gr> User-Agent: Mutt/1.4.2.1i X-Useless-Header: blackend.org X-Operating-System: FreeBSD 4.10-PRERELEASE cc: freebsd-doc@freebsd.org Subject: Re: Question regarding 'placeholders' (Translations) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 19 Sep 2004 19:05:30 -0000 On Sun, Sep 19, 2004 at 08:25:14PM +0300, Giorgos Keramidas wrote: > On 2004-09-18 14:24, Remko Lodder wrote: > > --- chapter_orig.sgml Sat Aug 14 14:35:33 2004 > > +++ chapter.sgml Sat Sep 18 14:20:02 2004 > > @@ -442,6 +442,32 @@ > > --> > > > > > > + > > + > > + > > + How should i handle untranslated documents when i want to > > + import them into the &os; cvs tree? > > + > > + > > + > > + If you have untranslated documents, or documents which are > > + not yet reviewed, you should use so called > > + placeholders. The correct syntax for using > > + those placeholders is: > > + > > + <sect1> > > + <title>* Translated title</title> > > + > > + <para></para> > > + </sect1> > > + > > + The para statements are used to fill the sections. If > > + they do not exist it will result in a failing build. If > > + you have a sect2 or deeper statement in your chapter, please > > + put the para statements in the deepest section. > > + > > + > > + > > > > > > This looks fine. You can even simplify the text of the last paragraph a > bit by using: > > Section elements (sect, sect1, etc.) require at least some content. > To silence the SGML parser, you can use the empty trick > until you have real content to add. How this could be fine? This patch does not clearly state that the non-translated text must not be left in the SGML files. And the placeholders used are non-efficient, just try to put one in the Handbook and read the TOC, you will see... And what means the * ? Something in progress? The logic would say to use something like Non-translated title * To Be Translated * or Non-translated title * Translation In Progress * which are easily understable and easy to locate in a (large) TOC. Marc