Skip to content

Commit

Permalink
Merge pull request #1867 from Eitot/feature/help-book
Browse files Browse the repository at this point in the history
Tweak the wording in some help book pages
  • Loading branch information
Eitot authored Jan 7, 2025
2 parents 9375507 + 556a4e4 commit 1ec9bca
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
12 changes: 6 additions & 6 deletions Vienna Help/Resources/en.lproj/Vienna.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
<td width="300">
<p class="header">Introduction to Vienna</p>
<p><a href="intro.html">Learn how to get started with Vienna.</a></p>
<p class="header">Keyboard Shortcuts</p>
<p><a href="keyboard.html">Discover keyboard shortcuts for common commands</a></p>
<p class="header">How Do I?</p>
<p><a href="faq.html">Frequently Asked Questions, getting support and troubleshooting steps.</a></p>
<p class="header">Advanced Settings</p>
<p><a href="advanced.html">Explains the settings in the Advanced Preferences.</a></p>
<p class="header">Keyboard shortcuts</p>
<p><a href="keyboard.html">Discover keyboard shortcuts for common commands.</a></p>
<p class="header">How do I …?</p>
<p><a href="faq.html">Frequently asked questions, getting support and troubleshooting steps.</a></p>
<p class="header">Advanced settings</p>
<p><a href="advanced.html">Explains Advanced settings in Vienna.</a></p>
</td>
</tr>
</tbody>
Expand Down
8 changes: 4 additions & 4 deletions Vienna Help/Resources/en.lproj/advanced.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Advanced Settings</title>
<title>Advanced settings in Vienna</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Explains advanced settings in Vienna." />
<meta name="description" content="Explains Advanced settings in Vienna." />
<link href="../shared/helpstyle.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a id="AdvancedSettingsSection" name="AdvancedSettingsSection"></a> <span><img src="../shared/images/Small-Vienna-Logo.png" alt="" />&nbsp;&nbsp;</span><span class="header">Advanced Settings</span>
<p>The Advanced section of the Preferences provides options to change very specific settings in Vienna that are not essential for normal use but may resolve some issues as advised by the support forum. This page details the advanced settings and their function.</p>
<a id="AdvancedSettingsSection" name="AdvancedSettingsSection"></a> <span><img src="../shared/images/Small-Vienna-Logo.png" alt="" />&nbsp;&nbsp;</span><span class="header">Advanced settings in Vienna</span>
<p>Advanced settings provide very specific options that are not essential for normal use but may resolve some issues as advised by the support forum. This page details those settings and their function.</p>
<h2><b>Enable JavaScript in internal browser</b></h2>
<p>Enables or disables support for JavaScript scripting in the Vienna internal browser. By default this is enabled. By turning this setting off, JavaScript code on web pages will not be allowed to run. This may resolve problems with pages that use scripting to pop up windows or other unexpected behaviour but turning the setting off may also cause some web pages to appear incomplete or fail to function correctly.</p>
</body>
Expand Down
6 changes: 3 additions & 3 deletions Vienna Help/Resources/en.lproj/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>How Do I?</title>
<title>How do I … in Vienna?</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Frequently asked questions about Vienna, getting support and troubleshooting steps." />
<link href="../shared/helpstyle.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a id="faq-page" name="faq-page"></a> <span><img src="../shared/images/Small-Vienna-Logo.png" alt="" />&nbsp;&nbsp;</span><span class="header">How Do I?</span>
<a id="faq-page" name="faq-page"></a> <span><img src="../shared/images/Small-Vienna-Logo.png" alt="" />&nbsp;&nbsp;</span><span class="header">How do I … in Vienna?</span>
<p>Below are some of the more common questions asked about Vienna while it was being pre-release tested. See the <a href="http://www.vienna-rss.com/vienna_faq.html">Official Vienna FAQ Page</a> for these and the latest hints and tips for using Vienna.</p>
<ul>
<li><a href="#I_found_a_problem_with_Vienna._How_do_I_report_it">I found a problem with Vienna. How do I report it?</a></li>
Expand Down Expand Up @@ -75,7 +75,7 @@ <h2><a id="Is_there_a_shortcut_key_for_going_to_the_next_article_marking_read_et
<h2><a id="What_do_the_green_dots_mean_in_the_list_of_articles" name="What_do_the_green_dots_mean_in_the_list_of_articles">What do the green dots mean in the list of articles?</a></h2>
<p>The blue dots are for new articles, and the green dots are for updated articles: articles whose text has changed since they were last downloaded.</p>
<h2><a id="How_do_I_use_Auto_Expire_and_what_does_it_do" name="How_do_I_use_Auto_Expire_and_what_does_it_do">How do I use Auto Expire and what does it do?</a></h2>
<p>Auto-expire moves articles older than a certain number of days to the Trash folder. It allows you to keep your folders manageable by only retaining articles that are recent. The auto-expire runs both when Vienna starts and after you have refreshed any subscriptions. To control the age of articles to auto-expire, change the "Move articles to Trash" option in Preferences.</p>
<p>Auto-expire moves articles older than a certain number of days to the Trash folder. It allows you to keep your folders manageable by only retaining articles that are recent. The auto-expire runs both when Vienna starts and after you have refreshed any subscriptions. To control the age of articles to auto-expire, change the "Move articles to Trash" option in General settings.</p>
<p>Auto-expire will NOT remove unread or flagged articles. It assumes that you haven't read these articles and thus leaves them alone.</p>
<h2><a id="How_do_I_create_my_own_styles" name="How_do_I_create_my_own_styles">How do I create my own styles?</a></h2>
<p>See the <a href="https://www.vienna-rss.com/extras/creating-custom-styles/">Custom Styles page</a> for instructions.</p>
Expand Down
8 changes: 4 additions & 4 deletions Vienna Help/Resources/en.lproj/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<p>If this is the first time that you have used Vienna then it will have created a new database for you and added some sample news subscriptions. So go ahead and press Command+R or choose Refresh All Subscriptions from the File menu to grab the latest articles from those subscriptions.</p>
<p>Alternatively, subscribe to your own news feeds. There are various ways to find feeds. When browsing the web, look out for the <img src="../shared/images/rssfeed.gif" alt="RSS feed icon" /> or XML icons indicating that the page has a feed associated with it. Alternatively almost all online blogging services such as LiveJournal or Blogger provide RSS feeds as an alternative to reading the postings online.</p>
<p>If you know the user name of a blogger on LiveJournal, Blogger, MSN Spaces or Xanga then Vienna makes it easier to subscribe to their news feed. Start by pressing Command+N or from the File menu, choose the New Subscription command. In the "Create a new RSS subscription" panel, pick the blogging service from the drop down list and enter the user name in the input field below. Then choose Subscribe and Vienna will add the subscription to the folder list. If you are connected to the internet at the time, it will also immediately start collecting articles from the feed.</p>
<p>You can also use Vienna in relation with an account in an Open Reader server. Go into Preferences... / Syncing and tick the "Sync with an Open Reader server" checkbox.<br />
<p>You can also use Vienna in relation with an account in an Open Reader server. Go to Settings &gt; Syncing and tick the "Sync with an Open Reader server" checkbox.<br />
Beforehand, think about which feeds you prefer reading through Open Reader and which you'll get through direct access. Vienna will avoid creating duplicates between the two categories, but if you have feeds inside Open Reader which Vienna already fetches directly, you will have discrepancies between your reading lists. So, organize your feeds accordingly.<br />
You should take into account these elements:</p>
<ul>
Expand All @@ -25,9 +25,9 @@
<li>Fetching feeds directly avoids the Open Reader service as an intermediary between you and the publishing site; for less "popular" feeds, you'll get articles sooner.</li>
<li>Generally, directly fetching feeds from their original website generates less network traffic. When the server signals there is no new articles since last fetch, Vienna avoids an useless download.</li>
</ul>
<p>Normally you need to manually tell Vienna when to refresh all your subscriptions. However you can opt to ask Vienna to automatically refresh at time intervals. In the General section of the Preferences, pick the desired time interval from the drop down list next to 'Check for new articles'. Vienna needs to be running for it to automatically refresh subscriptions.</p>
<p>To read articles, press the Spacebar to skip to the next unread article in any subscription. Each article is marked as read automatically after a short delay. If you prefer to wait until you move to the next unread article before the current one is marked read you can adjust the behaviour in the General tab of the Preferences. To mark an article as unread again, choose the Mark Unread command from the Article menu or simply press the 'R' key.</p>
<p>Finally, you can view the article web page or any web page links in an article within Vienna. By default clicking on a web link within Vienna will open the web page in a new tab. Vienna provides a lot of basic web browsing support itself but there may be times when you will prefer to open links in your default web browser. If you prefer to view all web pages outside of Vienna then enable the 'Open links in external browser' option in the General section of the Preferences. However if you prefer to view the current link or page in your external browser, right click on the page and choose the "Open Link in XXX" or "Open Page in XXX" option where XXX will be the name of your default browser.</p>
<p>Normally you need to manually tell Vienna when to refresh all your subscriptions. However you can opt to ask Vienna to automatically refresh at time intervals. In General settings, pick the desired time interval from the drop down list next to 'Check for new articles'. Vienna needs to be running for it to automatically refresh subscriptions.</p>
<p>To read articles, press the Spacebar to skip to the next unread article in any subscription. Each article is marked as read automatically after a short delay. If you prefer to wait until you move to the next unread article before the current one is marked read you can adjust the behaviour in General settings. To mark an article as unread again, choose the Mark Unread command from the Article menu or simply press the 'R' key.</p>
<p>Finally, you can view the article web page or any web page links in an article within Vienna. By default clicking on a web link within Vienna will open the web page in a new tab. Vienna provides a lot of basic web browsing support itself but there may be times when you will prefer to open links in your default web browser. If you prefer to view all web pages outside of Vienna then enable the 'Open links in external browser' option in General settings. However if you prefer to view the current link or page in your external browser, right click on the page and choose the "Open Link in XXX" or "Open Page in XXX" option where XXX will be the name of your default browser.</p>
<p>Once you've got comfortable using Vienna, go ahead and explore the various options. You can change the style in which the articles are displayed through the Style drop down list in the View menu. You can find many more custom styles at the <a href="https://www.vienna-rss.com/extras/">Extras</a> page on the Vienna web site along with custom scripts that allow you to integrate Vienna with other applications on your machine. Or experiment with smart folders to organise articles according to criteria based on the contents of each article. For example, you can easily set up a smart folder to group together all articles that mention "Joss Whedon" and "Firefly" to find references to the Firefly cult series or the spin-off movie.</p>
<p>If you have any questions about Vienna or run into problems, send an email to <a href="mailto:[email protected]">Vienna Help</a> or head over to the <a href="https://github.com/ViennaRSS/vienna-rss/discussions">Support forum</a>.</p>
</body>
Expand Down
10 changes: 5 additions & 5 deletions Vienna Help/Resources/en.lproj/keyboard.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Keyboard Shortcuts</title>
<title>Keyboard shortcuts in Vienna</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Discover keyboard shortcuts for common commands in Vienna." />
<link href="../shared/helpstyle.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a id="KeyboardSection" name="KeyboardSection"></a> <span><img src="../shared/images/Small-Vienna-Logo.png" alt="" />&nbsp;&nbsp;</span><span class="header">Keyboard Shortcuts</span>
<a id="KeyboardSection" name="KeyboardSection"></a> <span><img src="../shared/images/Small-Vienna-Logo.png" alt="" />&nbsp;&nbsp;</span><span class="header">Keyboard shortcuts in Vienna</span>
<p>You can use your keyboard to quickly accomplish many tasks in Vienna. To find the shortcuts for common commands, look in the menus (or see the list at the bottom of this page). Many items in Vienna such as the folder pane and the article list pane also have contextual menus. To see a contextual menu, press the Control key and click the item.</p>
<p>To do an action, press the shortcut keys indicated below.</p>
<table width="662" border="0" cellspacing="0" id="table1" cellpadding="8">
Expand Down Expand Up @@ -85,7 +85,7 @@
</tr>
<tr>
<td>Alt-Click</td>
<td>Open the clicked link, overriding your preference for opening links in external browser.</td>
<td>Open the clicked link, overriding your setting for opening links in external browser.</td>
</tr>
<tr>
<td>Shift-Command-B</td>
Expand Down Expand Up @@ -185,7 +185,7 @@
</tr>
<tr>
<td>Command-,</td>
<td>Opens the Vienna preferences panel.</td>
<td>Opens Vienna settings.</td>
</tr>
<tr>
<td>Alt-Command-Backspace</td>
Expand All @@ -201,7 +201,7 @@
</tr>
<tr>
<td>Alt-Enter/Alt-Return</td>
<td>Opens the selected article's original web page, overriding your preference for opening links in external browser.</td>
<td>Opens the selected article's original web page, overriding your setting for opening links in external browser.</td>
</tr>
<tr>
<td>Shift-Command-Z</td>
Expand Down

0 comments on commit 1ec9bca

Please sign in to comment.