Bug 95496 - New function descriptions in help not same as existing ones
Summary: New function descriptions in help not same as existing ones
Status: RESOLVED WORKSFORME
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
5.1.0.0.alpha1
Hardware: Other All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: HelpGaps-NewFeatures
  Show dependency treegraph
 
Reported: 2015-11-01 15:36 UTC by Martin Srebotnjak
Modified: 2015-11-11 14:17 UTC (History)
2 users (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Srebotnjak 2015-11-01 15:36:16 UTC
Pre-5.1 help descriptions for Calc functions in /helpcontent2/source/text/scalc/01.po had just function name as the main "title" string, but newly added (for 5.1) function descriptions in English have the form "FUNTION_NAME function". This should probably made just "FUNCTION_NAME".
Examples:
pre-5.1: hd_id90361032228870
5.1-on: 

Also, the string following the help index (bookmark_value) entry, a string like:
<variable id=\"aggregate_head\"><link href=\"text/scalc/01/func_aggregate.xhp\">AGGREGATE</link></variable> function"
now contains the " function" substring at the end (this example is hd_id3154073, but it appears in all newly added help descriptions, probably with the help-editing-extension, so this is a systematic change, if needed at all), previous variable strings for functions in this file looked like this:
<variable id=\"weeknumadd\"><link href=\"text/scalc/01/func_weeknumadd.xhp\">WEEKNUM_ADD</link></variable>
(this is hd_id3166443).

These changes might introduced unwanted imbalance between the old and new function descriptions so I suggest we stay with the old style function descriptions (without " function" string in both these strings).
Comment 1 Yousuf Philips (jay) (retired) 2015-11-11 13:23:43 UTC
Lera added the page in http://cgit.freedesktop.org/libreoffice/help/commit/?id=fa9b83defffcd6a10aacf8f97106cd17054855cc.
Comment 2 tagezi 2015-11-11 14:17:58 UTC
(In reply to miles from comment #0)
> Pre-5.1 help descriptions for Calc functions in
> /helpcontent2/source/text/scalc/01.po had just function name as the main
> "title" string, but newly added (for 5.1) function descriptions in English
> have the form "FUNTION_NAME function". This should probably made just
> "FUNCTION_NAME".

> Also, the string following the help index (bookmark_value) entry, a string
> like:
> <variable id=\"aggregate_head\"><link
> href=\"text/scalc/01/func_aggregate.xhp\">AGGREGATE</link></variable>
> function"
> now contains the " function" substring at the end (this example is
> hd_id3154073, but it appears in all newly added help descriptions, probably
> with the help-editing-extension, so this is a systematic change, if needed
> at all), previous variable strings for functions in this file looked like
> this:
> <variable id=\"weeknumadd\"><link
> href=\"text/scalc/01/func_weeknumadd.xhp\">WEEKNUM_ADD</link></variable>
> (this is hd_id3166443).
> 
> These changes might introduced unwanted imbalance between the old and new
> function descriptions so I suggest we stay with the old style function
> descriptions (without " function" string in both these strings).

all description of functions needs to be separate in an individual file. It's related with:
some bugs which the help has now;
old function descriptions are not complete.
A problem spring up to distinguish between pages of tutorials and the descriptions of functions in the online help.
For example: SUM, COUNT, AVERAGE, TIME, TEXT etc.
Also, there are standards that claim that the title of a document , a chapter or a section must clearly and briefly describe what will be read below.
So we have to change a page name of a function to the form "FUNTION_NAME function".
Unfortunately (although fortunately), we have about 486 functions. And this work can not be completed in a short time.
In addition, the quick separation of pages into individual files, creates a huge burden on the localization team.