Proofread Symmy docbook
AbandonedPublic

Authored by lueck on Nov 24 2017, 3:09 PM.

Details

Reviewers
elvisangelaccio
Group Reviewers
Documentation
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

Diff Detail

Repository
R893 Symmy
Lint
Lint Skipped
Unit
Unit Tests Skipped
lueck created this revision.Nov 24 2017, 3:09 PM

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

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

Yes, because khelpcenter supports also man and info pages.