summaryrefslogtreecommitdiffstats
path: root/doc/en/bookmarks.docbook
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2013-10-07 23:28:24 +0200
committerSlávek Banko <slavek.banko@axis.cz>2013-10-08 05:14:51 +0200
commit3af5832abe7c802a384cd58d34f7cc4433595ced (patch)
treecc300d6fae4cb5798f0cf5db3ece63026f34379a /doc/en/bookmarks.docbook
downloadkscope-3af5832abe7c802a384cd58d34f7cc4433595ced.tar.gz
kscope-3af5832abe7c802a384cd58d34f7cc4433595ced.zip
Initial import of kscope 1.6.2
Diffstat (limited to 'doc/en/bookmarks.docbook')
-rw-r--r--doc/en/bookmarks.docbook28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/en/bookmarks.docbook b/doc/en/bookmarks.docbook
new file mode 100644
index 0000000..8607645
--- /dev/null
+++ b/doc/en/bookmarks.docbook
@@ -0,0 +1,28 @@
+<sect1 id="bookmarks">
+<title>Bookmarks</title>
+
+<para>
+Bookmarks provide an easy way to navigate through a defined set of positions in the source code. Most editors support the concept of bookmarks as tags attached to lines in a source file. &kapp; can enhance the usablity of per-file markers by enabling users to access the bookmarks currently defined in all open files. &kapp; also saves and restores these bookmarks as part of its session-management services.
+</para>
+
+<para>
+The <guilabel>Bookmarks</guilabel> dialogue is invoked by the <menuchoice><guimenu>Go</guimenu><guimenuitem>Global Bookmarks</guimenuitem></menuchoice> menu command. Once open, it displays the set bookmarks among all currently-open files. This includes the file path, the source line and the line's text (similar to other source views available in &kapp;).
+</para>
+
+<screenshot>
+<screeninfo>The Bookmarks dialogue</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="bookmarks.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>The Bookmarks dialogue</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
+<para>
+Navigating to a defined bookmark can be done by either double-clicking an entry in the dialogue, or by choosing the <menuchoice><guimenuitem>View Source</guimenuitem></menuchoice> item from the context menu (available by right-clicking over a bookmark entry). Other choices presented by the context menu include <menuchoice><guimenuitem>Copy [FIELD]</guimenuitem></menuchoice> for copying the contents of the current field to the clipboard, <menuchoice><guimenuitem>Filter...</guimenuitem></menuchoice> for selecting entries based on some criteria, <menuchoice><guimenuitem>Show All</guimenuitem></menuchoice> for removing all filters and <menuchoice><guimenuitem>Remove Item</guimenuitem></menuchoice> for deleting the bookmark.
+</para>
+
+</sect1> \ No newline at end of file