[kde-doc-english] Review Request 109401: Better usage of &kappname; (aka &kde-sc; ) and &kde; in Fundamentals, and related fixes

[T.C. Hollingsworth]

> On March 11, 2013, 4:06 a.m., T.C. Hollingsworth wrote:
> > LGTM for the most part.
> > 
> > I really don't think we should be using &kappname; at all in Fundamentals TBH.  I think using &kde-sc; explicitly is less confusing.  But this is my fault, so I can fix it later. ;-)
> 
> Luigi Toscano wrote:
>     I tried to apply only the minimum number of changes, following the style used in other places. I have to say that I had to look at the source docbook to understand the meaning of &kappname; in this context, so I agree that it can be replaced. My proposal is: I will apply the revised patch, and then I would replace all the occurencies of &kappname; with &kde-sc; in one single commit, in order to separate a "meaningful" commit from a simple search-and-replace. Would it be acceptable?

Yeah, it's definitely out of scope for this patch which is why I said I'd fix it later. :-)  Feel free to go ahead and do it yourself though.


- T.C.


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/109401/#review28930
-----------------------------------------------------------


On March 11, 2013, 11:36 p.m., Luigi Toscano wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/109401/
> -----------------------------------------------------------
> 
> (Updated March 11, 2013, 11:36 p.m.)
> 
> 
> Review request for Documentation.
> 
> 
> Description
> -------
> 
> &kappname; (which here is the same entity as "&kde-sc;") has been used sometimes instead of &kde; because it refers to the SC (install.docbook). 
> 
> A name has been added to &kde; (like "&kde; applications/software") as the content is general for any KDE applications, and for sure it is not about the KDE project. To be honest, when cmake is mentioned, even "&kde; software" is a bit restrictive, as for example Oxygen icons use cmake too, but I would say it is more a details for developers in this document.
> Similarly, &kappname; has been replaced with &kde; when it was close to such names ("applications"), as the content is valid for any KDE Platform-based application.
> 
> 
> A bit different change when the content of About KDE is described, as it clearly state the version of KDE Development Platform in addition to the program version, and not a generic KDE version.
> 
> 
> Diffs
> -----
> 
>   doc/fundamentals/ui.docbook eb962df 
>   doc/fundamentals/tasks.docbook 71c6288 
>   doc/fundamentals/config.docbook e750dfe 
>   doc/fundamentals/install.docbook 71db09c 
> 
> Diff: http://git.reviewboard.kde.org/r/109401/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Luigi Toscano
> 
>

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