[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-doc-english
Subject: Re: [kde-doc-english] Review Request 116038: replace old included sections with links to fundamental
From: "Luigi Toscano" <luigi.toscano () tiscali ! it>
Date: 2014-09-16 18:20:25
Message-ID: 20140916182025.22585.59676 () probe ! kde ! org
[Download RAW message or body]
--===============4731699172996301400==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
> On Feb. 25, 2014, 12:38 p.m., Luigi Toscano wrote:
> > I'm not sure if it enough: what if fundamentals is not installed? kde-runtime as \
> > we knows is going away. Maybe we should rethink how it works.
>
> T.C. Hollingsworth wrote:
> So I guess these days fundamentals is shipped along with KHelpCenter.
>
> Even without this patch, we're already linking to Fundamentals in a lot of places, \
> see for instance http://docs.kde.org/stable/en/applications/kate/settings-menu.html \
> (and various other Settings menus around the project do the same thing).
> Presumably an application that uses kdoctools for documentation would need to \
> require KHelpCenter so its documentation can actually be seen, so that should be \
> Good Enough, no? If not, we need to either revisit how we provide documentation \
> for common dialogs like Custom Shortcuts or revisit where to stick Fundamentals. \
> ;-)
> As for this patch in particular, I believe Burkhard's rationale for wanting this \
> done was that keeping this information in a standard DocBook is easier to update \
> and translate, unlike the entities which aren't presently converted to pots and \
> have to be translated manually. So if it's okay to link to Fundamentals here it \
> should be a nice improvement.
You could use another kio client for the documentation; for example, a possible \
integration with KDevelop. The patch introduces a runtime dependency on an upper \
level components, which is something that does not work if you don't have it. \
Moreover, the contents of Fundamentals talks about both components and behaviors \
which are provided by different sources: Qt, various frameworks or directly Plasma. \
That's why I'm asking about rethinking and splitting fundamentals. Some sections \
should be moved down (some even here in KDocTools). But I really need help from you \
who wrote it for this.
- Luigi
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/116038/#review50799
-----------------------------------------------------------
On Feb. 25, 2014, 2:16 a.m., T.C. Hollingsworth wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/116038/
> -----------------------------------------------------------
>
> (Updated Feb. 25, 2014, 2:16 a.m.)
>
>
> Review request for Documentation, Luigi Toscano and Burkhard Lück.
>
>
> Repository: kdoctools
>
>
> Description
> -------
>
> replace the old &install.*.documentation; and &help.menu.documentation; content \
> with links to Fundamentals.
> One other TODO I noticed while messing around in there. I know Burkhard's been \
> wanting this for a long time. ;-)
>
> Diffs
> -----
>
> src/customization/en/entities/help-menu.docbook 1c4da80
> src/customization/en/entities/install-compile.docbook 855b0de
> src/customization/en/entities/install-intro.docbook 3f6f5ed
>
> Diff: https://git.reviewboard.kde.org/r/116038/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> T.C. Hollingsworth
>
>
--===============4731699172996301400==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 8bit
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;"> \
<tr> <td>
This is an automatically generated e-mail. To reply, visit:
<a href="https://git.reviewboard.kde.org/r/116038/">https://git.reviewboard.kde.org/r/116038/</a>
</td>
</tr>
</table>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <p style="margin-top: 0;">On febbraio 25th, 2014, 12:38 p.m. CET, <b>Luigi \
Toscano</b> wrote:</p> <blockquote style="margin-left: 1em; border-left: 2px solid \
#d0d0d0; padding-left: 10px;"> <pre style="white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">I'm not sure if it enough: what if fundamentals is not installed? \
kde-runtime as we knows is going away. Maybe we should rethink how it works.</pre> \
</blockquote>
<p>On settembre 16th, 2014, 3:33 a.m. CEST, <b>T.C. Hollingsworth</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">So I \
guess these days fundamentals is shipped along with KHelpCenter.</p> <p \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">Even without this patch, we're already linking to Fundamentals in a lot of \
places, see for instance \
http://docs.kde.org/stable/en/applications/kate/settings-menu.html (and various other \
Settings menus around the project do the same thing).</p> <p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">Presumably an application that uses kdoctools for documentation would need \
to require KHelpCenter so its documentation can actually be seen, so that should be \
Good Enough, no? If not, we need to either revisit how we provide documentation for \
common dialogs like Custom Shortcuts or revisit where to stick Fundamentals. ;-)</p> \
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">As for this patch in particular, I believe Burkhard's \
rationale for wanting this done was that keeping this information in a standard \
DocBook is easier to update and translate, unlike the entities which aren't presently \
converted to pots and have to be translated manually. So if it's okay to link to \
Fundamentals here it should be a nice improvement.</p></pre> </blockquote>
</blockquote>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">You \
could use another kio client for the documentation; for example, a possible \
integration with KDevelop. The patch introduces a runtime dependency on an upper \
level components, which is something that does not work if you don't have it.<br \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
normal;" /> Moreover, the contents of Fundamentals talks about both components and \
behaviors which are provided by different sources: Qt, various frameworks or directly \
Plasma. That's why I'm asking about rethinking and splitting fundamentals. Some \
sections should be moved down (some even here in KDocTools). But I really need help \
from you who wrote it for this.</p></pre> <br />
<p>- Luigi</p>
<br />
<p>On febbraio 25th, 2014, 2:16 a.m. CET, T.C. Hollingsworth wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;"> <tr>
<td>
<div>Review request for Documentation, Luigi Toscano and Burkhard Lück.</div>
<div>By T.C. Hollingsworth.</div>
<p style="color: grey;"><i>Updated Feb. 25, 2014, 2:16 a.m.</i></p>
<div style="margin-top: 1.5em;">
<b style="color: #575012; font-size: 10pt;">Repository: </b>
kdoctools
</div>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">replace the old &install.*.documentation; and \
&help.menu.documentation; content with links to Fundamentals.
One other TODO I noticed while messing around in there. I know Burkhard's been \
wanting this for a long time. ;-)</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>src/customization/en/entities/help-menu.docbook <span style="color: \
grey">(1c4da80)</span></li>
<li>src/customization/en/entities/install-compile.docbook <span style="color: \
grey">(855b0de)</span></li>
<li>src/customization/en/entities/install-intro.docbook <span style="color: \
grey">(3f6f5ed)</span></li>
</ul>
<p><a href="https://git.reviewboard.kde.org/r/116038/diff/" style="margin-left: \
3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>
--===============4731699172996301400==--
_______________________________________________
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic