[comment] tdf#98110: fix to <item ..> handling

[Andras Timar]

Hi Akash,

I ran the script on actual help source files. What problem did you try
to solve? If it was an artificial, made-up problem, then it's possible
that you solved it. But the net result of the patch was a regression.
%PRODUCTNAME strings from source has to be replaced with {{ProductName}}
in wiki text, otherwise the replacement to LibreOffice will not be made.

Let's see the original report: CommandCtrl on pages.
History of Draw/Shortcut Keys for Drawing Objects shows, that the last
update of this page was in 2011.
https://help.libreoffice.org/WikiAction/history/Draw/Shortcut_Keys_for_Drawing_Objects

Example:
#Press {{KeyCode|CommandCtrl+F6}} to enter the document.

But in my recently generated wiki text file I see (with or without your
patch):

#Press
{{System|default={{KeyCode|Ctrl}}|mac={{KeyCode|Command}}}}{{KeyCode|+F6}}
to enter the document.

So, the bug was fixed earlier, but wiki was not updated. Can you please
repeat my experiment on actual help files, with and without your patch,
and check, if you get the same as me?

Regards,
Andras

On 06/17/2016 01:04 AM, Akash Deshpande wrote:
> Hi Andras,
> 
> Thank you for the review.
> 
> Actually, as I noted in my comments, I made a custom input file and checked
> to make sure the output was as described by Dennis in the ticket as
> requirement:  https://bugs.documentfoundation.org/show_bug.cgi?id=98110#c7
> 
> In a related/parent ticket, Dennis mentioned there may be two parts
> (easyHacks): https://bugs.documentfoundation.org/show_bug.cgi?id=62292#c5
> 
> So I wasn't expecting this to fix the wiki pages by itself.
> 
> Also, sorry for a silly question: does 'regression' mean adverse impact or
> side effect?  I will take a look in the next few days for sure.
> 
> If this explanation is not good and if you or Dennis have other ideas on
> how to tackle this task, please share some high level details.  I would
> love to work on it.
> 
> I am studying other aspects of the project (python related) and also
> learning git.  Norbert and others helped me a lot with my first submission
> (on IRC) and I feel like I have forgotten some of the commands already :(
> 
> Thank you all again and I am looking forward to addressing this issue or
> looking for other tickets in the summer.  Feel free to suggest anything
> python related (I am looking at 'making unittests more pythonic' etc.)
> 
> Akash
> 
> On Thu, Jun 16, 2016 at 3:57 AM, Andras Timar (via Code Review) <
> gerrit at gerrit.libreoffice.org> wrote:
> 
>> Andras Timar has posted comments on this change.
>>
>> Change subject: tdf#98110: fix to <item ..> handling
>> ......................................................................
>>
>>
>> Patch Set 3: Code-Review-1
>>
>> I generated help wiki pages with ./help-to-wiki.py -n command with and
>> without the patch and I compared the results.
>>
>> I did not see improvements, but I saw a regression: {{ProductName}} turned
>> into %PRODUCTNAME in 219 occasions.
>>
>> --
>> To view, visit https://gerrit.libreoffice.org/25000
>> To unsubscribe, visit https://gerrit.libreoffice.org/settings
>>
>> Gerrit-MessageType: comment
>> Gerrit-Change-Id: I841bf638d9975d78ac0ffeba40697bbc614cde4a
>> Gerrit-PatchSet: 3
>> Gerrit-Project: help
>> Gerrit-Branch: master
>> Gerrit-Owner: Akash Deshpande <fastakash at gmail.com>
>> Gerrit-Reviewer: Andras Timar <andras.timar at collabora.com>
>> Gerrit-Reviewer: dennisroczek <dennisroczek at libreoffice.org>
>> Gerrit-Reviewer: jan iversen <jani at documentfoundation.org>
>> Gerrit-HasComments: No
>>
> 
> 
> 
-- 
Andras Timar
Product Development Manager
Collabora Productivity Ltd.
https://collaboraoffice.com/