Translating the Docs: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
Line 13: Line 13:


So each of these is a subdirectory of the one above. Inside en/ are the HTML files that make up the documentation, and there is also a file named menu.xml:
So each of these is a subdirectory of the one above. Inside en/ are the HTML files that make up the documentation, and there is also a file named menu.xml:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<menu>
<area text="Welcome" file="index.html">
<submenuitem text="Readme First" file="readme.html"/>
</area>
<area text="Documentation" file="intro.html">
<submenuitem text="Introduction" file="documentation.html">
<submenuitem text="About the team" file="about1.html"/>
<submenuitem text="Specifications" file="specs.html"/>
</submenuitem>
<submenuitem text="Installation" file="install.html">
<submenuitem text="Scribus Source &amp; SVN" file="install1.html"/>
<submenuitem text="Requirements" file="install2.html"/>
<submenuitem text="Compiling using CMake" file="install4.html"/>
<submenuitem text="Compiling using CMake on OS X" file="install5.html"/>                   
<submenuitem text="Parallel Install" file="parallel-install.html"/>
<submenuitem text="Debian dpkg Information" file="install-dpkg.html"/>
</submenuitem>
<submenuitem text="Cross Platform" file="cross-platform.html">
<submenuitem text="Mac OSX Readme" file="readme-macosx.html"/>
<submenuitem text="Mac OSX/Fink" file="machints1.html"/>
<submenuitem text="Mac OSX/Fink &amp; SVN" file="machints2.html"/>
<submenuitem text="OS/2 Readme" file="readme-os2.html"/>
<submenuitem text="Windows Readme" file="readme-win32.html"/>
</pre>

Revision as of 17:07, 1 December 2010

As we approach the eventual release of 1.4, and beyond, we are trying to make an effort to improve the online docs. So far, we are concentrating on the English version (you have to start somewhere), but we hope to have volunteers come forward to help us, not only with the traditional translations to French, German, Czech, and Polish, but also as many others as we can get volunteers for.

Since the Scribus online manual is shown with a simple browser, the files are in HTML. Perhaps the best way to get the most up to date manual is by downloading from svn. Even if you don't plan to compile Scribus, you can download source files, which include the docs. Go HERE for instructions. You must have subversion on your computer (there are ways to use subversion on Windows, but I have not tried).

Where are the docs?

Let's say you put them in a directory named Scribus:

Scribus

  • scribus
    • doc
      • en
        • images

So each of these is a subdirectory of the one above. Inside en/ are the HTML files that make up the documentation, and there is also a file named menu.xml:

<?xml version="1.0" encoding="UTF-8"?>
<menu>
	<area text="Welcome" file="index.html">
		<submenuitem text="Readme First" file="readme.html"/>
	</area>
	<area text="Documentation" file="intro.html">
		<submenuitem text="Introduction" file="documentation.html">
			<submenuitem text="About the team" file="about1.html"/>
			<submenuitem text="Specifications" file="specs.html"/>
		</submenuitem>
		<submenuitem text="Installation" file="install.html">
			<submenuitem text="Scribus Source & SVN" file="install1.html"/>
			<submenuitem text="Requirements" file="install2.html"/>
			<submenuitem text="Compiling using CMake" file="install4.html"/>
			<submenuitem text="Compiling using CMake on OS X" file="install5.html"/>                     
			<submenuitem text="Parallel Install" file="parallel-install.html"/>
			<submenuitem text="Debian dpkg Information" file="install-dpkg.html"/>
		</submenuitem>
		<submenuitem text="Cross Platform" file="cross-platform.html">
			<submenuitem text="Mac OSX Readme" file="readme-macosx.html"/>
			<submenuitem text="Mac OSX/Fink" file="machints1.html"/>
			<submenuitem text="Mac OSX/Fink & SVN" file="machints2.html"/>
			<submenuitem text="OS/2 Readme" file="readme-os2.html"/>
			<submenuitem text="Windows Readme" file="readme-win32.html"/>