CODEWITHSUNDEEP
pythongtk
Charles Brunet
Charles Brunet

Reputation: 23140

How to display the manual in Gtk?

I'm building a Gtk3 application using Python. I was wondering if there was a standard way for building and displaying inline help (the manual). More specifically:

  1. What text format should I use for storing it (html? XML? other?)
  2. How should I display it? I need to be able to browse the contents, the search for specific terms, to display formatted text with images, and to open the help window at a specific location when the user request online help about a specific part of the user interface.

Finally, in the ideal case, it should be cross-platform (e.g. I plan to port it to Windows)

Upvotes: 2

Views: 200

Answers (1)

liberforce
liberforce

Reputation: 11454

Didn't know your app needed to be multiplatform. Be careful, because GTK3 on Windows is quite difficult to use for the time being (AFAIK there are no official installer either for GTK3 nor PyGObject on Windows, only community stuff).

On Linux, GNOME uses Yelp to handle documentation, but I don't know if it has been ported to Windows.

Upvotes: 2

Related Questions