Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace help with pages from the manual #18075

Closed
qgib opened this issue Feb 3, 2014 · 8 comments
Closed

Replace help with pages from the manual #18075

qgib opened this issue Feb 3, 2014 · 8 comments
Labels
Documentation Changes to Documentation, README, INSTALL, etc Feature Request Feedback Waiting on the submitter for answers

Comments

@qgib
Copy link
Contributor

qgib commented Feb 3, 2014

Author Name: Paolo Cavallini (@pcav)
Original Redmine Issue: 9483

Redmine category:documentation_and_help
Assignee: Richard Duivenvoorde


Translating help files in GUI is always the most painful part, and I am convinced it
is not the most useful one, as the content is often obsolete and not aligned with the
manual.
My suggestion is to:

  • remove the help
  • replace it with the relevant manpage, either including it or adding a link to the
    manual
  • ship the manual together with the package (problem: shipping all the languages will
    be very heavy).

Related issue(s): #17312 (duplicates)
Redmine related issue(s): 8564


@qgib
Copy link
Contributor Author

qgib commented Jun 23, 2014

Author Name: Paolo Cavallini (@pcav)


Duplicated in #17312

@qgib
Copy link
Contributor Author

qgib commented Apr 30, 2017

Author Name: Giovanni Manghi (@gioman)


  • easy_fix was configured as 0

@qgib
Copy link
Contributor Author

qgib commented Jan 27, 2018

Author Name: Alexander Bruy (@alexbruy)


IMHO now addressed in master: Help buttons open corresponding web-pages.


  • status_id was changed from Open to Feedback
  • description was changed from Translating help files in GUI is always the most painful part, and I am convinced it
    is not the most useful one, as the content is often obsolete and not aligned with the
    manual.
    My suggestion is to:
  • remove the help

  • replace it with the relevant manpage, either including it or adding a link to the
    manual

  • ship the manual together with the package (problem: shipping all the languages will
    be very heavy). to Translating help files in GUI is always the most painful part, and I am convinced it
    is not the most useful one, as the content is often obsolete and not aligned with the
    manual.
    My suggestion is to:

  • remove the help

  • replace it with the relevant manpage, either including it or adding a link to the
    manual

  • ship the manual together with the package (problem: shipping all the languages will
    be very heavy).

@qgib
Copy link
Contributor Author

qgib commented Jan 27, 2018

Author Name: Paolo Cavallini (@pcav)


Huge improvement, thanks.
One crucial point is not fully addressed, however: when offline the user has to add the path to the manual by hand; probably it would be good to prefill the path and install the manual as an installation option.

@qgib
Copy link
Contributor Author

qgib commented Jan 27, 2018

Author Name: Richard Duivenvoorde (@rduivenvoorde)


The offline help mode is some more work:

  • we need to have a download service (per language a zip of around 170Mb) and build/upload these every day fresh on something like: https://docs.qgis.org/download/3.0/en etc?
  • we could create a button near the input of the settings dialog where you can add url's?
  • we need to think about where to save/unpack this zip, as installs can be very diverse. A normal user for example cannot save such zip in the install dir. OR we could/should make it part of the install scripts? Packaging for Linux?

Some other issue is that a fresh profile does not link to the right url (the setting is not picked up if you do not save your settings at least once): #25567

@qgib
Copy link
Contributor Author

qgib commented Jan 27, 2018

Author Name: Paolo Cavallini (@pcav)


Well understood, thanks Richard for the analysis.
I suggest to leave this ticket open for future reference.

@qgib
Copy link
Contributor Author

qgib commented Mar 6, 2018

Author Name: Paolo Cavallini (@pcav)


It seems to me that this is fixed. Please Richard decide whether to close it.


  • assigned_to_id was configured as Richard Duivenvoorde

@qgib qgib added Feedback Waiting on the submitter for answers Feature Request Documentation Changes to Documentation, README, INSTALL, etc labels May 24, 2019
@alexbruy
Copy link
Contributor

Closing as now help points to the documentation. Please reopen if necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Changes to Documentation, README, INSTALL, etc Feature Request Feedback Waiting on the submitter for answers
Projects
None yet
Development

No branches or pull requests

2 participants