Review of Kwave documentation
ClosedPublic
Actions

Authored by Abella on Jun 18 2018, 1:03 PM.

Details

Reviewers

Commits

R347:372f2e0f0046: Review of Kwave documentation

Summary

Common changes:

<guimenu>Windows</guimenu> -> <guimenu>Window</guimenu>
mickey mouse efect -> Mickey Mouse efect (proper noun)

Entities of the KDE project:
&Left;, &Right;, &Ctrl;, &PgUp;, etc.

Improves:
title: Zooming in and out ('listitem' reorder -- without button images?)
title: Scrolling left and right ('listitem' reorder and adding 'goto position' -- without button images?)
title: Selecting sample ('listitem' reorder and fixes)
using a dot as decimal separator. -> <emphasis>using a dot as decimal separator</emphasis>.
Opens a window in which -> Opens a dialog window in which

Style:
view_scroll_right;</command>. -> view_scroll_right;</command>().
select_gui_type(mode) -> highlight (all 's' section afected)
Appendix A. File Info -> final points
OK and Cancel buttons -> 'guibutton' tag is enough
tab mode -> Tab mode (unify the style)

Missing screenshot

kwave-plugin-export_k3b.png

Diff Detail

Repository

R347 KWave

Lint

Lint Skipped

Unit

Unit Tests Skipped

Abella created this revision.Jun 18 2018, 1:03 PM

Restricted Application added a project: Documentation. · View Herald TranscriptJun 18 2018, 1:03 PM

Restricted Application added a subscriber: kde-doc-english. · View Herald Transcript

Abella requested review of this revision.Jun 18 2018, 1:03 PM

Abella added a reviewer: the.Jun 18 2018, 1:12 PM

General suggestion about the review:

please change the commit message to be a summary of the content ("Review and fixes of kwave documentation"), for example
the commit message should not repeat all the change, but should summarize them. For example, common changes from 1 to 20 are "use of entities when defined", and so on.

Screenshot added

Abella retitled this revision from I'm finish my translation review to Review of Kwave documentation.Jun 18 2018, 1:23 PM

Abella edited the summary of this revision. (Show Details)

Abella edited the summary of this revision. (Show Details)Jun 18 2018, 1:25 PM

Your steps 1. ... 10. look ok to me -> accepted.

what are those final points good for? There is a simple list with some tokens / abbrev., not complete sentences. IMHO that change is wrong. Additionally: all these texts are created by a tool (extracted from source code) and will be overwritten the next time I run that tool. This means that these texts have to be in sync with the source code (which also does not support entities).

ok, accepted

I am not sure, isn't &Tab; a predefined entity for the tabulator key? Then it would be mis-used in that case.

How did you take the screenshot? Please do not manually create screenshots! There is a Kwave macro file (scripts/screenshots.kwave) that should be used to create all screenshots, in a unified way, showing the same content for all languages.

BTW: This is a lot of stuff to review and comment within one single pass, it would be easier if things had been split into several steps.

This revision now requires changes to proceed.Jun 19 2018, 5:04 AM

Abella edited the summary of this revision. (Show Details)Jun 19 2018, 5:06 AM

In D13589#279781, @the wrote:

Your steps 1. ... 10. look ok to me -> accepted.

what are those final points good for? There is a simple list with some tokens / abbrev., not complete sentences. IMHO that change is wrong. Additionally: all these texts are created by a tool (extracted from source code) and will be overwritten the next time I run that tool. This means that these texts have to be in sync with the source code (which also does not support entities).

OK!

I am not sure, isn't &Tab; a predefined entity for the tabulator key? Then it would be mis-used in that case.

I change all to Tab mode, sorry

How did you take the screenshot? Please do not manually create screenshots! There is a Kwave macro file (scripts/screenshots.kwave) that should be used to create all screenshots, in a unified way, showing the same content for all languages.

No working, I'll try again.

BTW: This is a lot of stuff to review and comment within one single pass, it would be easier if things had been split into several steps.

Next time, yes. Do I need rewrite this patch?

Erase last section (autogenerated from source)

thanks a lot for your contribution!
From my point of view, this is all ok now.

Regarding the use of entities like "&GUI;" or "&CD;", we could do an additional pass, and if you think that there is much benefit from using them, I could extend the tool that extracts them from the source code to do some search&replace and use the tags.

Just a note to the change in lines 6252..6263: this also needs a change in the source code of the "pitch" plugin, which has a similar text (I will do that for you).

If you need some assistance in creating the screenshots, please write me per PM!

This revision is now accepted and ready to land.Jun 21 2018, 5:53 AM

In D13589#280985, @the wrote:

thanks a lot for your contribution!
From my point of view, this is all ok now.

Your work ;-)

Regarding the use of entities like "&GUI;" or "&CD;", we could do an additional pass, and if you think that there is much benefit from using them, I could extend the tool that extracts them from the source code to do some search&replace and use the tags.

Just a note to the change in lines 6252..6263: this also needs a change in the source code of the "pitch" plugin, which has a similar text (I will do that for you).

Good improve!

If you need some assistance in creating the screenshots, please write me per PM!

Today I updated to Kwave 18.04.1 from Kubuntu Staging KDE Applications, I prove it again and report in PM.

Ship it!

the closed this revision.Jul 22 2018, 8:00 PM

Revision Contents
Changeset List

			Path	Packages
M			doc/en/index.docbook (370 lines)

Diff 36337

View Options

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	36274		Jun 18 2018, 12:59 PM	★	★
Diff 2	36337		Jun 19 2018, 2:01 PM	★	★

Review of Kwave documentationClosedPublicActions