bugPSPP - Bugs: bug #35882, Syntax examples in documentation...

 
 

bug #35882: Syntax examples in documentation should be marked as CODE.

Submitted by:  John Darrington <jmd>
Submitted on:  Sun 18 Mar 2012 08:15:37 AM UTC  
 
Category: DocumentationSeverity: 5 - Average
Status: NoneAssigned to: None
Open/Closed: OpenRelease: None
Effort: 0.00

Add a New Comment (Rich MarkupRich Markup):
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Sun 18 Mar 2012 08:15:37 AM UTC, original submission:

Eliana <elianasemail2@gmail.com> reports:

Sorry, the web interface is too hard for me to use.

Add html CODE tags to html versions of the manual. Those are html tags that tell translation engines not to translate the text indicated.

Without those tags, translation engines happily translate commands into the foreign language, totally disregarding their sanctity and rendering the translation very confusing and possibly erroneous in some cases

Adding these tags is not a trivial project, but
requires no knowledge of any foreign language, and I believe would render the online manual a meaningful document for a larger portion of the international community without requiring translating separate manuals for each language.

But it will require proofing of the translated pages to spot any items that needed code tags which have not been generated - translation engines definitely also translate abbreviations and special characters. and add unexpected punctuation marks inappropriately.

Proofing is easier if someone knows the foreign language, but if you know the manual contents, you will see things that look wrong even if you do not know the foreign language.

John Darrington <jmd>
Project Administrator

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by jmd (Submitted the item)
  • -unavailable- added by jmd
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follows 1 latest change.

    Date Changed By Updated Field Previous Value => Replaced By
    Sun 18 Mar 2012 08:15:37 AM UTCjmdCarbon-Copy-=>Added -unavailable-

    Back to the top


    Powered by Savane 3.1-cleanup