D11592: Update kate docbooks to 18.04
This revision was automatically updated to reflect the committed changes. Closed by commit R40:0f06e1172f7d: Update kate docbooks to 18.04 (authored by lueck). CHANGED PRIOR TO COMMIT https://phabricator.kde.org/D11592?vs=30551&id=30587#toc REPOSITORY R40 Kate CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D11592?vs=30551&id=30587 REVISION DETAIL https://phabricator.kde.org/D11592 AFFECTED FILES doc/kate/fundamentals.docbook doc/kate/index.docbook doc/kate/plugins.docbook To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
kossebau accepted this revision. kossebau added a comment. Besides the unneeded "set" reads fine to me. INLINE COMMENTS > kossebau wrote in fundamentals.docbook:187 > "exec command" -> "command line set for the Exec 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. 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. REPOSITORY R40 Kate REVISION DETAIL https://phabricator.kde.org/D11592 To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
lueck marked 3 inline comments as done. REPOSITORY R40 Kate REVISION DETAIL https://phabricator.kde.org/D11592 To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
lueck updated this revision to Diff 30551. lueck added a comment. improve wording requested by Friedrich, thanks for the explanation REPOSITORY R40 Kate CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D11592?vs=30308&id=30551 REVISION DETAIL https://phabricator.kde.org/D11592 AFFECTED FILES doc/kate/fundamentals.docbook doc/kate/index.docbook doc/kate/plugins.docbook To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
kossebau added inline comments. INLINE COMMENTS > fundamentals.docbook:187 > +applications having in general multiple desktop files. Thus each desktop > +file can put its own name into the exec command. > + "exec command" -> "command line set for the Exec 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. > plugins.docbook:680 > + > +Lock or unlock the preview of the current document > + 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, REVISION DETAIL https://phabricator.kde.org/D11592 To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
lueck marked 3 inline comments as done. REVISION DETAIL https://phabricator.kde.org/D11592 To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
lueck updated this revision to Diff 30308. lueck added a comment. fix isues spotted by Yuri and Friedrich, thanks CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D11592?vs=30269&id=30308 REVISION DETAIL https://phabricator.kde.org/D11592 AFFECTED FILES doc/kate/fundamentals.docbook doc/kate/index.docbook doc/kate/plugins.docbook To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
kossebau added inline comments. INLINE COMMENTS > fundamentals.docbook:64 > > +To change the directory for temorary files, which defaults to > /tmp > +set the TMPDIR environment variable before starting &kate;, > ⪚ typo: temporary > plugins.docbook:635 > + > +Some available KParts > + 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. > plugins.docbook:689 > + > +A dropdown menu with actions from the KPart plugin > + typo: KParts REPOSITORY R40 Kate REVISION DETAIL https://phabricator.kde.org/D11592 To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
yurchor accepted this revision as: yurchor. yurchor added inline comments. This revision is now accepted and ready to land. INLINE COMMENTS > plugins.docbook:630 > +To change the preferred plugin open the File > Associations > +modul in the &systemsettings; and edit the Services Preference > Order > +on the Embedding tab. modul -> module REPOSITORY R40 Kate REVISION DETAIL https://phabricator.kde.org/D11592 To: lueck, #kate, kossebau, #documentation, yurchor Cc: yurchor, kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann
D11592: Update kate docbooks to 18.04
lueck created this revision. lueck added reviewers: Kate, kossebau, Documentation. Restricted Application added a project: Kate. Restricted Application added a subscriber: kde-doc-english. lueck requested review of this revision. REVISION 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 REPOSITORY R40 Kate REVISION DETAIL https://phabricator.kde.org/D11592 AFFECTED FILES doc/kate/fundamentals.docbook doc/kate/index.docbook doc/kate/plugins.docbook To: lueck, #kate, kossebau, #documentation Cc: kde-doc-english, michaelh, kevinapavew, ngraham, demsking, cullmann, sars, dhaumann