nettika/geary
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Help Documentation for Geary 0.1

Browse source
This commit is contained in:
Laura Khalil 2012-05-04 16:53:48 -07:00
parent bb50cc85c6
commit 21f4347ca5
12 changed files with 252 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
help/CMakeLists.txt
View file

@ -1,7 +1,19 @@
set(HELP_DEST share/gnome/help/geary/C)
set(HELP_FILES
archive.page
bugs.page
conversation.page
editor.page
index.page
limits.page
send.page
shortcuts.page
spell.page
star.page
figures/Mail.png
)
install(FILES ${HELP_FILES} DESTINATION ${HELP_DEST})

17
help/archive.page Normal file
View file

@ -0,0 +1,17 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="archive">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="conversation"/>
</info>
<title>Archive messages</title>
<p>To archive a message, select the message from the conversation list and press the archive button located in the toolbar. To select multiple messages to archive, hold down the <key>Shift</key> key and click on the messages to be archived from the conversation list.</p>
<p>Archived messages will appear in the All Mail folder located in the folder list.</p>
</page>

17
help/bugs.page Normal file
View file

@ -0,0 +1,17 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="bugs">
<info>
<link type="guide" xref="index#bug"/>
<link type="next" xref="limits" />
</info>
<title>Think you've found a bug?</title>
<p>If you suspect you've found a bug in Geary, follow these steps to report it:</p>
<steps>
<item><p>Search Geary's Redmine<link href="http://redmine.yorba.org/projects/geary/issues"> issue tracker </link>to see if someone else has reported the bug.</p></item>
<item><p>Don't see your bug listed? Congratulations! You've found a new bug. To create an bug report, create an account on Redmine and create a new issue. Be as specific as you can and describe the steps to reproduce it. Don't forget to include details about your operating system and what version of Geary you're running.</p></item>
<item><p>For general inquiries, please join the <link href="http://lists.yorba.org/cgi-bin/mailman/listinfo/geary"> Geary mailing list</link>.</p></item>
</steps>
</page>

20
help/conversation.page Normal file
View file

@ -0,0 +1,20 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="conversation">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="editor"/>
</info>
<title>Conversations</title>
<p>Geary groups messages into conversations.</p>
<p>When opening a new message that is part of a conversation, notice that the previous messages are collapsed. To expand a message in a conversation thread, simply click on the collapsed message and it will expand. Click on the header to collapse it.</p>
<p>The newest message in a conversation cannot be collapsed.</p>
<p>To archive a conversation, select the conversation from the conversation list and click on the archive button in the toolbar. </p>
<p>To respond to a message, select the drop down menu from the message area in the top right corner and select to <gui>Reply</gui>, <gui>Reply to All</gui> or <gui>Forward</gui> the email. You can also reply to the last message in a conversation by selecting the <gui>Reply</gui>, <gui>Reply to All</gui> or <gui>Forward</gui> icons from the the toolbar. </p>
<p>Learn about the <link xref="shortcuts">keyboard shortcuts</link> to reply to messages.</p>
</page>

16
help/editor.page Normal file
View file

@ -0,0 +1,16 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="editor">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="shortcuts"/>
</info>
<title>Email composer</title>
<p>Geary's email composer allows you to adjust the font style, size and color of text. You can also insert hyperlinks into messages.</p>
<p>To use the email composer, you may either reply to a message or create a new message by clicking the icon located in the toolbar.</p>
</page>

BIN
help/figures/Mail.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.3 KiB

20
help/index.page
View file

@ -1,5 +1,17 @@
<page xmlns="http://projectmallard.org/1.0/" type="guide" id="index">
<title>Geary Help</title>
<p>Documentation coming soon</p>
</page>
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="index">
<title><media type="image" src="figures/Mail.png"></media>
Geary</title>
<p>A lightweight email reader for the GNOME desktop.</p>
<section id="overview" style="2column">
<title>Using Geary</title>
</section>
<section id="bug" style="2column">
<title>Bugs</title>
</section>
</page>

28
help/limits.page Normal file
View file

@ -0,0 +1,28 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="limits">
<info>
<link type="guide" xref="index#bug"/>
<link type="next" xref="bugs" />
</info>
<title>Limitations</title>
<p>Geary is still in early development. Geary supports IMAP and can be used with Gmail. Geary is missing attachment support, searching and numerous other features.</p>
<p>Geary may be used with Yahoo! Mail, however it is highly unstable and not recommended for primary email accounts on Yahoo! Mail.</p>
<p>To learn more about the features we're working on and the future of Geary, please visit Geary's <link href="http://redmine.yorba.org/projects/geary/wiki">Redmine page</link>.</p>
<section>
<title>Multiple email accounts</title>
<p>Geary does not support multiple email accounts. If you would like to change the email account used with Geary, you'll need to delete your Geary database. From a Nautilus window, locate your Geary database in .local/share/geary. Delete the folder named after your email account. Upon relaunching Geary, you will be prompted to enter your new email credentials. </p>
</section>
</page>

29
help/send.page Normal file
View file

@ -0,0 +1,29 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="send">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="star"/>
</info>
<title>Send and receive email</title>
<section>
<title>Receiving mail</title>
<p>Geary automatically downloads new messages to your inbox within seconds of them arriving. </p>
<p>Geary does not automatically download all messages in all of your mail folders. This makes Geary faster to use than some email programs. When Geary is launched, the 50 most recent messages are downloaded to your Inbox. If you would like to see more messages, simply continue to scroll down the conversation list and Geary will fetch them.</p>
<p>Similarly, when you click on any folder from the folder list, Geary will fetch only the most recent messages. You can view more messages by continuing to scroll down the conversation list.</p>
</section>
<section>
<title>Sending mail</title>
<p>To compose a new message, press the Compose button on the left side of the toolbar.</p>
<p>Once you press the Send button, your message will be delivered to its recipients immediately.</p>
<p>To <gui>Reply</gui>, <gui>Reply to All</gui> or <gui>Forward</gui> a message, you may select the message in the conversation viewer and click the corresponding icon located in the toolbar. Alternatively, you may also select the appropriate item from the dropdown menu located in the message area. </p>
<p>There are keyboard shortcuts available to <gui>Reply</gui>, <gui>Reply to All</gui> or <gui>Forward</gui> messages. Learn about all the <link xref="shortcuts"> keyboard shortcuts</link> in Geary.</p>
</section>
</page>

51
help/shortcuts.page Normal file
View file

@ -0,0 +1,51 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="shortcuts">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="spell" />
</info>
<title>Keyboard shortcuts</title>
<p>Geary has a growing list of keyboard shortcuts. </p>
<table frame="all" rules="rows">
<tr>
<td><p>Compose a new email</p></td> <td><p><keyseq><key>Ctrl</key><key>N</key></keyseq> or <key>N</key></p></td>
</tr>
<tr>
<td><p>Reply to email</p></td>
<td><p><keyseq><key>Ctrl</key><key>R</key></keyseq> or <key>R</key></p></td>
</tr>
<tr>
<td><p>Reply to all</p></td>
<td><p> <keyseq><key>Ctrl</key><key>Shift</key><key>R</key></keyseq> or <keyseq><key>Shift</key><key>R</key></keyseq> </p></td>
</tr>
<tr>
<td><p>Forward</p></td>
<td><p><keyseq><key>Ctrl</key><key>L</key></keyseq> or <key>F</key> </p></td>
</tr>
<tr>
<td><p>Archive</p></td>
<td><p> <key>A</key> or <key>Delete</key> or <key>Backspace</key></p></td>
</tr>
<tr>
<td><p>Quit</p></td>
<td><p><keyseq><key>Ctrl</key><key>Q</key></keyseq></p></td>
</tr>
<tr>
<td><p>Zoom in</p></td>
<td><p><keyseq><key>Ctrl</key><key>=</key></keyseq> or <key>=</key> </p></td>
</tr>
<tr>
<td><p>Zoom out</p></td>
<td><p><keyseq><key>Ctrl</key><key>-</key></keyseq> or <key>-</key> </p></td>
</tr>
<tr>
<td><p>Reset zoom</p></td>
<td><p><keyseq><key>Ctrl</key><key>0</key></keyseq> or <key>0</key> </p></td>
</tr>
</table>
</page>

24
help/spell.page Normal file
View file

@ -0,0 +1,24 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="spell">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="send" />
</info>
<title>Preferences</title>
<p>Geary has several optional features, all of which are enabled by default. If you would like to turn any of these defaults off, click the gear menu at the top right of the toolbar and choose Preferences.</p>
<section>
<title>Spell Checking</title>
<p>Geary automatically spell checks messages as they are being composed.</p>
</section>
<section>
<title>Autoselect Next Message</title>
<p>When this option is enabled, Geary automatically selects the latest message in a folder when you enter the folder. In addition, after archiving a message, Geary automatically selects an adjacent message.</p>
</section>
<section>
<title>Display Message Preview</title>
<p>Geary shows message previews in the conversation list by default. The preview shows the first lines of the message to provide additional information beyond what is written in the subject line. </p>
</section>
</page>

22
help/star.page Normal file
View file

@ -0,0 +1,22 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="star">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="archive"/>
</info>
<title>Star messages and mark as read</title>
<section>
<title>Star messages</title>
<p>You can star messages by selecting it and clicking on the star icon in the conversation list. Messages may also be starred within the message view area by clicking the star at the top right of the message.</p>
<p>Starred messages will appear in your Starred folder located in the folder list.</p>
<p>Learn about the <link xref="shortcuts">keyboard shortcuts</link> to star messages.</p>
</section>
<section>
<title>Mark messages as read or unread</title>
<p>Messages are marked as read when they are selected from the conversation list. To mark a message as unread, select Mark as Unread from the dropdown menu inside the message viewer. If you would like to mark a message as read, you may select Mark as Read option from the dropdown menu.</p>
</section>
</page>