Blame platform-overview/ru/dev-help-appmenu.page

Packit 1470ea
Packit 1470ea
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" style="task" id="dev-help-appmenu" xml:lang="ru">
Packit 1470ea
Packit 1470ea
  <info>
Packit 1470ea
    <link type="seealso" xref="dev-help"/>
Packit 1470ea
    <revision version="0.1" date="2013-06-19" status="review"/>
Packit 1470ea
Packit 1470ea
    <credit type="author copyright">
Packit 1470ea
      <name>Radina Matic</name>
Packit 1470ea
      <email its:translate="no">radina.matic@gmail.com</email>
Packit 1470ea
      <years>2013</years>
Packit 1470ea
    </credit>
Packit 1470ea
    <credit type="editor">
Packit 1470ea
      <name>Ekaterina Gerasimova</name>
Packit 1470ea
      <email its:translate="no">kittykat3756@gmail.com</email>
Packit 1470ea
      <years>2013</years>
Packit 1470ea
    </credit>
Packit 1470ea
Packit 1470ea
    <include xmlns="http://www.w3.org/2001/XInclude" href="cc-by-sa-3-0.xml"/>
Packit 1470ea
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
  <title>Add <gui>Help</gui> to the application menu</title>
Packit 1470ea
Packit 1470ea
  <links type="series" style="floatend">
Packit 1470ea
    <title>Set up help</title>
Packit 1470ea
  </links>
Packit 1470ea
Packit 1470ea
  

Most GNOME applications should have an application menu. The

Packit 1470ea
  <gui style="menuitem">Help</gui> menu item should go above the
Packit 1470ea
  <gui style="menuitem">About</gui> menu item.

Packit 1470ea
Packit 1470ea
  <example>
Packit 1470ea
  <note>
Packit 1470ea
    

This example, based on

Packit 1470ea
    <app href="https://git.gnome.org/browse/cheese/tree/src/cheese-main.vala">Cheese</app>,
Packit 1470ea
    assumes that your application is written in Vala. It will be slightly
Packit 1470ea
    different for other programming languages.

Packit 1470ea
  </note>
Packit 1470ea
Packit 1470ea
  

Add the <gui style="menuitem">Help</gui> item to the list of actions:

Packit 1470ea
  
Packit 1470ea
   private const GLib.ActionEntry action_entries[] = {
Packit 1470ea
        <input>{ "help", on_help },</input>
Packit 1470ea
        { "about", on_about },
Packit 1470ea
        { "quit", on_quit }
Packit 1470ea
    };
Packit 1470ea
Packit 1470ea
   add_action_entries (action_entries, my_Gtk_Application);
Packit 1470ea
Packit 1470ea
Packit 1470ea
  

Add the <gui style="menuitem">Help</gui> menu item to the application

Packit 1470ea
  menu:

Packit 1470ea
Packit 1470ea
Packit 1470ea
  var menu = new GLib.Menu ();
Packit 1470ea
  var section = new GLib.Menu ();
Packit 1470ea
Packit 1470ea
  <input>var item = new GLib.MenuItem (_("_Help"), "app.help");
Packit 1470ea
  item.set_attribute ("accel", "s", "F1");
Packit 1470ea
  section.append_item (item);</input>
Packit 1470ea
Packit 1470ea
Packit 1470ea
  

View the help with <app>Yelp</app> when the

Packit 1470ea
  <gui style="menuitem">Help</gui> menu item is clicked:

Packit 1470ea
Packit 1470ea
Packit 1470ea
  private void on_help ()
Packit 1470ea
  {
Packit 1470ea
    var screen = main_window.get_screen ();
Packit 1470ea
    try
Packit 1470ea
    {
Packit 1470ea
      Gtk.show_uri (screen, <input>"help:cheese"</input>, Gtk.get_current_event_time ());
Packit 1470ea
    }
Packit 1470ea
    catch (Error err)
Packit 1470ea
    {
Packit 1470ea
      message ("Error opening help: %s", err.message);
Packit 1470ea
    }
Packit 1470ea
  }
Packit 1470ea
Packit 1470ea
Packit 1470ea
  

To link to a section on the <file>index.page</file>, use

Packit 1470ea
  "help:<input>applicationname</input>/index#<input>sectionid</input>".

Packit 1470ea
Packit 1470ea
  </example>
Packit 1470ea
</page>