From owner-freebsd-doc Fri Jan 4 15:51:31 2002 Delivered-To: freebsd-doc@freebsd.org Received: from heaven.gigo.com (gigo.com [207.173.11.186]) by hub.freebsd.org (Postfix) with ESMTP id 6D64237B405 for ; Fri, 4 Jan 2002 15:51:14 -0800 (PST) Received: from ppp072-bsace7023.telebrasilia.net.br (ppp072-bsace7023.telebrasilia.net.br [200.163.6.72]) by heaven.gigo.com (Postfix) with ESMTP id 95B71B8D5 for ; Fri, 4 Jan 2002 15:51:07 -0800 (PST) Received: (qmail 35647 invoked by uid 1001); 4 Jan 2002 23:50:40 -0000 Message-ID: <20020104235040.35646.qmail@exxodus.fedaykin.here> Date: Fri, 4 Jan 2002 21:50:18 -0200 From: Mario Sergio Fujikawa Ferreira To: doc@FreeBSD.org Cc: Jose Porfirio , Roberto Cantanhede Subject: Generating 2 file versions of the same info (xml+glossary related) Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i X-Operating-System: FreeBSD 4.5-PRERELEASE X-Disclaimer: I hope you find what you are looking for... in life :) Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org Hi, I wrote a short glossary I use for the translation effort from English to Brazilian Portuguese of the FreeBSD documentation. We (the translant are about to finish a couple chapters from the Handbook. I wanted to add this glossary to the translated documentation. This glossary would be for the whole translated documentation not only for a particular part (e.g., handbook). Therefore, I was thinking about adding it as pt_BR.ISO8859-1/share/sgml/glossary.sgml with an appropriate entry to pt_BR.ISO8859-1/share/sgml/bookinfo.ent. For instance, A authored escrito B backward-compatible compatível de forma regressa S set ajustar; atribuir gives entries for both authored, backward-compatible and set. All documents in the pt_BR.ISO8859-1 would have pointers to the glossary. So, I have an English to Brazilian Portuguese which helps both readers and translators since they can try to understand how things were translated. This is important because many english words have a clear context due to their open use in Computer related literature. However, no such semantic background may exist for their translated counterparts. Nevertheless, what about users trying to understand "compatível de forma regressa"? They may clearly understand backward-compatible but completely miss "compatível de forma regressa". Where the hell did that come from? :) That's where a Brazilian Portuguese to English glossary is most helpful. The English to Brazilian Portuguese glossary above translated to a Brazilian Portuguese to English one: A ajustar set atribuir atribuir set ajustar C compatível de forma regressa backward-compatible E escrito authored As you can see, "set" became 2 entries ("ajustar" and "atribuir") parsed by the ';' separator with appropriate entries. Furthermore, the glossdef "compatível de forma regressa" became id "compativel--de--forma--regressa", for id only accepts alphanumeric and dash ("-") characters. As you can see, there are good reasons to have both files. Moreover, we can have the words point to their glossary entries which helps a lot. Furthermore, we could add "dictionary definitions" (written by the users, not taken from actual dictinaries due to Copyright issues) to some entries. C compatível de forma regressa backward-compatible, compatible with previous versions These 2 files can be easily generated from a well delimited file authored|escrito set|ajustar|atribuir backward-compatible|compatível de forma regressa using a perl script. Nonetheless, we have xml tools in the doc system. And, this is a prime candidate for a xml parsing tool. It could automagically generate both files from a xml file. I know this is possible and, hopefully, not difficult but I lack the knowledge to do it. Anyone volunteers? Nik? This would be a huge improvement for the translating teams. And, to the english documentation itself since we could begin using glossary dictionary definitions to clarify some texts. Regards, -- Mario S F Ferreira - DF - Brazil - "I guess this is a signature." Computer Science Undergraduate | FreeBSD Committer | CS Developer flames to beloved devnull@someotherworldbeloworabove.org feature, n: a documented bug | bug, n: an undocumented feature To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message