Skip to Content.
Sympa Menu

texmacs-users - Re: Changing links in online documentation

Subject: mailing-list for TeXmacs Users

List archive

Re: Changing links in online documentation


Chronological Thread 
  • From: David Allouche <address@hidden>
  • To: address@hidden
  • Subject: Re: Changing links in online documentation
  • Date: Tue, 15 Oct 2002 00:58:33 +0200

On Mon, Oct 14, 2002 at 11:53:02PM +0200, Michèle Garoche wrote:
>
> I've just beginning to translate the online documentation into French,
> starting with the manual.

Great!

> As I'm completely new to TeXMacs, I would appreciate greatly if someone
> could explain me in great details how to change the hyperlinks (labels
> and urls) so that when inserting in the online documentation the links
> point to the right files.
>
> eg: In man-scheme.en.tm the first link has a label named Configuration
> of TeXMacs and points to
> conf/man-configuration.en.tm
>
> I have to change it to: Configuration de TeXMacs and it should point to
> conf/man-configuration.fr.tm.

Short answer:

Change "Configuration of TeXmacs" to "Configuration de TeXmacs" and
change "config/man-configuration.en.tm" to
"config/man-configuration.fr.tm". That is perfectly WYSIWYG.

Long answer:

Those lists in the online documentation are special structures
designed specifically for the online doc. The list items are
'branch' environments. When you look at the 'tmdoc-traversal.ts'
package you will see the definition of the environment (here in
Scheme style):

(assign "branch" (macro "x" "y" "z"
(concat (item)
(hlink (arg "x") (arg "z"))
" (" (arg "y") ", "
(with "font family" "tt" (arg "z"))
").")))

That means the branch takes three parameters. The hyperlink title
<arg|x>, appears first, then some passive text <arg|y>, and then a
relative file name <arg|z> which is also used as the hyperlink
destination.

If you maintain a translation, be careful to keep a copy of the orginal
file you translated. So, when the documentation is updated, it will be
easy (using diff, or emacs ediff command) to know what has changed and
how the translation must be updated.

I am currently working on the english documentation, so I want to make
sure my efforts will not cause us to end up with out of date
translations :-(

--
David Allouche | GNU TeXmacs -- Writing is a pleasure
Free software engineer | http://www.texmacs.org
http://ddaa.net | http://alqua.com/tmresources
address@hidden | address@hidden
TeXmacs is NOT a LaTeX front-end and is unrelated to emacs.




Archive powered by MHonArc 2.6.19.

Top of Page