GSoC: Readable Redesign, Documentation Cards

Following the previously devised plan, I worked on the design of the documentation card, making it more readable. The main concept stayed the same, using the GtkPopover to display the small card with input and output types of the function on hover.

Screen Shot 2017-07-12 at 18.30.03

If needed giving more information about the function by clicking “Show more”.

Screen Shot 2017-07-12 at 18.29.50

Screen Shot 2017-07-12 at 18.29.57

The styling is done by using the Pango text markup language, since it can be inserted in GtkLabel using function gtk_label_set_marker (). Also you can notice direct access to the documentation on the bottom of the card.

The current implementation of documentation can be found here. Any feedback will be appreciated.

So what next? Next task at hand is making the support of providing documentation open for extension by making Devhelp just one of the possible provider of information.  By detaching the documentation support from Devhelp more features will be able to use the information (such as autocomplete) and in the future more provider of documentation information can be added.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s