Scribd Logo
Upload

Welcome to Scribd!

  • Gtranslator Online Help

    Uploaded by

    dd6666
    10 views8 pages
    This document discusses the development of online help for the Gtranslator program. It describes moving the help from an old DocBook format to a new browser-based help using Mallard markup and the Yelp viewer. The goals of the help are to explain concepts and provide instructions for translation tasks at different user levels. Topics covered include concepts, tasks, references and FAQs. The author discusses challenges in learning Mallard and determining topic granularity, and finds navigation and HTML creation easy. Next steps are review, inclusion in the next program release, and future revisions for new releases.

    Original Description:

    Working on Gtranslator Help (slideshow presentation)

    Copyright

    © © All Rights Reserved

    Available Formats

    ODP, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    This document discusses the development of online help for the Gtranslator program. It describes moving the help from an old DocBook format to a new browser-based help using Mallard markup and the Yelp viewer. The goals of the help are to explain concepts and provide instructions for translation tasks at different user levels. Topics covered include concepts, tasks, references and FAQs. The author discusses challenges in learning Mallard and determining topic granularity, and finds navigation and HTML creation easy. Next steps are review, inclusion in the next program release, and future revisions for new releases.

    Copyright:

    © All Rights Reserved
    Download as ODP, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as odp, pdf, or txt
    10 views8 pages

    Gtranslator Online Help

    Uploaded by

    dd6666
    This document discusses the development of online help for the Gtranslator program. It describes moving the help from an old DocBook format to a new browser-based help using Mallard markup and the Yelp viewer. The goals of the help are to explain concepts and provide instructions for translation tasks at different user levels. Topics covered include concepts, tasks, references and FAQs. The author discusses challenges in learning Mallard and determining topic granularity, and finds navigation and HTML creation easy. Next steps are review, inclusion in the next program release, and future revisions for new releases.

    Copyright:

    © All Rights Reserved
    Download as ODP, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as odp, pdf, or txt
    of 8

    Gtranslator Online Help

    Radina Matic

    Developing Online Help X448 Summer 2012


    UC Berkeley Extension

    What we had before

    Old version of Gtranslator


    Help in DocBook format
    Developing Online Help X448 Summer 2012
    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    What we have now

    New Gtranslator Help in browser


    New Gtranslator Help in Yelp viewer
    Developing Online Help X448 Summer 2012
    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    Gtranslator Online Help


    Subject
    User documentation and online help file for the program Gtranslator.
    Audience
    Primary users: members of translation teams in the GNOME community
    Secondary user: anybody who needs to edit PO files for localization
    Purpose and Goals
    explain basic localization concepts (novice users)
    provide instructions for the specific translating tasks (novice users)
    provide reference for the advanced program features (experienced users)
    answer frequently asked questions about the program usage (all users)
    decrease the number of the repeated questions asked on the community
    mailing lists (GNOME community)
    contribute to the transition of the GNOME documentation from the old formats
    (DocBook) to the new, topic-based help in Mallard format(GNOME
    community)

    Types of topics
    Specific topics include concepts, tasks, reference and FAQs.
    Developing Online Help X448 Summer 2012
    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    Mallard
    Mallard is a XML markup language, specifically designed and promoted by the GNOME
    community, for an easy creation of the topic-oriented user documentation and help files.

    Developing Online Help X448 Summer 2012


    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    Experience of writing Gtranslator Help


    Challenges:
    Learning Mallard markup
    Granularity (how many conceptual topics to include?)

    What was easy:


    Navigation
    Creation of HTML

    Developing Online Help X448 Summer 2012


    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    Whats next?

    Ready for review


    Ready to be
    included in the
    next release of
    the program
    Will need revisions
    and updates for
    future releases

    Developing Online Help X448 Summer 2012


    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    Summary
    I am happy with:

    Overall result

    Concept-task balance

    Good reviews so far

    Still needs work:

    FAQ ( community input)

    Index, layering, HTML search (Mallard limitations)

    Developing Online Help X448 Summer 2012


    UC Berkeley Extension

    Gtranslator Online Help Radina Matic

    You might also like