D8988: Proofread Symmy docbook

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

D8988: Proofread Symmy docbook

Renato Oliveira Filho
View Revision
lueck created this revision.
lueck added reviewers: elvisangelaccio, Documentation.

REVISION SUMMARY

remove kappname - unused in kf5
use CCBYSA4 - required for new docbooks
use entities dolphin, plasma

General issues to be discussed:

  • symmy is a cli application, but this is installed as handbook
  • no desktop file with a X-DocPath, therefore this handbook is not visible in khelpcenter, only in konqueror with help:/symmy, but hard to find by joe user
  • man symmy -> No manual entry for symmy

Possible solutions

  • convert handbook to manpage - will not be on docs.kde.org
  • add a basic manpage in docbook format with link to the handbook install this handbook and a desktop file with X-DocPath,Exec,Terminal,Nodisplay entries similar as kdesrc-build

TEST PLAN

checkXML5 index.docbook


REPOSITORY
R893 Symmy


AFFECTED FILES
doc/index.docbook

To: lueck, elvisangelaccio, Documentation
Reply | Threaded
Open this post in threaded view
|

D8988: Proofread Symmy docbook

Renato Oliveira Filho
View Revision
ltoscano added a comment.

Probably better to go with a man page, if @elvisangelaccio agrees.


REPOSITORY
R893 Symmy


To: lueck, elvisangelaccio, Documentation
Cc: ltoscano
Reply | Threaded
Open this post in threaded view
|

D8988: Proofread Symmy docbook

Renato Oliveira Filho
In reply to this post by Renato Oliveira Filho
View Revision
elvisangelaccio added a comment.

We probably need a manpage anyway, since this is a cli app. If we go with manpage only, would it show up in khelpcenter?


REPOSITORY
R893 Symmy


To: lueck, elvisangelaccio, Documentation
Cc: ltoscano
Reply | Threaded
Open this post in threaded view
|

D8988: Proofread Symmy docbook

Renato Oliveira Filho
In reply to this post by Renato Oliveira Filho
View Revision
ltoscano added a comment.

Yes, because khelpcenter supports also man and info pages.


REPOSITORY
R893 Symmy


To: lueck, elvisangelaccio, Documentation
Cc: ltoscano
Reply | Threaded
Open this post in threaded view
|

D8988: Proofread Symmy docbook

Renato Oliveira Filho
In reply to this post by Renato Oliveira Filho
View Revision
lueck abandoned this revision.
lueck added a comment.


REPOSITORY
R893 Symmy


To: lueck, elvisangelaccio, Documentation
Cc: ltoscano