Update kate docbooks to 18.04
ClosedPublic

Authored by lueck on Mar 23 2018, 6:05 AM.

Details

Summary

proofread
bump date + releaseinfo
add info how to use a non default tmp folder
expand explanation/usecase for option --desktopfile
add document preview plugin, infos from https://frinring.wordpress.com/

Test Plan

checkXML5 index.docbook

Diff Detail

Repository
R40 Kate
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
lueck created this revision.Mar 23 2018, 6:05 AM
Restricted Application added a project: Kate. · View Herald TranscriptMar 23 2018, 6:05 AM
Restricted Application added a subscriber: kde-doc-english. · View Herald Transcript
lueck requested review of this revision.Mar 23 2018, 6:05 AM
yurchor accepted this revision as: yurchor.Mar 23 2018, 6:43 AM
yurchor added a subscriber: yurchor.
yurchor added inline comments.
doc/kate/plugins.docbook
630

modul -> module

This revision is now accepted and ready to land.Mar 23 2018, 6:43 AM
kossebau added inline comments.Mar 23 2018, 12:32 PM
doc/kate/fundamentals.docbook
64

typo: temporary

doc/kate/plugins.docbook
635

For consistent and precise lingo this would be "KParts plugins" - "KParts" is the name of the framework, and a "KParts" plugin is a plugin for that framework.

In developer and user talk usually "kparts" is used as short form of "KParts plugins" given that it's close to "parts" and what also might have been the root of the framework name. But its not the formal name of such plugins by the framework documentation, so let's better be formal here and also consistent with rest of text.

689

typo: KParts

lueck updated this revision to Diff 30308.Mar 23 2018, 12:53 PM

fix isues spotted by Yuri and Friedrich, thanks

lueck marked 3 inline comments as done.Mar 25 2018, 12:48 PM
kossebau added inline comments.Mar 25 2018, 6:10 PM
doc/kate/fundamentals.docbook
187

"exec command" -> "command line set for the <sometag>Exec</sometag> entry" or similar might be less confusing (and more correct for the casing of Exec). No overview of tags which can be used, by some semantic highlighting might be good to do.

doc/kate/plugins.docbook
680

No idea what a good description could be. But this button is used to lock the preview to a given file/document. The preview can still update if the document is changed (control of that is by the other buttons). Instead this toggle button if toggled ensures that if switching the focus to the view of another document in the same Kate window, the preview will not follow to that document, but keep previewing the old document. If switching to another view of the same document, this will not have any effect independent of this button state, as the preview operates per document, not view.

Given that Kate supports multiple views per document, description here might be slightly hard to correctly do. Not sure if that concept of multiple view of the same document is explicitly respected throughout this manual and if which terms/lingo is used then.

But the currently proposed text might be misunderstandable I fear,

lueck updated this revision to Diff 30551.Mar 25 2018, 7:36 PM

improve wording requested by Friedrich, thanks for the explanation

lueck marked 3 inline comments as done.Mar 25 2018, 7:37 PM
kossebau accepted this revision.Mar 25 2018, 9:15 PM

Besides the unneeded "set" reads fine to me.

doc/kate/fundamentals.docbook
187

Not sure why I had "set" in my proposal, perhaps fit the previous text as verb. But "can put its own command line set" sonuds strange to me, it was not intended like this :)
So "set" with the given text.

This revision was automatically updated to reflect the committed changes.