From owner-svn-doc-head@freebsd.org Fri Oct 30 01:10:22 2015 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 8E780A207A9; Fri, 30 Oct 2015 01:10:22 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 4097B15EB; Fri, 30 Oct 2015 01:10:22 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id t9U1ALAQ009948; Fri, 30 Oct 2015 01:10:21 GMT (envelope-from wblock@FreeBSD.org) Received: (from wblock@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id t9U1ALRC009947; Fri, 30 Oct 2015 01:10:21 GMT (envelope-from wblock@FreeBSD.org) Message-Id: <201510300110.t9U1ALRC009947@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: wblock set sender to wblock@FreeBSD.org using -f From: Warren Block Date: Fri, 30 Oct 2015 01:10:21 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r47702 - head/en_US.ISO8859-1/books/fdp-primer/po-translations X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 30 Oct 2015 01:10:22 -0000 Author: wblock Date: Fri Oct 30 01:10:21 2015 New Revision: 47702 URL: https://svnweb.freebsd.org/changeset/doc/47702 Log: Add a tip about re-using $ entities in example version strings. Modified: head/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml Thu Oct 29 22:43:45 2015 (r47701) +++ head/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml Fri Oct 30 01:10:21 2015 (r47702) @@ -676,6 +676,38 @@ DOC_PREFIX?= ${.CURDIR}/../../.. + + <literal>$FreeBSD$</literal> + Strings + + The $FreeBSD$ version strings used in + files require special handling. In examples like + , these + strings are not meant to be expanded. The English documents + use &dollar; entities to avoid + including actual literal dollar signs in the file: + + &dollar;FreeBSD&dollar; + + The &dollar; entities are not seen + as dollar signs by the version control system and so the + string is not expanded into a version string. + + When a PO file is created, the + &dollar; entities used in examples are + replaced with actual dollar signs. The resulting literal + $FreeBSD$ string will be + wrongly expanded by the version control system when the file + is committed. + + The same technique as used in the English documents can be + used in the translation. The &dollar; + is used to replace the dollar sign in the translation entered + into the PO editor: + + &dollar;FreeBSD&dollar; + +