[Bacula-devel-fr] Re: Switching to tex masters in the manuals

[Kern S. <ke...@si...>]

On Friday 11 March 2005 18:47, Karl Cunningham wrote:
> Hi Kern -
>
> Here is my list of what should happen to switch from html masters to LaTeX.
> The same steps need to be taken for both the English and French versions.
> Obviously some of these changes are optional, but I think now is as good a
> time as any to do these things. Of course probably each one of us will have
> backups in case something goes wrong.
>
> I envision the purpose of check_hyphens.pl changing from modifying the tex
> files to an advisory function for errors and potential problems in the tex
> files.  I suggest renaming this program tp check_tex.pl to be more in line
> with this purpose.  I have created several small programs for my own
> purposes during the course of this project that perform other functions
> like this, and I will incorporate some of these into checK_tex.pl over the
> next couple weeks.  I think this may be a good thing to use going forward.
> Another option is a perl or sed script to parse the LaTeX log file for
> serious errors.

Yes, this is an excellent idea.

>
> These are the major parts I see to this changeover.  Each is described more
> fully below.
>
> Establish a starting point
> Make a backup of bacula/doc
> Changes to the Makefile
> Changes to bacula.tex and developers.tex
> Changes to check_hyphens.pl
> Adding, removing, renaming files from the directories
> Adding, removing files from cvs.
>
> Following is a detailed description of each of these parts:
>
> -- Establish a starting point
> Make sure that any pending changes to the wml and html files are completed
> and committed to cvs.

I have just done this, so it will not be necessary for you to do it.

> Do a cvs update
> do: 'make h2l links check_hyphens tex'.  Then do 'make check_hyphens tex'.
> There is slight interaction between make_hyphens and tex so they need to be
> done an extra time just to be sure.
>
> -- Make a backup of bacula/doc
I have also done this for me. You should still do this.
> I plan to use tar to make a copy in case something goes wrong.
>
> -- Changes to the Makefile
> Remove 'h2l' and 'links' targets
> Rename hyphens target to texcheck and have it invoke check_tex.pl instead
> of check_hyphens.pl (see below).
> In the tex: and devtex: targets, build index files directly from makeindex
> using the -o switch, and have makeindex create .tex files instead of
> .linked.tex.
> In the tex: and devtex: targets, remove the mv commands for the index
> files. In the tex: and devtex: targets, Rename check_hyphens.pl to
> check_tex.pl and change the files it processes from .linked.tex to .tex
>
> -- Changes to bacula.tex and developers.tex
> Change all the \include{*.linked.tex} to \include{*.tex}
>
> -- Changes to check_hyphens.pl
> Rename check_hyphens.pl to check_tex.pl.
> Modify it to do only a check and advise rather than change files.
Good idea
> Add more functionality.
Nice!
>
> -- Adding, removing, renaming files.
> Rename all the .linked.tex files to .tex.  This can be done with the
> following command in the bacula/doc/latex directory:
>   for a in *.linked.tex; do mv -f ${a} `echo ${a} | sed
> 's/\.linked\.tex/.tex/'`; done
> Remove all the other files with linked in their names, such as
> *.linked.aux.  One might want to check first to be sure this doesn't remove
> anything needed.  Use the following command:
>   rm -f *linked*
>
> -- Adding, removing files from cvs.
> Remove the following from cvs:
>   link_resolver.pl
>   bacula.scales
>   check_hboxes.pl
>   html2latex
>   html2latex.tag
>   html2lat.bat
>   html2latex-local.tag
>   html2latex.1
>   webtex2latex.tag (???)
>
> Rename (remove, then add) the following in cvs:
>   check_hyphens.pl -> check_tex.pl
>   baculai-dir.linked.tex -> baculai-dir.tex
>   baculai-fd.linked.tex -> baculai-fd.tex
>   baculai-sd.linked.tex -> baculai-sd.tex
>   baculai-console.linked.tex -> baculai-console.tex
>   baculai-general.linked.tex -> baculai-general.tex
>
>
> Obviously, files removed from cvs can be removed from local directories
> too.  I'll probably do that but keep my .tar.gz backup of the whole thing
> around for a while.  Please let me know what I've missed or if there's
> anything you'd like to change about this.

As far as I can tell, you have covered all the points. Thanks for working out 
all the details.  

>
> I plan to do this tomorrow around 16:00Z, if that's ok with everyone.

This is fine with me. Please proceed. I won't make any changes to the CVS in 
the doc directory until I hear from you that it is OK to do an update.

Thanks.

-- 
Best regards,

Kern