|
Packit |
e90573 |
gnome-getting-started-docs
|
|
Packit |
e90573 |
==========================
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
This package contains the Getting Started guide which is packaged and
|
|
Packit |
e90573 |
shipped as gnome-getting-started-docs in the core GNOME distribution.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
The GNOME Documentation Project (GDP) is responsible for this documentation.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
GDP homepage: http://live.gnome.org/DocumentationProject
|
|
Packit |
e90573 |
GDP mailing list: http://mail.gnome.org/mailman/listinfo/gnome-doc-list
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Translators
|
|
Packit |
e90573 |
-----------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Although this guide includes a number of media files (videos, SVGs),
|
|
Packit |
e90573 |
translators just need to translate a single POT file for the Getting Started
|
|
Packit |
e90573 |
guide, which also includes strings extracted from the media files.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Where to get translated videos
|
|
Packit |
e90573 |
------------------------------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
As a temporary workaround for https://bugzilla.gnome.org/show_bug.cgi?id=699998,
|
|
Packit |
e90573 |
translated videos are not stored in the Git repository anymore, instead, they
|
|
Packit |
e90573 |
are pulled from an external source at the following URL when releasing a new
|
|
Packit |
e90573 |
tarball:
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
http://people.gnome.org/~jimmac/gnome-getting-started-docs/
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Rendering video files
|
|
Packit |
e90573 |
---------------------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Rendering translated videos is not currently supported at build time. If you
|
|
Packit |
e90573 |
want to have the video files generated for your language, please get in touch
|
|
Packit |
e90573 |
with gnome-getting-started-docs maintainers. The plan is to have the video
|
|
Packit |
e90573 |
files generated for all available languages when releasing a new tarball.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
See the animation/language-whitelist.txt file in the gnome-getting-started-docs
|
|
Packit |
e90573 |
repository for a list of languages for which the videos are currently rendered.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Generating SVG files
|
|
Packit |
e90573 |
--------------------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
To generate translated SVGs that are used as still images for some topics in
|
|
Packit |
e90573 |
the guide, run the following command in the gnome-getting-started-docs root
|
|
Packit |
e90573 |
directory:
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
./autogen.sh && make
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Then change to the gnome-help/<your_language>/ directory to see your
|
|
Packit |
e90573 |
translated SVGs.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Note that depending on your distribution, you may need to install some
|
|
Packit |
e90573 |
additional packages to run the commands.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Please do not commit the generated SVGs, these files will be regenerated for
|
|
Packit |
e90573 |
all available languages when releasing a new tarball. The .gitignore file is
|
|
Packit |
e90573 |
properly set to ignore these files.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
The gs-browse-web.page file
|
|
Packit |
e90573 |
---------------------------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
The gs-browse-web.page file contains conditionalized information on both the
|
|
Packit |
e90573 |
upstream default browser Web (Epiphany) and Firefox, which often replaces Web
|
|
Packit |
e90573 |
as the default browser downstream.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
See comments in the gs-browse-web.page file for a hint on how to adjust the
|
|
Packit |
e90573 |
file so that the appropriate information is displayed for your downstream
|
|
Packit |
e90573 |
distribution.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Language packs
|
|
Packit |
e90573 |
--------------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Given the size of the video files, distributors might want to create
|
|
Packit |
e90573 |
language packs for individual locales, as the overall package size for
|
|
Packit |
e90573 |
the gnome-getting-started-docs package would be too large otherwise.
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
Reporting problems
|
|
Packit |
e90573 |
------------------
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
If you find problems in the documentation, please report bugs in GNOME Bugzilla:
|
|
Packit |
e90573 |
|
|
Packit |
e90573 |
https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-getting-started
|