Skip to content

Commit

Permalink
Update the doc folder
Browse files Browse the repository at this point in the history
Update the English Manual to Ed. 1.55
Update doc/texinfo.tex to the latest release (04.02.08)
Update doc/TRANSLATIONS and doc/README_EN
For details see the doc/ChangeLog file
  • Loading branch information
Raffaella Traniello committed Mar 8, 2008
1 parent d39510d commit 8eff31e
Show file tree
Hide file tree
Showing 5 changed files with 2,233 additions and 473 deletions.
159 changes: 157 additions & 2 deletions doc/ChangeLog
@@ -1,11 +1,166 @@
2008-03-08 raffa <raffaella.traniello@livecom.it>

* 1.55.EN
Chapter 1: Introduction
- Updated edition number
- Fixed typo (FFMPEG)
- Fixed broken links

Chapter 2: Installation
- Added link to Fedora
- Fixed broken links
- Added Ubuntu Hardy packages

Chapter 5: Loading and saving files
- Note on backup.xml with two instances open

Chapter 14: Realtime effects
- Added title performance tip
- Fixed formatting

Chapter 16: Transitions
- Removed footnote, moved content to the glossary.
- Rewritten most of the content.


2008-02-16 raffa <raffaella.traniello@livecom.it>

* 1.54.EN
Chapter 1: Introduction
- Updated edition number
- Added a quote form Miro's Wiki about Cinelerra
- Added Norval Watson among the contributors
- Added Tutorial by Akirad and Howto on transcoding (by cillian)
- Added FFMPEG compatibility Howto and miscellaneous links on Interlacing and DVD-Video

Chapter 5: Loading and saving files
- Modified script for resizing images (note by Helge Nert, ML)
- Added descriptions of Imagemagick resizing
- Added details to the MPEG1 audio section

Chapter 20: Rendering Files
- Changed ffmpeg bitrate from -b 430 to -b 430k (by norv)

Chapter 21: Tips
- Removed description of issues fixed by r1052 (by j6t)


2008-02-09 raffa <raffaella.traniello@livecom.it>

Update doc/texinfo.tex to the latest release (04.02.08)


2008-01-28 raffa <raffaella.traniello@livecom.it>

* 1.53.EN
Chapter 1: Introduction
- Updated edition number

Chapter 2: Installation
- Improved Ubuntu package description


2008-01-06 raffa <raffaella.traniello@livecom.it>

* 1.52.EN
Chapter 1: Introduction
- Updated edition number
- Added Iñaki Larrañaga Murgoitio “Dooteo” as Basque translator.
- Added Paolo Rampino in the contributors' list
- Added a reference to doc/TRANSLATIONS for translators
- Pointed to doc/README_en for instructions for building the manual in other formats
- Pointed to SVN to get the manual sources.
- Added a tutorial and a miscellany link

Chapter 2: Installation
- Added ldconfig in the commands for compilation
- Fixed typo mmx32
- Added ArtistX live CD (by cillian)
- Added Musix live CD
- Added Ubuntu Gutsy repos by Paolo Rampino (by cillian and akirad)
- Added details about libfaac version for ubuntu 64 (by cillian)
- Added 2 Howtos for compilation in Ubuntu Gutsy
- Minor changes

Chapter 3: Configuration
- How to localize Cinelerra on distributions with only UTF-8 support (by Paolo Rampino)

Chapter 6: Program Window
- Added a note about sample zoom
- Added details about the label info dialog
- Added notes on patchbay attributes Mute track and Fader
- Reordered content (selection of multiple files)
- Added a list of editing operations
- Minor changes

Chapter 21: Tips
- Note about creating charset for localizing Cinelerra on distributions with only UTF-8 support (by Paolo Rampino)
- Added node 365 about creating DVD video from Lower Quality Footage (by aum)


2008-01-06 raffa <raffaella.traniello@livecom.it>

* doc/TRANSLATIONS - Update
Added details to the translation process.
Set the Cinelerra CV community as reference for translators.

* README_EN Updated
Added details in the description of the building of the Manuals from texinfo to all the available formats.


2007-11-04 raffa <raffaella.traniello@livecom.it>

* 1.51.EN

Chapter 1: Introduction
- Updated edition number
- Reordered and updated the list of contributors
- Deleted cogito from the list of application needed to fetch the manual sources
- Replaced out of date command for fetching manual sources with FIXME

Chapter 2: Installation
- Rescued forgotten changes about Gentoo installation made by Cillian on Dokuwiki
- Added Ubuntu Gutsy repos by Valentina Messeri

Chapter 5: Saving project files
- Added details to for fixing media linkage via GUI.

Chapter 6: Program Window
- Deleted contradictory informations about in/out points and highlighted areas.
- Added notes on setting in/out points on highlighted areas.

Chapter 8: Compositor window
- Added details about cropping and reordered content


2007-10-07 raffa <raffaella.traniello@livecom.it>

* 1.50.EN

Updated edition number

Chapter 2: Installation
- Change mmx to mmx32 for 32 bit Pentiums (by karrak)
- Add Marillat repository and delete obsolete information (by cosmo)

Chapter 6: Program window
- Added description of the Label tab of the Resources window

Chapter 20: Rendering files
- Adding information on converting flv file to swf and more detail on using flv movie players (by cillian)
- Added subsubsection yuv4mpeg pipe through mpeg2enc (node 363) (by kurts-film)
- Added subsubsection yuv4mpeg pipe through ffmpeg (node 364) (by kurts-film)

Chapter 21: Tips
- Added notes on HDV (new dvgrab HDV support and valid XML in recent version of Cinelerra) (by Marcin Kostur)


2007-09-27 Raffaella Traniello

* 1.49.EN

Chapter 14 Realtime Effects

Included changes from the following svn commits:
- Included changes from the following svn commits:
r1027: Updated Videoscope doc. Added 2 images (manual_images_intl). Patch by Craig Lawson.
r1028: Documentation for RGB-601 effect. Patch by Craig Lawson.
r1033: Update Threshold documentation. Patch by Craig Lawson.
Expand Down
27 changes: 20 additions & 7 deletions doc/README_en
Expand Up @@ -8,14 +8,27 @@ It is based on "Secrets of Cinelerra", an excellent manual written by Heroine
Virtual Ltd. Alex Ferrer's TWiki contents was put in by Nicolas Maufrais, who
worked on the original cinelerra.texi file in order to generate nice manuals.

To fetch the manual sources:
cg-clone git://scm.pipapo.org/cinelerra/nicolasm
The manual sources are shipped with Cinelerra's source code. They are Texinfo
files and can be easily converted to other formats.

To make the manuals in PDF, HTML and TXT formats, just execute:
./make_manuals.sh <language code>
Example: ./make_manuals.sh en

Dependency: texinfo has to be installed on your computer.
To make the manuals in PDF, HTML (single page) HTML (one page per chapter, in a
folder) and TXT formats just execute the script make_manuals.sh followed by the
language code.

Example for converting the English manual:
$ cd hvirtual/doc
$ ./make_manuals.sh en

To get a folder with one file per chapter in DokuWiki sintax, type:
$ cd hvirtual/doc
$ ./make_wiki.sh en

Dependencies:
To build the Manuals the following applications have to be installed on your computer:
texinfo
TeX (for Debian or Ubuntu: tetex-bin and tetex-base)
texi2html
html2wiki (HTML::WikiConverter, for Ubuntu: is called libhtml-wikiconverter-perl)

The manual can also be converted to Docbook, but you need the CVS version of
texinfo to do so. The "stable" version of Texinfo cannot produce a correct
Expand Down
24 changes: 13 additions & 11 deletions doc/TRANSLATIONS
Expand Up @@ -2,13 +2,16 @@ Here is some information about the manual translation process. It is intended
to be read by the maintainers of the Cinelerra CV manual in other languages
than English.

- To start a new translation, contact the Cinelerra CV documentation
maintainer: Nicolas MAUFRAIS - Email: e.conti@gmx.net
- Fetch the latest manual edition using the procedure described in the manual,
section "Introduction", subsection "About this manual".
- To start a new translation, contact the Cinelerra Community.
IRC: channel #cinelerra on Freenode.
Mailing list: cinelerra@skolelinux.no
- Make sure you have the the latest English manual edition.
- Translate the texinfo file cinelerra_cv_manual_en.texi, and rename it to
cinelerra_cv_manual_xx.texi, "xx" being the two-letter ISO-639 code of the
language you translate the manual to.
- Make sure your translated file is saved with ISO-8859 as character encoding
standard (UTF-8 is not fully supported by Texinfo, yet). Choose the part of
ISO-8859 appropriate for your language (eg: English is part 1 -> ISO-8859-1).
- Copy the manual_images_en folder, and rename it to manual_images_xx
- Change the images location in cinelerra_cv_manual_xx.texi, in order to point
to the images contained in manual_images_xx
Expand All @@ -19,14 +22,13 @@ than English.
convert the text and save them in .png format, using a level 7 compression
(in Gimp). Please do not rename the images filenames.
- Test everything works fine by running make_manuals.sh <language code>
- When you have finished, send everything to the Cinelerra CV documentation
maintainer.
- When you have finished, send everything to the Cinelerra CV community.

The translated manual will then be put into the Cinelerra CV documentation
repository and uploaded to the Cinelerra CV website.
The translated manual will then be put into the Cinelerra CV repository and
uploaded to the Cinelerra CV website.

While you translate the manual, chances are that a new edition of the English
manual is released. To keep track of the changes in the git repository, you can
use the gitk GUI. To easily find differences between each edition, we recommend
you use meld.
manual is released. To keep track of the changes see doc/ChangeLog file.
To easily find differences between each edition, we recommend you use meld
(http://meld.sourceforge.net/)

0 comments on commit 8eff31e

Please sign in to comment.