openoffice-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robw...@apache.org
Subject svn commit: r1530424 - /openoffice/site/trunk/content/website-native.mdtext
Date Tue, 08 Oct 2013 21:08:10 GMT
Author: robweir
Date: Tue Oct  8 21:08:10 2013
New Revision: 1530424

URL: http://svn.apache.org/r1530424
Log:
Initial check in

Added:
    openoffice/site/trunk/content/website-native.mdtext   (with props)

Added: openoffice/site/trunk/content/website-native.mdtext
URL: http://svn.apache.org/viewvc/openoffice/site/trunk/content/website-native.mdtext?rev=1530424&view=auto
==============================================================================
--- openoffice/site/trunk/content/website-native.mdtext (added)
+++ openoffice/site/trunk/content/website-native.mdtext Tue Oct  8 21:08:10 2013
@@ -0,0 +1,150 @@
+Title:
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+             http://www.apache.org/licenses/LICENSE-2.0
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+
+## Native Language (NL) Websites
+
+Apache OpenOffice supports users around the world via our many OpenOffice localizations,
via
+native language mailing lists and support forums, and by translations of our website.  This

+page describes the steps to create and maintain an NL website.  Following these steps you
+can create a website translation like our [Spanish](http://www.openoffice.org/es), 
+[Turkish](http://www.openoffice.org/tr) or [Dutch](http://www.openoffice.org/nl) websites.

+
+user interface
+Making updates to the Apache OpenOffice project's websites is simple.  It's even easy 
+for non-committers (new contributors - like you) to create a patch to request that 
+pages are updated by the project community.
+
+## The XX Website
+
+The easiest way to get started is with the [XX website](http://www.openoffice.org/xx).This

+website is a extract of the most-commonly visited pages from the English website, including:
+
+* The home page
+* The product description pages
+* The "Why OpenOffice?" pages
+* The download page
+* The support information pages
+
+Altogether, there are around 30 pages in the XX website. These are the ones that you will

+want to translate.
+
+## Creating the Test Directory
+
+In many cases there will already be an NL website for your language, but perhaps one that
is
+badly out-of-date or is non-standard.  However, until your new translation is ready to go
it 
+is probably best not to wipe out the existing NL page.  So initially you will probably want
+to do your work in a test directory.
+
+Let's take an example.  Suppose your target language is Italian (it).  You will want to do
+the following.  If you are not a Committer and are familiar with Subversion then you will
+want to get help with these steps by asking on the mailing list.
+
+ 1. Make a copy (svn copy) of the [ooo-site/trunk/content/xx directory](https://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/content/xx/)
+ as ooo-site/trunk/content/test-it.  In the copy replace all instances of "/xx" 
+in paths with "/test-it"/.
+ 1. Also make a copy of [ooos-site/trunk/templates/xx](https://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/templates/xx/)
+and call the copy ooo-site/trunk/templates/test-it.
+ 1. Commit these changes and publish via the CMS
+ 1. If you are a committer then you can translate the contents of the files in /test-it locally
+or via the CMS, whatever you prefer.  If you are not a committer than ask someone to do an

+"svn export" of the new /test-it and send a ZIP file of the contents.
+
+## Translating the Website
+
+The files will be in two main formats: 
+
+ 1. HTML files.
+ 1. Markdown text files. You can read more about Markdown Text [here](http://daringfireball.net/projects/markdown/basics).
+
+In your translation, do not change the file or directory names.  Be careful to preserve the
+markup of the HTML and the indentation levels of the MDText files.
+
+## The Template
+
+You will notice that there is more on the openoffice.org website than what you see in the

+/test-it content files.  The content files give the central part of each page, but the header,
+footer as well as navigation menus are generated by the template.  There are special MDText
+files that you will need to translate for the template.  They are:
+
+  - /xx/topnav.mdtext
+  - /xx/why/leftnav.mdtext
+  - /xx/product/leftnav.mdtext
+  - /xx/brand.mdtext
+
+For example, the /xx/topnav.mdtext has lines like this:
+
+    [Product][m0]
+    [Download][m1]
+    [Support][m2]
+
+Here you should translate the words "Product", "Download" and "Support".  Also, at the
+bottom of the file you will see hyperlinks, which should not be changed, and text hints for
+the hyperlinks which should be translated.
+
+A special word about brand.mdtext.  This contains several values that control the overall

+branding on the website.  The name and logo must not be changed, since these are our
+trademarks, but the "tagline" can be translated.    Note also the announcement and 
+announcementurl fields.  These control the blue announcement that is the top of every website
+page.  That should be translated and the URL changed if needed.  For example, in a new release
+you would want to point to a translated version of the release notes, if they exist.
+
+## Other Hints
+
+A few other things to watch out for.
+
+ 1. Some files contain an Apache License header at the top of the page.  You should not translate
that.
+ 1. Some files contain comments.  These don't need to be translated, but no harm is done
if they are.
+ 1. The /download/index.html requires special care since some of the language strings are
within
+Javascript blocks.  Ask for help if you need it here.
+ 1. It is easy to miss the social networking messages in /download/index.html.  These are
in the HTML
+header block and in function shareTwitter().  The string is something like "Join the OpenOffice
revolution, the free office productivity suite with over 60 million trusted downloads."  
+You should translate these, but adapt if needed to keep the Twitter string within the 140
limit for Twitter.
+
+## NL-Specific Content
+
+It may be desired to add language-specific custom content to the website.  For example:
+
+  - A localized Arabic website might want a special page dedicated to a description of how
+to use the bidirectional text features in OpenOffice.  The Tamil website might want a page
+that links to a particular open source font download that is recommended.
+  - There may be a local OpenOffice-related event that you want to publicize.
+
+New content pages can be added to your NL directory and links page from a navigator or from
+a news article on the home page as appropriate.
+
+## After Translation
+
+Once your translation is done, you can check it in (if you are a committer) or ask someone
to help
+you check it in and publish it to the website.  Review the published pages to verify that
the
+translation is as you want it, and that all links work.  Once it is ready you can rename
your 
+"test" directory and make it the new NL website for your language!
+
+Please Note:  If there is an existing NL website it is recommended that you do the switch
over like this:
+
+ 1. First delete the existing NL page, e.g., svn del /it.  Commit and publish that change.
+ 1. Then rename the content/test-it directory, e.g., svn move content/test-it content/it.
 
+ 1. Also rename the templates/test-it to /templates/it
+ 1. Commit these changes and commit them via the CMS
+
+This order is recommended, with the commit and publish after the deletion of the old directory,
+due to a CMS build issue we've run into if all these steps are done together in a single
commit.
+
+## Maintaining NL Websites
+
+Do try to check your NL website every few weeks to see if any changes are needed.  Try to
keep it in sync
+with the English website.  Is there a new announcement header?  A new release?  A new blog
post?
\ No newline at end of file

Propchange: openoffice/site/trunk/content/website-native.mdtext
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message