View Issue Details

IDProjectCategoryView StatusLast Update
0000538Cinelerra-GG[All Projects] Featurepublic2021-03-01 16:08
Reportersge Assigned ToPhyllisSmith  
Status closedResolutionfixed 
Product Version 
Target VersionFixed in Version 
Summary0000538: Cinelerra manual in HTML form
DescriptionHere I suggest the following: we can, after minimal adaptation, generate segmented hypertext Cinelerra manual in the HTML form via the latex2html translator from the same LaTeX sources from which the PDF manual is generated.

You can quickly look on the result on my webserver at this link:

or download the whole archived HTML manual to look locally (about 50 Mb):

The patch against the manual sources from git of yesterday is attached here:
Additional InformationHow to prepare manual for building both PDF and HTML versions at once.

1. Install latex2html translator as follows:

1a) Check your version of perl: perl -v

Perl version 5.18 has bug which prevents latex2html from functioning correctly. The perl version must be either higher or lower, but not equal to 5.18. For example, both perl-5.10 and perl-5.22 are correct.

1b) The stock latex2html distribution will not (yet) do the job. It has to be patched. I have sent my patch to latex2html developers, perhaps they will implement it in their coming release, but just now it is not yet there.

Download latex2html-2020.2 either from github:

or from my webserver (it is an exact copy of the original one):

Download latex2html patch from my webserver which is necessary for successful translation of Cinelerra manual:

The patch must be applied as usually:
zcat latex2html-2020.2.diff.gz | patch -p1

Actually this BT is much more about latex2html development than Cinelerra :-)

1c) Install the necessary tools (if not yet there), most important netpbm.

1d) Install latex2html from the patched sources (example):

zcat latex2html-2020.2.diff.gz | patch -p1
./configure --prefix=/usr/local/lib/latex2html
make check
make install
ln -s /usr/local/lib/latex2html/bin/latex2html /usr/local/bin/latex2html

The detailed installation instructions are in the latex2html source archive.

2. Prepare the Cinelerra manual itself:

2a) zcat CinelerraGG_Manual.diff.gz | patch -p1

In addition to few changes, there will be created several new files:
html.sty, translate_manual, .latex2html-init, and rename-pngs.

2b) Execute the shell script rename-pngs

There are several pictures in the directory 'images' with filenames which end with '.png'. But actually they are JPEG images, not PNG images. Pdflatex can correctly process such images despite incorrect extension, but latex2html has problems with them.

rename-pngs renames these image files into '.jpg', this should be done once, then the renamed files rechecked into the manual's git.

2c) Now we are ready to translate the manual.

html.sty is a package distributed as part of latex2html. I have put it into the manual top directory so that it could be found by latex independently from installation paths.

.latex2html-init is an important file with latex2html settings. It can be adapted to some extent. For exampe, you can configure footer of generated HTML pages, title, etc. At the very end of .latex2html-init there are definitions of some latex commands to be ignored by the translator, don't remove them.

translate_manual is a shell script which executes the necessary sequence of commands to produce PDF manual, and then HTML manual.

Perhaps the files html.sty, translate_manual, and .latex2html-init are also subject to checking into git.

The adaptations of the original Cinelerra manual are really minimal. Mostly they are '.png' changed to '.jpg' in several files,
and several corrected typos. All the changes in packages and settings are made so that pdflatex simply will not see them, they all will be interpreted by latex2html only.

Later any additions to the latex sources of the manual can be immediately actualized in HTML without any extra actions, except running translate_manual.
TagsNo tags attached.




2021-02-26 21:04

manager   ~0004658

You are right - I had an earlier zip file and now everything is working correctly.
I checked in the diff changes for:
    translate_manual (and left in show_section_numbers for now but I am no using yet);
    latex2html-init (checked in without the . same as before because not sure if it is confusing one way or the other)
Will close this a few days from now.


2021-02-26 14:56

reporter   ~0004657

The latex2html installator installs the directories 'versions' and 'styles' by recursive copying of both dirs with the whole their contents. If you cannot see nomencl.perl in your installation hierarchy, this means either:

a) You have got somehow an outdated latex2html distribution. Please check if there is nomencl.perl inside the master source archive.


b) You tried to install the up-to-date latex2html, but either the installation failed, or the program landed in some improper place of the filesystem, so that when you execute 'latex2html' some version of the program is called which was installer earlier.

If your actual version of latex2html is outdated and has no nomencl.perl, then it is totally useless to copy this file from any other source. Nomencl.perl alone cannot do the whole job, it needs a definite support from the main latex2html script. And if the installation is outdated, then the main script must be outdated also, and the whole package is unable to perform the translation consistently.

Perl-5.30.1 is most probably OK, mine is 5.22.

*** redefining \nomname *** is mentioned because the CGG manual file common/settings.tex contains redefinition of the corresponding command, and latex2html notices this:

\renewcommand{\nomname}{Glossary} % glossary name

Please recheck which instance of the latex2html source archive you tried to install. I attach here that which I downloaded. If the contents differ, you must have the wrong one. (1,350,734 bytes)


2021-02-26 03:29

manager   ~0004656

More information follows on debugging of my missing Glossary.

Neither nomencl.perl or nameref.perl were in the /styles/ subdir of my newly installed latex2html so I copied there but that still did not result in a Glossary.html file. I discovered them missing by comparing the logfile on the original version and the new.
I had used the line: ./configure --prefix=/usr/local/lib/latex2html (without the perl inclusion) I already had v 5.30.1 installed.

The next thing I noticed in the comparison of the logfile was missing the line:,,
*** redefining \nomname ***
but I am not sure this is related to the real problem. I do see "nomname" discussed inside of nomencl.perl.

I will keep looking.


2021-02-25 22:57

manager   ~0004655

Sorry to make you work so hard.

1) The svg is now gif -- I had forgotten that I removed the -image-type gif when getting error messages about no types. This was due to my installing netpbm (on Fedora) which also needed netpbm-progs to be installed for the types.

2) I will have to debug the problem with the Glossary myself as when I compare the file CinelerraGG_Manual.nls from each of the laptops, the original latex2html implementation and the newly installed implementation are exactly the same. And the CinelerraGG_Manual.pdf file has the Glossary on both but the HTML version does not. I have compared the 2 logfiles - old with new - and the new one is missing the Glossary processing (712/716) AFTER the Workflow processing:

Doing footnotes .....
710/716:section:..."Workflow with multi-cam and external audio" for Workflow_with_multi_cam_ext.html
711/716:paragraph:.."Note:" for Workflow_with_multi_cam_ext.html
Doing footnotes .....
Reading nls file: /proj/working/CinelerraGG_Manual.nls ...
Processing macros ...
Reading nls file: /proj/working/CinelerraGG_Manual.nls ...
Processing macros ...++......
........."Glossary" for Glossary.html


2021-02-25 15:37

reporter   ~0004654

I tested the whole stuff once again just now with the contents freshly checked out.

1) Downloaded

2) unzip latex2html-master
# I need the three lines with '/usr/local/new/bin' because the perl
# version installed in my system is inappropriate, v5.18.1, I have a
# correct version v5.22.2 is in /usr/local/new
export PATH=/usr/local/new/bin:$PATH
hash -r
./configure --prefix=/usr/local/lib/latex2html --with-perl=/usr/local/new/bin/perl
make check
make install

3) edit /usr/local/lib/latex2html/
line 63 - to create gif instead of default svg:
@IMAGE_TYPES = qw(gif png svg);
line 1103 - same for icons:
foreach $typ ('gif', 'png') {
line 1130 - choosing icons type:
%icons = %{"icons_gif"};

4) checkout manual
zcat ../CinelerraGG_Manual-210205.diff.gz | patch -p1
zcat ../CinelerraGG_Manual-210205-2.diff.gz | patch -p1
# The dot-initfile is actually used !
cp latex2html-init .latex2html-init

5) # Create .aux files
pdflatex CinelerraGG_Manual.tex
# Create Index
makeindex CinelerraGG_Manual.idx
# Create Glossary
makeindex CinelerraGG_Manual.nlo -s -o CinelerraGG_Manual.nls
# Update .aux files, 2-nd run (cross refs changed)
pdflatex CinelerraGG_Manual.tex
# Update Index, 2-nd run (cross refs changed)
makeindex CinelerraGG_Manual.idx
# Update .aux files, 3-rd run (cross refs changed)
pdflatex CinelerraGG_Manual.tex
Review CinelerraGG_Manual.pdf if everything right.

6) # Safety step as latex2html tries to reuse some results from the previous run
rm -rf CinelerraGG_Manual
latex2html -html_version 4.0,math -use_pdftex -nouse_dvipng -long_titles 5 -image_type gif -nofootnode -split +3 -link 3 -bottom_navigation -local_icons -t 'CinelerraGG_Manual' CinelerraGG_Manual.tex
# This picture has to be copied explicitly
cp images/cin-big.png CinelerraGG_Manual
# Clean up
rm -f CinelerraGG_Manual/WARNINGS
rm -f CinelerraGG_Manual/*.pl
rm -f CinelerraGG_Manual/images*

7) firefox CinelerraGG_Manual/CinelerraGG_Manual.html
Now everything looks by me as usually. There exists Glossary.html, and it is referenced in the Contents. Perhaps you might miss it if you did not execute the following command:

makeindex CinelerraGG_Manual.nlo -s -o CinelerraGG_Manual.nls

This particular command generates the actual Glossary file 'CinelerraGG_Manual.nls' which is then processed by latex2html. If latex2html finds no such file, it assumes that Glossary is not used and skips it completely.

On -show_section_numbers: I did not insist on it, I just wanted that you could test the result and make the decision, what looks better. Btw, the latex2html's default is not to use section numbers as it motivates the usage of distinct HTML pages as separate subdocuments.

On svg files: they are generated by latex2html by default. To have gifs instead of svgs, use '-image_type gif' and, may be (although perhaps not absolutely necessary) adapt as I wrote above. My version of is attached, you can diff it with yours one. (41,255 bytes)


2021-02-24 23:47

manager   ~0004653

It took me a long time to try this because I wanted to install it on another computer so that I had an easy backup.

Problem: Glossary.html file is now not being generated and Glossary not in the Contents.

Method of installation (after installing missing stuff on older Fedora laptop):
1) I downloaded to install latex2html master branch clicking on the zip file,, at:
2) patched withCinelerraGG_Manual-210205.diff.gz and additionally CinelerraGG_Manual-210205-2.diff.gz
3) tested the addition of -show_section_numbers so that section numbers and Index are not conflicting? BUT I did not like it !! because now all of the .html files start with #_chapter_title_name instead of chapter_title_name and it does not look as pretty in the index and I thought it might be harder for users to find what they wanted to see directly without having to go through the Contents. This is just my opinion though and I can be persuaded of the necessity of adding the section numbers for a good reason.

Potential problem that I have not looked into yet. The 46 gif files before are now svg files in the directory. Not sure if this is a problem or not.


2021-02-13 17:31

manager   ~0004631

Great! I will checkout the latest GIT, test it and then close this. Thanks for all your time.


2021-02-13 17:18

reporter   ~0004630

Dan has committed my last change regarding -show_section_numbers to the latex2html git. Now section numbers and Index are not conflicting.

To get latex2html with these corrections, fetch latex2html-2021 as mentioned in my preceding note, apply latex2html-2021.diff.gz (also mentioned in that note), apply additionally latex2html2.diff.gz attached here, and reinstall. Or, alternatively, install latex2html master branch.

To try Cinelerra manual translation with section numbers, apply in the manual tree the patch CinelerraGG_Manual-210205.diff.gz (mentioned in the preceding note), and additionally CinelerraGG_Manual-210205-2.diff.gz attached here.

The latex2html option -show_section_numbers is added to the latex2html command line in the translate_manual script as an example (after applying the patches).

You can control the length of the phrase (in words) used in the section name references in navigation panels at the top and bottom of HTML pages through the configuration variable $WORDS_IN_NAVIGATION_PANEL_TITLES defined in the file .latex2html-init. Analogously, you can control phrase lengths taken from the section names in Index via the variable $WORDS_IN_INDEX, after uncommenting it in .latex2html-init. You can also control which words should not be counted in such phrases used for navigation, via the special variable $GENERIC_WORDS defined in (they are "and|the|of|for|by|a|an|to" by default). resides in the latex2html installation directory as a system-wide configuration.

Now I think, adaptation of latex2html and the translation technique to CGG manual can be considered finalized, and Issue 538 can be closed.

I am still going to experiment somehow to get keystroke-driven context dependent invocation of the HTML manual from Cinelerra, so let us leave Issue 540 open for some more time.

latex2html2.diff.gz (1,306 bytes)
CinelerraGG_Manual-210205-2.diff.gz (602 bytes)


2021-02-07 16:18

reporter   ~0004620

I found the correction to latex2html which enables section names in Index when -show_section_numbers is used. I have submitted the patch to the maintainer for approval. After its acceptance without further changes, I will inform you again about the actual possibility to evaluate the result of translation with -show_section_numbers.


2021-02-06 16:53

manager   ~0004619

Thanks for the update -- and especially for all the hard work to get the Cinelerra changes into latex2html source. I have downloaded the 2 diff.gz files so that I have them here local.


2021-02-06 10:43

reporter   ~0004618

Current status of latex2html concerning translation of CinelerraGG manual.

Latex2html version 2021 was released on Janyary 1 and is available from github:
This version could translate CGG manual somehow, but it does not have yet nomencl and nameref support.

My recent developments have been checked in latex2html github and are available in the master branch. They are:
1) Nomenclature support (nomencl.sty, already used in CGG manual in the form of a patched latex2html)
2) nameref.sty support (already used in CGG manual in the patched form)
3) Corrected \centering command (new, not yet applied for CGG manual translation environment)
4) Corrected footnote counters which do not screw up any more if used in sections or captions (new, not yet applied for CGG)
5) Implemented support for the documentclass memoir (new, not yet applied for CGG)

To get these new features, it is possible either:
a) wait until a next latex2html release (although I don't know how long to wait)
b) fetch the current master branch from latex2html github and install it
c) download latex2html version 2021 from github (, apply the attached patch latex2html-2021.diff.gz and install

After installation of the new mentioned version of latex2html, the CGG manual translation environment can be patched with the attached CinelerraGG_Manual-210205.diff.gz:

common/settings.tex: several %begin{latexonly} / %end{latexonly} brackets are unnecessary any more, due to intrinsic memoir support. They are not conflicting, but simply redundant now.
.latex2html-init: settocdepth # {} can be removed from &ignore_commands (redundant due to memoir support).

The option -numbered_footnotes is not needed any more: due to memoir support the footnotes will be numbered correctly with the same numbers as in PDF (even if used inside section names)
The option -cut_ref_name does not exist any more and has to be removed. The default behavior is now to cut them; if the ref names are needed, they can be explicitly added with another option -add_ref_name
You can try to use the additional option -show_section_numbers: the items in the lists of figures and tables will then get the same numbers as in PDF. Surprisingly, the Index will then display section numbers instead of section names - perhaps I can figure out where it comes from.

latex2html-2021.diff.gz (17,078 bytes)
CinelerraGG_Manual-210205.diff.gz (1,518 bytes)


2021-01-15 21:29

manager   ~0004518

HTML version on website is now updated. I tested the nomencl-nobold.perl but used the original instead as it looked better. Andrea and I fixed the problem with the duplicate footnote numbers by moving them away from the section/subsection titles. So now it looks better. I have no open issues here so I "think" we are now only waiting for Dan to release all of the SGE improvements and additions to latex2html.


2021-01-13 14:07

reporter   ~0004510

Phyllis, take another version from this attachment, nomencl-nobold.perl, rename it to nomencl.perl and place into latex2html/styles - you should get Glossary formatted with descriptions starting from newline, but without items automatically forced to bold font. So, in your case they should come out regular blue.

nomencl-nobold.perl (4,434 bytes)


2021-01-13 05:13

manager   ~0004509

It worked flawlessly. I did not update the HTML manual on the website yet and I do want to keep the blue instead of the bold for the entries as long as no one objects -- the bold is just too bright.


2021-01-12 15:51

reporter   ~0004508

In attachment you find nomencl.perl, put this file in the /styles/ subdir of your latex2html installation replacing the older version of nomencl.perl. The true reinstallation or reconfiguration of latex2html is not necessary, replacing this single file is sufficient.
Then translated manual will come out with Glossary in the 'new' style.

nomencl.perl (4,466 bytes)


2021-01-11 18:49

manager   ~0004506

"Which formatting style is better?" -- in my opinion, Glossary-new is better and a lot easier to read because all of the descriptions start in the same spot on a new line. I agree, Awesome.


2021-01-11 16:56

manager   ~0004505

Awesome; any of your additions are great!


2021-01-11 15:48

reporter   ~0004504

Phyllis, Andrea, here is a small archive attached, with Glossary-old.html (that, which was generated before changing textbf to blue colored text), Glossary-new.html (a variant formatted so that each item's description starts on a new line, like for Index entries and description environments), and CinelerraGG_Manual.css which is needed as its styles are requested by both html files.
Please unpack these somewhere and compare the look of Glossary-new with Glossary-old (this time ignoring color). Which formatting style is better? Either we leave Glossary formatting as it is, or change it (as in '-new'), in the latter case I'll ask Dan to update the nomencl processing in the latex2html's git repository.

glossaries.tar.gz (26,662 bytes)


2021-01-11 09:27

manager   ~0004503

Of course, the glossary with the blue entries is fine; it's very nice!


2021-01-10 22:46

manager   ~0004502

I understood that it was a browser problem and not the LaTeX font but I wanted to change it to blue anyway. I have updated the HTML and PDF manuals on the website so Andrea can check the Glossary for HTML and hopefully says that the change is acceptable to him too.


2021-01-10 17:18

reporter   ~0004496

I meant the browser's font, not the LaTeX font. For example, my browser (Firefox, for example) on my OS (Slackware-14.1) selects some other font to reflect textbf-like properties, this font has a regular depth, and the indentation by me looks normally.
You can test the Glossary webpage with some other browser, and the wrong indentation will quite likely disappear.


2021-01-09 23:20

manager   ~0004494

Last edited: 2021-01-10 22:43

View 2 revisions

Thanks for explanation of textbf issue. I switched to color CinBlueText after not finding a way to use my own definition of textBF for a different font. I think I like blue better anyway so I checked it into GIT. Have not updated the HTML and PDF manuals on the website yet though. Will leave 538/540 as expected.



2021-01-08 17:31

reporter   ~0004491

I understand now the reason for strange indentations in Glossary. It is due to strange parameters of the bold font. You can see that each second line of a multiline Glossary description is indented exactly as the first line. It is controlled not by latex2html, but by the browser. Perhaps the depth of glyphs in this font is slightly bigger, and it leads to such indentation. You can notice that the description preceding to 'Aliasing' is exactly one line long. The word 'Aliasing' occupies the second line, therefore is indented equally. The second line under 'Aliasing' is indented yet more, but the third line has a normal indentation again.
Browser is responsible for such a formatting. Perhaps with other browser, or with other fontset it will look differently.
In principle, it is possible to modify Glossary processing in latex2html to yield pages formatted in a way similar to the description list in Do you mean that such Glossary, with new line after each item, will look better?
I don't want BT540 being closed yet. I am planning to experiment with keystrokes a bit more, to get some kind of a context help in CinGG. So let's leave it also opened. I suspended my playing with it because it depends on the HTML manual itself, and stabilizing this form of the manual was of a higher priority.


2021-01-07 18:13

manager   ~0004490

It is just me!

must_be_me.png (232,965 bytes)
must_be_me.png (232,965 bytes)


2021-01-07 18:11

manager   ~0004489

Last edited: 2021-01-07 18:12

View 2 revisions

I will update translate_manual and check it in.
Attached is what Glossary looks like here from website and local file for me, but I use Fedora O/S and am not very good at setup so do not be concerned about it.
I need to delete the .jpg files from the website CinelerraGG_Manual directory too and will check on render.jpg in GIT and will delete it.
Will wait to close this issue (and 540?) until latex2html gets updated -- very exciting that Dan will incorporate these great improvements !

(Oops, see next note for attachment)



2021-01-07 17:43

reporter   ~0004488

Thanks also from me. Good that the project part, touched by the introduction of latex2html in the build process, has stabilized and became successful.
Please actualize the translation options you are using, in the translate_manual script, for later reference.

I did not understand the nature of the problem you report for Glossary (under "Aliasing"). In the browsers I have tested Glossary looks OK, on the website as well as in my local directory. I tested it with Firefox, Chrome, Konqueror, Safari.
By the way, the \nomenclature command which is used to populate Glossary allows LaTeX commands both in the description part and in the item part. It is quite possible, when desired, to put a \label in the \nomenclature item and to put a \hyperref to it in that place of the manual where such item is mentioned. Then it will appear as the corresponding link to the description in the HTML manual. And it is allowed to place \nomenclature definitions anywhere in the document, similarly to Index commands.

I have found the file "images/render.jpg", although render.png also exists. Perhaps, render.jpg has to be removed from git.

I am communicating with Dan Gildea, the current maintainer of latex2html, on the actual form of the added latex2html options. Depending on the actual option names, as they will be checked in the latex2html's git, there may come one more subtle change to the translation script - later, after the next latex2html release appears. Perhaps don't close this issue yet.


2021-01-07 01:59

administrator   ~0004485

Glad to hear there was a solution for that after all. It will be easier for search engines to index them better and users will be able to find the content they are looking for faster. Thanks for the effort.


2021-01-07 00:25

manager   ~0004484

Thanks for the changes and good/clear instructions.
- I have been using latex2html-2020.2 so used that again and applied the patch latex2html-2020.2.diff2.gz .
- I had a hard time making a decision of which I liked best -- cut_ref_name or cut_ref_num? but ended up with cutting the name.
- Also changed .latex2html-init date from 2020 to 2021.
- Checked into GIT all of the necessary changes and updated both the HTML and PDF manuals on the website.

There is one problem in the Glossary - I am using "memoir" but tested "book" also. And the problem is sometimes it is not lined up nicely but it can just be ignored in my opinion. You can see this if you look at "Aliasing" in the HTML version Glossary on the website.

The section names are now the long names instead of the node#.html names. I found the 3 out of 500 conflicting section names and renamed them so there are no duplicate names overwriting. These names are more helpful, although you have to remember to add the underlines between words and some words are abbreviated or cut off and capitalization matters. Using the long names results in duplicate numbers for the footnotes but they can just be ignored.


2021-01-03 14:24

reporter   ~0004447

Phyllis, I have won the glossary and references. Please reinstall latex2html in either of two alternative manners, whatever is more convenient to you:

a) You can checkout the github master branch from and apply the patch latex2html-201224.diff.gz (the patch is attached here).

b) Or you can untar the version latex2html-2020.2 (same as I recommended earlier) but this time apply the other patch latex2html-2020.2.diff2.gz (also attached here). This patch includes all the previous features (lstlisting support, etc.) plus the Glossary features, everything in one patch.

Then install this new patched latex2html same as before.

Then apply the following patch to the CinelerraGG_Manual sources: CinelerraGG_Manual-201224.diff.gz. It is patch against the manual sources as checked out on 24.12.2020. The patch is also attached here. There are very few changes:

common/settings.tex: the conditional redefinition of \nameref goes away. I have implemented \nameref in the latex2html translator.
parts/Real-World.tex: small font made conditional. Latex2html does not like font changes outside braces. Here it could not correctly revert back to normal font after \small{\url{...}}.
translate_manual: I changed this translation example to reflect implemented translation of Glossary.

Now the answers to your comments to BT540.

1) The Glossary should now work correctly. Implemented in the latex2html translator.

2) As you mentioned, the cross references include both the number of a section (figure) and the caption. I have added to the latex2html translator two new options:

-cut_ref_num - cut the caption number from the reference text
-cut_ref_name - cut the caption name from the reference text

You can play with these options and choose, which one will look nicer. To get caption numbers only, without names (as in LaTeX), you have to use the option -cut_ref_name (look in the patched translate_manual).

latex2html-2020.2.diff2.gz (25,243 bytes)
latex2html-201224.diff.gz (5,671 bytes)
CinelerraGG_Manual-201224.diff.gz (1,456 bytes)


2020-12-24 16:48

reporter   ~0004436

Very good! Getting something really new with few efforts is always nice.
On .latex2html-init: there is a line near the beginning of the file with the assignment to the variable $ADDRESS. In the moment it sounds like 'The CINELERRA-GG Community, 2020' May be, shortly after the next edition in the manual you will have intent to change 2020 to 2021.
On translate_manual: I created it just as an example and, to some extent, as a memo how to run latex2html. You were right to adapt the translation sequence to your LaTeX environment.
On 'rm': don't forget however to perform the complete cleaning the HTML directory before running latex2html. The translator caches images and the CSS file from the preceding run. If the document was edited in the middle, new text with old images can produce a mess.

As said, I'll do some experiments with the Glossary and then inform you.


2020-12-23 22:54

manager   ~0004434

Last edited: 2020-12-24 02:50

View 2 revisions

Thanks for all of the previous hints. I was able to get it mostly working just fine with a little bit of modifications for Fedora. The Glossary is not a big concern to me.

I checked into GIT your original html.sty and latex2html.init which is exactly what I used. Since I did not know for sure if GIT allowed for checking in as ".latex2html", that is with the dot at the beginning, I just added it without the dot (.). I also checked in your original translate_manual because it obviously works on non-Fedora. My Fedora version difference is only due to having to continue to use "memoir" which then required that I include "-numbered_footnotes". And I create the PDF document first with 1 script, check it out, and then have a separate script to create the HTML version (and I never use "rm" in a script since I always login as root).

Both the PDF and HTML versions are updated on the website.



2020-12-19 06:55

reporter   ~0004431

On images* files: which ones will be created and which will not, depends on the actual image generation pipeline, which itself depends on the images format requested (latex2html option -image_type gif / png / svg), and on the actual algorithm employed (option -use_dvipng / -nouse_dvipng). The amount of diagnostics concerning image generation is also different as different program tools are involved in the 6 possible combinations of these options.
IMHO, most informative disgnostics is provided when the older generation algorithm is used (-nouse_dvipng), and the GIF format is requested (-image_type gif). Therefore I personally prefer always to try -nouse_dvipng -image_type gif first, eliminate problems (if any), then choose evtl other appropriate algorithm and image format. When -nouse_dvipng -image_type gif works, then other combinations usually work too.
What about the third option group, -use_pdftex / -nouse_pdftex / -use_luatex / -use_luadvi, they are important but depend on the document syntax: is the document written for plain latex (to produce DVI), or for pdflatex, or for the modern lualatex. In our case we have to do -use_pdftex.

On the question which style to use: the various styles have only subtle influence on the result appearance. Latex2html has distinct modules for several styles like book, report, article, letter, amsbook, amsart, a few others. It has no special treatment for memoir, processes it nevertheless under some default settings. This is the reason why, for example, footnotes look differently for memoir and book. I'd recommend to switch the style temporarily to book for latex2html translation - then the result in some places looks slightly more beautiful - and then revert it back to memoir. Exactly this is specified in the translate_manual script.

On diverse quirks you are describing. Latex2html tries but is not able to process *any* possible document. When some quirk is encountered, one can consider: either rewrite the problematic part of text (may be inside begin{latexonly} / begin{htmlonly}), or set the problematic command to be ignored, or try to implement the missing but highly desirable feature in latex2html. So I have implemented the listings package especially for this manual, and some particular options in other places which were used too often in the manual to edit them all.
Latex2html does not like TeX commands inside captions and section names (sometimes it succeeds to translate them correctly, sometimes not) - it is because the captions are collected via the LaTeX *.aux files. This is exactly that what you report about ShapeWipe figure.
Sometimes (fortunately rare) on encountering some complicated construction latex2html can loose opening or closing brace, and then the rest of the translation can be corrupted. Sometimes it can be difficult to find the right place which is responsible for that (try sequentially to comment/uncomment parts of document to localize the problem).
Your reported problem of not reverted back font change may be some of this sort, such problems with font switching in latex2html are known.

On Glossary: unlike Index, Glossary is not yet implemented in latex2html at all. Don't do anything with Glossary yet. I think, after you basically finish adjustment of your latex2html environment, I'll refetch the updated manual from git, and then mock up with Glossary somehow. Most likely, I'll end up with the implementation of the Glossary style for latex2html, and we will have it.

When trying to figure out why something works under Fedora and works not under Ubuntu (or whatever), try to compare the latex2html system settings file (i wrote about in in my preceding note). Pay attention on the tools and their paths (search for example $PDFCROP, $PPMTOGIF, etc.)


2020-12-19 02:55

manager   ~0004430

Update: using Fedora which is often different in some aspects then the debian/ubuntu base O/S versions. I have not sent a logfile because I am not totally stuck yet and need to learn how to handle future problems too.

When using "book" in CinelerraGG_Manual.tex all that was created was images.tex but no images.pdf or images-crop.pdf and images.tex looked good. Eventually I decided to switch back to "memoir" and then visually spot checked each page and compared it to the HTML manual Georgy created. It seemed mostly the same in looks. I noted one difference of concern (that I plan on checking out tomorrow) -- the footnotes did not come up with numbers but just a triangle-looking thing. But all of the images, including the pdf ones, showed up and all of the math equations (frac) were correctly translated. And images.tex and images.pdf were created with images.pdf having about 45 images in it. However, there was no images-crop.pdf file and yet nothing obvious looked bad in the end result HTML version.

The "book" version has a difference from both the PDF manual and the "memoir" HTML version in the Shuttle key default arrangement -- it is missing the lines above/below the key layout.

Both the "book" and "memoir" versions had 1 problem when using symbols for a figure that I have since just changed and checked into GIT (it is too trivial to spend a lot of time figuring out what went wrong) .
1) Expanders for Plugin Subtrees as in:
Effects/Transitions or Audio Effects/Transitions. You can not sort once an expansion is in effect (figure 10.11$$,$&rtri#triangleright;$ = expander; "-" = options).
2) Shape Wipe (for "memoir" only) as in:
Example of the Shape Wipe $\rightarrow$ Star

Another problem both now have is the list of the Shape Wipes all of a sudden switch to Bold font whereas the PDF version does not. My guess is that it is because "asimetric" should really be spelled "asymetric" in english (smiley face here).

And last the "Glossary" in both does not have its own section but is stuck on the end of Armandux Use Case. The index does work very well in the HTML version though.

I also checked in all of the changes you made to add more index entries.


2020-12-18 14:35

reporter   ~0004429

This seems that generation of images in your installation does not work at all. Please try the following.

1. Clean the HTML directory (latex2html tries to cache images and the CSS file, so without cleaning you may not be able to reproduce the fresh run).

rm -rf CinelerraGG_Manual

2. Translate manually with the modified options. '-nouse_dvipng -image_type gif' yields some more diagnostics and temporaries for problem analysis. Piping the output into a logfile can give additional info.

latex2html -html_version 4.0,math -use_pdftex -nouse_dvipng -image_type gif -nofootnode -split +3 -link 3 -bottom_navigation -local_icons -t 'Cinelerra-GG Infinity' CinelerraGG_Manual.tex |& tee logfile

3. In the resulting CinelerraGG_Manual directory there should appear the files images.tex, images.pdf, and images-crop.pdf. The former is exactly that LaTeX source from which images are actually generated. The second is the PDF file with the images, exactly one image per PDF page. And the latter is PDF file where each page is cropped to contain the image and an optional marker for the determination of the exact location of image baseline.

If images.tex does not exist (or does not resemble a legal LaTeX document), then latex2html itself has worked incorrectly.

If images.tex looks OK but images.pdf doesn't, most likely it means that pdflatex cannot translate it for some reason.

If images.pdf is OK but images-crop.pdf isn't, it means that pdfcrop did not work.

If images-crop.pdf contains about 50 images, but still no images named 'img??.gif' then either gs (the GhostScript interpreter), or some of image converters from the Netpbm package does not work.

You can send me:

a) the logfile from the latex2html run
b) the three images*.{tex,pdf} files, if any
c) the configfile <latex2html install directory>/ (/usr/local/lib/latex2html/ provided that latex2html was installed in /usr/local/lib/latex2html)

and I can look what happens.

My email is: [email protected]


2020-12-18 03:15

manager   ~0004428

Last edited: 2020-12-18 03:28

View 3 revisions

More testing progress here. I have checked into GIT all of the Cinelerra_GG_Manual.diff.gz changes so that is no longer needed. And I have successfully created the CinelerraGG_Manual directory with all the files BUT in checking the results so far (only up to Camera and Projector in Windows chapter) I have 4 problems that I am still working on. Again, this could just be me and I am quite sure that I applied the latex2html patch.

1) none of the \frac statements seem to work and I just end up with that statement. For example in Plugins.tex Title:
+ increases the size by ${\frac{{5}}{{4}}}$, - decreases ${\frac{{4}}{{5}}}$ or use a number > 0 but less than 2048

2) tikzpicture seems to not work.
So for example in Snapshot / Grapshot instead of the image, I have:
\begin{tikzpicture}[scale=1...{reticle.png}}; \end{tikzpicture}

3) on the first page I ended up with:

4) The 3 pdf files in Windows.tex do not show up but just the original statement.

All 4 look good in the HTML version supplied by you that is on the website. I have not yet had sufficient time to diligently figure this out yet but will try tomorrow.



2020-12-16 16:02

reporter   ~0004427

While translating document, latex2html always prints a couple of error/warning messages like that 'No implementation found for some style', or 'Unknown command', or whatever. Such messages should not alarm you as long as the translation result looks adequate. The standard reaction of latex2html on an unrecognized command or environment is trying to feed the unknown fragment to LaTeX to get an image (tikz or a complicated math, for example). Usually such workarounds succeed and the result looks good despite warnings about unrecognized constructs.


2020-12-16 03:49

manager   ~0004426

After following the instructions (without the latex2html patch yet), I managed to create an HTML version -- at least with errors that I caused. With Andrea's jpg-to-png changes that I checked into latex GIT today, rename-pngs can now be eliminated. Tomorrow I will apply the latex2html patch using the GITHUB version but I have to be careful to know what I am doing first in case I make a mistake. If all goes well then at some point as Georgy suggested the files html.sty, translate_manual, and .latex2html-init should be checked into git for ease of use. This is GREAT and the instructions are so easy to follow now that Georgy has done all of the hard work for us.


2020-12-15 18:46

manager   ~0004425

In order to at least get rid of known JPEG images that are marked as PNGs (listed in rename-pngs and below), if you have time could you remake these as real pngs? For example, if you type "file plugin.png" you will see it says it is a JPEG file. I can do the two-monitor ones and other ones if necessary though.


I am still working on following Georgy's instructions so that I can re-create the HTML version at the same time as updating the PDF version.


2020-11-25 13:41

reporter   ~0004373

Daniel Gildea, current maintainer of latex2html, confirmed that he has included my changes in the master branch of the translator. So, next year it should not be necessary to patch latex2html for translation of Cinelerra manual any more.


2020-11-24 16:27

reporter   ~0004372

@Andrea_Paz: yes, it is quite possible to integrate HTML manual in the CinGG help, see an example in BT540.


2020-11-23 20:56

administrator   ~0004371

This is great news! Really great work Georgy. I'm delighted with your creative power.

I welcome to have the manual as HTML too. On the webserver we have enough space to realize everything. I will check next weekend how we can integrate it on the server. But I will use my test server first before I use it on the live server.


2020-11-23 18:45

manager   ~0004370

Great job.
There is also pending work to turn the manual into asciidoc, but it is too early to know anything.
Let's hear Sam's opinion for the inclusion in the website.
Is it possible to integrate it in the help of CinGG?


2020-11-23 17:35

manager   ~0004369

This is GREAT news! I will have to study your steps because several of us frequently make small changes so will have to know how to keep both versions up to date. THANKS !


2020-11-23 15:47


CinelerraGG_Manual.diff.gz (21,083 bytes)

Issue History

Date Modified Username Field Change
2020-11-23 15:47 sge New Issue
2020-11-23 15:47 sge File Added: CinelerraGG_Manual.diff.gz
2020-11-23 17:35 PhyllisSmith Assigned To => PhyllisSmith
2020-11-23 17:35 PhyllisSmith Status new => acknowledged
2020-11-23 17:35 PhyllisSmith Note Added: 0004369
2020-11-23 18:45 Andrea_Paz Note Added: 0004370
2020-11-23 20:56 Sam Note Added: 0004371
2020-11-24 16:27 sge Note Added: 0004372
2020-11-25 13:41 sge Note Added: 0004373
2020-12-15 18:46 PhyllisSmith Note Added: 0004425
2020-12-16 03:49 PhyllisSmith Note Added: 0004426
2020-12-16 16:02 sge Note Added: 0004427
2020-12-18 03:15 PhyllisSmith Note Added: 0004428
2020-12-18 03:28 PhyllisSmith Note Edited: 0004428 View Revisions
2020-12-18 03:28 PhyllisSmith Note Edited: 0004428 View Revisions
2020-12-18 14:35 sge Note Added: 0004429
2020-12-19 02:55 PhyllisSmith Note Added: 0004430
2020-12-19 06:55 sge Note Added: 0004431
2020-12-23 22:54 PhyllisSmith Note Added: 0004434
2020-12-24 02:50 PhyllisSmith Note Edited: 0004434 View Revisions
2020-12-24 16:48 sge Note Added: 0004436
2021-01-03 14:24 sge File Added: latex2html-2020.2.diff2.gz
2021-01-03 14:24 sge File Added: latex2html-201224.diff.gz
2021-01-03 14:24 sge File Added: CinelerraGG_Manual-201224.diff.gz
2021-01-03 14:24 sge Note Added: 0004447
2021-01-07 00:25 PhyllisSmith Note Added: 0004484
2021-01-07 01:59 Sam Note Added: 0004485
2021-01-07 17:43 sge Note Added: 0004488
2021-01-07 18:11 PhyllisSmith Note Added: 0004489
2021-01-07 18:12 PhyllisSmith Note Edited: 0004489 View Revisions
2021-01-07 18:13 PhyllisSmith File Added: must_be_me.png
2021-01-07 18:13 PhyllisSmith Note Added: 0004490
2021-01-08 17:31 sge Note Added: 0004491
2021-01-09 23:20 PhyllisSmith Note Added: 0004494
2021-01-10 17:18 sge Note Added: 0004496
2021-01-10 22:43 PhyllisSmith Note Edited: 0004494 View Revisions
2021-01-10 22:46 PhyllisSmith Note Added: 0004502
2021-01-11 09:27 Andrea_Paz Note Added: 0004503
2021-01-11 15:48 sge File Added: glossaries.tar.gz
2021-01-11 15:48 sge Note Added: 0004504
2021-01-11 16:56 Andrea_Paz Note Added: 0004505
2021-01-11 18:49 PhyllisSmith Note Added: 0004506
2021-01-12 15:51 sge File Added: nomencl.perl
2021-01-12 15:51 sge Note Added: 0004508
2021-01-13 05:13 PhyllisSmith Note Added: 0004509
2021-01-13 14:07 sge File Added: nomencl-nobold.perl
2021-01-13 14:07 sge Note Added: 0004510
2021-01-15 21:29 PhyllisSmith Note Added: 0004518
2021-02-06 10:43 sge File Added: latex2html-2021.diff.gz
2021-02-06 10:43 sge File Added: CinelerraGG_Manual-210205.diff.gz
2021-02-06 10:43 sge Note Added: 0004618
2021-02-06 16:53 PhyllisSmith Note Added: 0004619
2021-02-07 16:18 sge Note Added: 0004620
2021-02-13 17:18 sge File Added: latex2html2.diff.gz
2021-02-13 17:18 sge File Added: CinelerraGG_Manual-210205-2.diff.gz
2021-02-13 17:18 sge Note Added: 0004630
2021-02-13 17:31 PhyllisSmith Note Added: 0004631
2021-02-24 23:47 PhyllisSmith Note Added: 0004653
2021-02-25 15:37 sge File Added:
2021-02-25 15:37 sge Note Added: 0004654
2021-02-25 22:57 PhyllisSmith Note Added: 0004655
2021-02-26 03:29 PhyllisSmith Note Added: 0004656
2021-02-26 14:56 sge File Added:
2021-02-26 14:56 sge Note Added: 0004657
2021-02-26 21:04 PhyllisSmith Note Added: 0004658
2021-02-28 17:34 PhyllisSmith Status acknowledged => resolved
2021-02-28 17:34 PhyllisSmith Resolution open => fixed
2021-03-01 16:08 PhyllisSmith Status resolved => closed