Difference between revisions of "Website Maintenance"

From GnuCash
Jump to: navigation, search
(Used Standards: ogp.me)
("Coding" Style: Multiple occurrences, Markups)
Line 19: Line 19:
 
* The ''dynamic parts'' are injectet via [[Glossary#P|PHP]].
 
* The ''dynamic parts'' are injectet via [[Glossary#P|PHP]].
 
* Direct formating is disliked. Instead we use the [https://en.wikipedia.org/wiki/Cascading_Style_Sheets Cascading Style Sheets] (CSS) from [https://github.com/Gnucash/gnucash-htdocs/blob/master/externals/gnucash.css externals/gnucash.css].
 
* Direct formating is disliked. Instead we use the [https://en.wikipedia.org/wiki/Cascading_Style_Sheets Cascading Style Sheets] (CSS) from [https://github.com/Gnucash/gnucash-htdocs/blob/master/externals/gnucash.css externals/gnucash.css].
 +
* Multiple occurrences of the same text: Assign it once to a variable and use that.
 
* Translatable text is quoted:
 
* Translatable text is quoted:
 
<SyntaxHighlight lang="php"> <?php echo T_("A translatable string");?> </SyntaxHighlight>
 
<SyntaxHighlight lang="php"> <?php echo T_("A translatable string");?> </SyntaxHighlight>
Line 25: Line 26:
 
:;Better: <SyntaxHighlight lang="php"> <?php printf (T_("<span class=\"gnucash\">GnuCash</span> handles internationalized dates and currencies. The application's menus and popups have been translated to %u languages, including Chinese, Danish, French, German, Hungarian, Italian, Japanese, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Turkish, Ukrainian, and British English. Documentation is available in English, French, Portuguese and Spanish."), 21);?></p> </SyntaxHighlight>
 
:;Better: <SyntaxHighlight lang="php"> <?php printf (T_("<span class=\"gnucash\">GnuCash</span> handles internationalized dates and currencies. The application's menus and popups have been translated to %u languages, including Chinese, Danish, French, German, Hungarian, Italian, Japanese, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Turkish, Ukrainian, and British English. Documentation is available in English, French, Portuguese and Spanish."), 21);?></p> </SyntaxHighlight>
 
::Now an additional translation of the program will not break all website translations.
 
::Now an additional translation of the program will not break all website translations.
 
 
:*Try to avoid putting URLs in translatable strings, but  
 
:*Try to avoid putting URLs in translatable strings, but  
 
::* links to the wiki should be separate marked translatatable - there might be a translated page in the wiki.
 
::* links to the wiki should be separate marked translatatable - there might be a translated page in the wiki.
 
::* addresses of images, which contain text should be translatable to link them to localized versions.
 
::* addresses of images, which contain text should be translatable to link them to localized versions.
 +
:*Todo: Try also to avoid Markups in the translatable text.
  
 
:;Fix me: Which methods should we use for the images? This needs documentation in [[Translation]], too.
 
:;Fix me: Which methods should we use for the images? This needs documentation in [[Translation]], too.

Revision as of 15:11, 25 March 2019

Sometimes something should be improved on our website. This page is intended to collect the right procedure.

Introduction

www.gnucash.org is the webserver of the GnuCash project. The sources are public available at GitHub. Building is done by a simple GNU Make.

Branches
Master: https://www.gnucash.org, the official site,
Beta: https://www.gnucash.org/beta/ is intended for developing major changes.

State

{sizing|develdocs}.phtml are currently (2017) hopeless outdated.

Adding or Changing Text

If you add or change text, keep in mind Gnucash and its website are multilingual. If you - like me and most other people - are not firm in all languages, you should ask the translators, to help you keeping the translations up to date.

"Coding" Style

  • The static structure is usually written in HTML.
  • The dynamic parts are injectet via PHP.
  • Direct formating is disliked. Instead we use the Cascading Style Sheets (CSS) from externals/gnucash.css.
  • Multiple occurrences of the same text: Assign it once to a variable and use that.
  • Translatable text is quoted:
 <?php echo T_("A translatable string");?>
  • Separate data (Numbers, URL, ...) from text:
Bad
 <?php echo T_("<span class=\"gnucash\">GnuCash</span> handles internationalized dates and currencies. The application's menus and popups have been translated to 21 languages, including Chinese, Danish, French, German, Hungarian, Italian, Japanese, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Turkish, Ukrainian, and British English. Documentation is available in English, French, Portuguese and Spanish.");?></p>
Better
 <?php printf (T_("<span class=\"gnucash\">GnuCash</span> handles internationalized dates and currencies. The application's menus and popups have been translated to %u languages, including Chinese, Danish, French, German, Hungarian, Italian, Japanese, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Turkish, Ukrainian, and British English. Documentation is available in English, French, Portuguese and Spanish."), 21);?></p>
Now an additional translation of the program will not break all website translations.
  • Try to avoid putting URLs in translatable strings, but
  • links to the wiki should be separate marked translatatable - there might be a translated page in the wiki.
  • addresses of images, which contain text should be translatable to link them to localized versions.
  • Todo: Try also to avoid Markups in the translatable text.
Fix me
Which methods should we use for the images? This needs documentation in Translation, too.

Managing Translations

After you finished editing the english text, you should prepare the translation by

  1. creating a new .pot file
    make pot
  2. msgmerge all existing .po files
    make msgmerge
    and commit the updates
  3. send a short mail to gnucash-devel about "Translators: Website changed ..."
    feel free to give them some clues, what changed like
    "complete new download page" or
    "fixed 42 typos in the english text".
  4. As patches with reworked .po files arrive,
    1. If a language is new, add it in
      makefile
      to languages
    2. If a language is new or bitrotten, add or enable in
      externals/header.phtml
      a line in
      <span id="language">
      
      Note
      A few languages are disabled here, because they are bitrotten.
    3. apply them and
    4. make the .mo files, e.g. with
      make mos
    5. commit
      [[makefile, ]
      externals/header.phtml, ]
      po/LL.po and
      locale/LL/LC_MESSAGES/gnucash-htdocs.mo
      where LL is the language code.

Further details can be found on the Translation page.

Thanks for your time and work!

Testing

After pushing your commit press the W3C-Check button in the lower left corner of the website and fix any claimed errors. Do it for every page, which might by affected by your change. E.g. Changing a modules in /external might affect all pages.

Todo
Idea
Set up apache (or another webserver?)
Add your repository to your apache configuration /etc/apache2/conf.d/
View http://localhost/gnucash/

Used Standards

Html version & encoding
The main page is based on XHTML+RDFa with charset=UTF-8, older parts are still HTML 4.01 and have charset=iso-8859-1. A few Social media snippets would expect HTML 5.
Metadata
Html und Facebooks Opengraph Protocol(og)