[kde-doc-english] Review Request 116038: replace old included sections with links to fundamentals

T.C. Hollingsworth tchollingsworth at gmail.com
Tue Sep 16 01:33:48 UTC 2014



> On Feb. 25, 2014, 11:38 a.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.

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.


- T.C.


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


On Feb. 25, 2014, 1: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, 1: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
> 
>

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


More information about the kde-doc-english mailing list