[kde-doc-english] Review Request 127949: Update/proofread Kate handbook

[Burkhard Lück]

> On Mai 26, 2016, 3:41 nachm., Christoph Cullmann wrote:
> > Hi, ok, arrived here now.
> > 
> > Feel free to commit this.
> > 
> > I have commited one plugin doc change for the revived xmlcheck plugin:
> > 
> > https://phabricator.kde.org/rKATE8721cd331f4c
> > 
> > If this messes something up for you, revert it and apply your stuff and ping me to reapply that afterwards.
> > Thanks.
> > 
> > Sorry that I had no time to look at stuff here since long :/

Your commit with the xmlcheck plugin (much appreciated by me, thanks) introduced an additional para + one varlistentry:

1)
<varlistentry>
<term><guilabel>File Type</guilabel></term>
<listitem><para>Select the file type(s) you want the snippet repository to apply
to.  It is set to <quote>*</quote> by default, so the repository applies to all files.  You
can change it to something like <userinput>C++</userinput> for instance, or select
from a list by hitting the <guibutton>Edit</guibutton>.  You can specify more
than one file type by separating them with <userinput>;</userinput>.</para></listitem>
</varlistentry>

Afaik this is not correct because you have to press &Shift; to specify more than one file; not to type ";"
and this is already in line 1434-1441 in the patch for plugins.docbook, 
so I would remove it.

2)
<para>In <guilabel>Snippet Content</guilabel> you can specify variables with
<userinput>${<replaceable>name</replaceable>}</userinput> or
<userinput>%{<replaceable>name</replaceable>}</userinput>.  These can be filled
by QtScript or when the snippet is used.  There is a special variable -
${cursor} or %{cursor} - which automatically sets the cursor to its first
occurrence.</para>

This is already in lines 1471 - 1492 in the patch for plugins.docbook, right?


- Burkhard


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/127949/#review95850
-----------------------------------------------------------


On Mai 19, 2016, 2:21 nachm., Burkhard Lück wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/127949/
> -----------------------------------------------------------
> 
> (Updated Mai 19, 2016, 2:21 nachm.)
> 
> 
> Review request for Documentation and Kate.
> 
> 
> Repository: kate
> 
> 
> Description
> -------
> 
> kate is by kde, not for kde
> move all plugin related info to plugin.docbook
> remove all obsolete infos for kate plugins
> add a lot of FIXME's for missing content, will be updated in next RR
> objective of this RR is to get all obsolete/wrong info stripped off from the docbook
> feel free to add comments/reviews to my FIXME's, but even without them the updated docbooks are better for our users
> 
> 
> Diffs
> -----
> 
>   doc/kate/configuring.docbook 5d11629 
>   doc/kate/fundamentals.docbook 3f6bcc2 
>   doc/kate/gdb-settings.png 0c92bb8 
>   doc/kate/index.docbook 368cf63 
>   doc/kate/menus.docbook 717bddd 
>   doc/kate/plugins.docbook d24c3d0 
>   doc/kate/snippets-form.png 66875c1 
>   doc/kate/snippets-panel.png 281948c 
>   doc/kate/snippets-usage.png 7851e05 
> 
> Diff: https://git.reviewboard.kde.org/r/127949/diff/
> 
> 
> Testing
> -------
> 
> passes checkXML5
> 
> 
> Thanks,
> 
> Burkhard Lück
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-doc-english/attachments/20160526/fc668b85/attachment.html>