Add help for RSS Accounts for mailnews

RESOLVED FIXED in seamonkey2.0b1

Status

SeaMonkey
Help Documentation
RESOLVED FIXED
13 years ago
9 years ago

People

(Reporter: Ian Neal, Assigned: RickieES aka Ricardo Palomares)

Tracking

(Blocks: 2 bugs)

Trunk
seamonkey2.0b1
Dependency tree / graph

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment, 13 obsolete attachments)

63.21 KB, patch
Ian Neal
: review+
Details | Diff | Splinter Review
(Reporter)

Description

13 years ago
Once bug 255834 has landed, some help documentation will be needed.

Comment 1

13 years ago
Is this just for Seamonkey? Is this product still alive?

Comment 2

13 years ago
(In reply to comment #1)
> Is this just for Seamonkey? Is this product still alive?

Yes, this is for Seamonkey. Alive and well - yes :)

Comment 3

13 years ago
OK, I've downloaded it. Let me see what I can do.

Glad to read it's still alive.

Comment 4

13 years ago
(In reply to comment #3)
> OK, I've downloaded it. Let me see what I can do.
> 
> Glad to read it's still alive.

Note that you won't see this feature until bug 255834 is fixed. But since I
suppose it would be the same as in Thunderbird, it shouldn't be that hard to
start  working on the help doc.

Updated

11 years ago
Assignee: help.viewer → neil
Component: Help Viewer → Help
Product: Documentation → Mozilla Application Suite
(Reporter)

Updated

10 years ago
Keywords: helpwanted

Updated

10 years ago
Blocks: 423281

Comment 5

10 years ago
FYI: Mozillazine Knowledgebase article (probably GFDL)

<http://kb.mozillazine.org/RSS_basics_-_Thunderbird>
Flags: blocking-seamonkey2?
Version: unspecified → Trunk
(Assignee)

Comment 6

9 years ago
I'm working on it now. I'm adding content into mail_help.xhtml. Should I wait to have something more or less finished before posting it patches, or do you want to get information as early as possible as I advance?

Comment 7

9 years ago
In general, it's more difficult to give feedback on a non-finished job, but if you're not sure you're on the right track it might be a good idea to ask / post a draft. Thanks for doing this, btw :-)
Assignee: neil → rpmdisguise-otros
Keywords: helpwanted
(Assignee)

Comment 8

9 years ago
Ok, so I'm writing blogs section between "Getting started with news" and "Working offline", with these sections, adapted from the newsgroups:

* Subscribing to news & blog feeds
* Reading blog messages
* Posting blog messages
* Adding comments to a blog post
* Removing a feed
* Using different news & blog accounts

Third and fourth are there just to make clear there is no direct, standard way to do it from the Mail component (at least that what I hope!). :-)

Besides that, I'm dropping references to blog accounts at the start of mail_help.xhtml and I'll complete something in the account settings, too.

I could need some directions later, to update the index and TOC RDFs.

If I'm not in the right track, please, let me know. :-)

Comment 9

9 years ago
Looks good to me. Ian (who should know more about the subject than me), how does this sounds?
(Assignee)

Comment 10

9 years ago
(In reply to comment #8)
> * Subscribing to news & blog feeds
> * Reading blog messages
> * Posting blog messages
> * Adding comments to a blog post


I've added this one, too:

* Exporting and importing feeds


> * Removing a feed
> * Using different news & blog accounts


I'm finishing these sections. After that, I'll take a look into the accounts settings.
(Assignee)

Comment 11

9 years ago
Created attachment 372203 [details] [diff] [review]
First draft. This path doesn't include changes to TOC and index RDFs

The diff has been made with:

diff -U 8 [comm-central local copy of mail_help.xhtml] [working copy of mail_help.xhtml]

I'm pretty sure I should be more professional regarding patches, but as I consider this only a first draft, I hope to get more instructions about the proper way to do it. :-)
(Assignee)

Comment 12

9 years ago
(In reply to comment #11)
> Created an attachment (id=372203) [details]
> First draft. This path doesn't include changes to TOC and index RDFs


OK, so before you tell me, I've just realized that there is a missing section (Using different news and blogs accounts). I'm about to going out for the rest of the day, so I will get back to it tonight. Anyway, I guess the rest is enough to start triggering comments.

I also have some questions and comments about both the patch (mainly, which RDFs are in use now with the new help viewer) and the RSS feature itself (I think I've uncovered some bugs; I havent' looked it up to see if they have been already filed).

Comment 13

9 years ago
>Additional Mail, News &amp; Blogs Accounts

Just a comment: maybe we should connect "Blogs Accounts" with "Blogs & News Feeds" stronger (the choice in account mngr). That is, it might not be obvious that "Blogs Accounts" is actually an account for feed subscriptions? I do realize that naming it "Feed Subscription Accounts" (or something) might not be 100% clear either, though (what is this thing called "Feeds"?).
(Assignee)

Comment 14

9 years ago
(In reply to comment #13)
> >Additional Mail, News &amp; Blogs Accounts
> 
> Just a comment: maybe we should connect "Blogs Accounts" with "Blogs & News
> Feeds" stronger (the choice in account mngr). That is, it might not be obvious
> that "Blogs Accounts" is actually an account for feed subscriptions? I do
> realize that naming it "Feed Subscription Accounts" (or something) might not be
> 100% clear either, though (what is this thing called "Feeds"?).


I've been reviewing the UI for the different terms used, and this is what I've got:

New Account Wizard
  - Blogs & News Feeds

Account Pane
  - Feeds

Subscriptions Dialog
  - RSS Subscriptions


Some changes have happened between 2.0a3 (which is what I was using to create the documentation) and 2.0b1pre nightlies. I'm going to review my changes and complete the missing section and provide a new patch draft.
(Assignee)

Comment 15

9 years ago
Created attachment 372954 [details] [diff] [review]
Revised first draft. This path doesn't include changes to TOC and index RDFs

I've completed the missing sections and replaced most references to the feature by the common term "Blogs &amp; News Feeds".
Attachment #372203 - Attachment is obsolete: true
(Assignee)

Comment 16

9 years ago
Oh, and I have some questions:

- Look at this patch snippet:

+<p>While browsing the web using &brandShortName;, you may find the Feed
+  discovery icon while visiting a web page
+  <img src="chrome://communicator/skin/navigator/btn1/feeds.png" alt="RSS feed
+  discovery icon"/>. You can click on it to see a list of available feeds and
+  choose one to get it added to your first Blogs &amp; News account.</p>


The image is taken from the skin, as I understand that it should be done that way whenever possible to avoid duplicating images from chrome. However, that image is actually a mosaic of six RSS icons with different intensities; is there a way to clip the image to just one icon, or should take it out and put it under help/images?


- Is glossary.xhtml accessible from the new SM help viewer? If so, I guess I should add some terms to it (feed, RSS, OPML).

- Which RDF files are still in use with the new SM help viewer? I'd say that the  help-index*.rdf files are no longer in use, but I'm not sure.

Comment 17

9 years ago
(In reply to comment #16)
> Oh, and I have some questions:
> 
> - Look at this patch snippet:
> 
> +<p>While browsing the web using &brandShortName;, you may find the Feed
> +  discovery icon while visiting a web page
> +  <img src="chrome://communicator/skin/navigator/btn1/feeds.png" alt="RSS feed
> +  discovery icon"/>. You can click on it to see a list of available feeds and
> +  choose one to get it added to your first Blogs &amp; News account.</p>
> 
> 
> The image is taken from the skin, as I understand that it should be done that
> way whenever possible to avoid duplicating images from chrome. However, that
> image is actually a mosaic of six RSS icons with different intensities; is
> there a way to clip the image to just one icon, or should take it out and put
> it under help/images?

IIRC, there's another stand-alone icon somewhere. But I think you might be able to reference the image with css. See the patch in bug 285325 for an idea on how it can be done. The advantage is that then you're not relying on the file name.

> 
> - Is glossary.xhtml accessible from the new SM help viewer? If so, I guess I
> should add some terms to it (feed, RSS, OPML).

Yeah, please add those terms ;-) Glossary terms found when you search and we usually add a link to a term when it first occurs in the text.
> 
> - Which RDF files are still in use with the new SM help viewer? I'd say that
> the  help-index*.rdf files are no longer in use, but I'm not sure.

IIRC, when you search, you'll get results from those files (terms that doesn't exist in the other files). Basically, you can use those files when you want to add additional words that might be relevant to a certain subject.
(Assignee)

Comment 18

9 years ago
(In reply to comment #17)
> (In reply to comment #16)
> > The image is taken from the skin, as I understand that it should be done that
> > way whenever possible to avoid duplicating images from chrome. However, that
> > image is actually a mosaic of six RSS icons with different intensities; is
> > there a way to clip the image to just one icon, or should take it out and put
> > it under help/images?
> 
> IIRC, there's another stand-alone icon somewhere. But I think you might be able
> to reference the image with css. See the patch in bug 285325 for an idea on how
> it can be done. The advantage is that then you're not relying on the file name.


Would it better if I wait for progress on that bug before trying to imitate it? I'm not specially clever with CSS.


> > - Is glossary.xhtml accessible from the new SM help viewer? If so, I guess I
> > should add some terms to it (feed, RSS, OPML).
> 
> Yeah, please add those terms ;-) Glossary terms found when you search and we
> usually add a link to a term when it first occurs in the text.
> > 
> > - Which RDF files are still in use with the new SM help viewer? I'd say that
> > the  help-index*.rdf files are no longer in use, but I'm not sure.
> 
> IIRC, when you search, you'll get results from those files (terms that doesn't
> exist in the other files). Basically, you can use those files when you want to
> add additional words that might be relevant to a certain subject.


Both these two answers leads me to my other pending question. :-) What's the best way to actually prepare the patch now that it involves multiple files? I mean, if I actually modify the files in my local copy of the comm-central repository, will they be reverted to the real ones each time I update the mercurial repository to update my es-ES localization?

Sorry for my ignorance about these topics. It was somewhat easier with CVS to me, but now I'm a bit lost with Mercurial. :-)

Comment 19

9 years ago
(In reply to comment #18)

> Would it better if I wait for progress on that bug before trying to imitate it?
> I'm not specially clever with CSS.

I happen to have a new patch there ;-)


> What's the
> best way to actually prepare the patch now that it involves multiple files? I
> mean, if I actually modify the files in my local copy of the comm-central
> repository, will they be reverted to the real ones each time I update the
> mercurial repository to update my es-ES localization?

No, if you do an "hg pull -u" your local changes won't be affected (if someone else have pushed a change to the files that you've edited, you might need to merge, though).
(Assignee)

Comment 20

9 years ago
Just in case, is there a "tool" (besides a text editor) :-) to update/recreate help-index1.rdf, or is it done manually?

Comment 21

9 years ago
(In reply to comment #20)
> Just in case, is there a "tool" (besides a text editor) :-) to update/recreate
> help-index1.rdf, or is it done manually?

I suppose you mean the re-ordering - no, not what I know of.

Comment 22

9 years ago
>> Just in case, is there a "tool" (besides a text editor) :-) to update/recreate
>> help-index1.rdf, or is it done manually?
> I suppose you mean the re-ordering - no, not what I know of.
In addition since there is no one canonical way of serializing rdf out to a xml file, the tools I know of will write out totally different files from the original even if you didn't make any changes. Now this will really mess up your diffs not to mention hg/cvs blame.
(Assignee)

Comment 23

9 years ago
Created attachment 373583 [details] [diff] [review]
First full patch draft

OK, so this patch should be complete (which doesn't mean correct). :-) It includes all TOC and RDF files I believe have to be modified, and the feeds icon image uses the "feedMenu" class in navigator.css.
Attachment #372954 - Attachment is obsolete: true
Attachment #373583 - Flags: approval-seamonkey2.0b1?

Updated

9 years ago
Attachment #373583 - Flags: approval-seamonkey2.0b1?

Comment 24

9 years ago
Comment on attachment 373583 [details] [diff] [review]
First full patch draft

We don't use the approval flag for review request :-)

Some hints regarding the process of getting your work in: :-)

When you feel your work is "ready" - ask for review by setting the review flag to "?" and fill in an e-mail address to the requestee (then the requestee gets an e-mail).

Comment 25

9 years ago
Comment on attachment 373583 [details] [diff] [review]
First full patch draft

I'd say it's either Ian or me. I'd prefer if Ian did this since it's really his subject. If Ian doesn't have the time, I can look at it, though.
Attachment #373583 - Flags: review?(iann_bugzilla)

Updated

9 years ago
Status: NEW → ASSIGNED

Comment 26

9 years ago
Btw, Ricardo: As a localizer, what do you think about the size of the file? The reason I ask is that there used to be a lot of talk about the size of mail_help for some years ago (and other files as well, but mail_help is the largest iirc). I'm not saying that we should do anything about it here and I'm fine with adding more content to the file - but have you considered a new file?
(Assignee)

Comment 27

9 years ago
(In reply to comment #24)
> (From update of attachment 373583 [details] [diff] [review])
> We don't use the approval flag for review request :-)
> 
> Some hints regarding the process of getting your work in: :-)
> 
> When you feel your work is "ready" - ask for review by setting the review flag
> to "?" and fill in an e-mail address to the requestee (then the requestee gets
> an e-mail).


Actually, I hesitated for a second, but I decided to go with the approval because I saw it in your patch for bug 285325. Yeah, but I'm not you. :-)

Comment 28

9 years ago
The steps are as follows:
1. Request review->R+ granted
2. Request superreview->SR+ granted (depends on the patch/bug)
3a. If tree open -> checkin-needed -> checkin.
3b. If tree closed or locked down -> request approval -> approval+ granted
-> checkin-needed -> checkin.
(Assignee)

Comment 29

9 years ago
(In reply to comment #26)
> Btw, Ricardo: As a localizer, what do you think about the size of the file? The
> reason I ask is that there used to be a lot of talk about the size of mail_help
> for some years ago (and other files as well, but mail_help is the largest
> iirc).


Yes, mail_help.xhtml is the largest one (>200 KBytes). I think that the file
size is somewhat annoying for both developers and localizers. From the POV of a
localizer, the problem with a large help file size is (at least for Spanish)
that localized content is larger than en-US, so when the localizer is looking
at the diff and the line number, he has to move forward in the localized file
until he finds the corresponding line for the diff section.

If the patch happens to show a <h2 id="blahblahblah"> tag, it is easier to go
to the exact point by searching for '"blahblahblah"'; otherwise, I have found
myself opening the original en-US file to move backwards until finding an ID
that I can find in the localized that ID. In mail_help.xhtml, the corresponding
line in es-ES for an en-US line can be as far as 400 rows forward. :-)

If the file is smaller, it is easier to locate the corresponding line, because
there is less hay to look for the needle. :-)


> I'm not saying that we should do anything about it here and I'm fine
> with adding more content to the file - but have you considered a new file?


I didn't because I felt that it would look weird. IMHO, the mail_help.xhtml
chunking should be done in a separate bug, and for localizers health, while no
other changes take place in the whole help content system, since it would
involve many changes to RDFs, which are harder to manage.

Although now that I'm messing with the original en-US files, I must say that it
can be so complex for a developer as for a localizer. :-)

There is an open bug for splitting mail_help.xhtml, bug 246405. It has some
interesting ideas, but I would postpone it until the other pending changes for
SM 2.0 are done.
(Reporter)

Comment 30

9 years ago
Comment on attachment 373583 [details] [diff] [review]
First full patch draft

>diff --git a/suite/locales/en-US/chrome/common/help/glossary.xhtml b/suite/locales/en-US/chrome/common/help/glossary.xhtml
>+<dt id="feed">feed</dt><dd>A frequently updated source of references to web
>+  pages, usually blog articles or news. Technically is an XML document
"Technically it is..."
>+  available through a public well-known URL, comprising several items inside,
"comprising of several..."
>+  each one containing some metadata (possibly including a summary) and an URL
>+  to the full blog or news article. The XML document is regenerated at fixed
>+  intervals, or whenever a new article is published in the website. Web
"...published to the website."

>diff --git a/suite/locales/en-US/chrome/common/help/mail_help.xhtml b/suite/locales/en-US/chrome/common/help/mail_help.xhtml
>@@ -85,29 +89,30 @@
>-<p>To set up a mail or newsgroup account, first open the Window menu and choose
>-  Mail &amp; Newsgroups. If you haven&apos;t already set up an account, the
>-  Account Wizard appears automatically, enabling you to set up an account.</p>
>+<p>To set up a mail, newsgroup or blog feeds account, first open the Window
Note: elsewhere you have blogs and news feeds account.

> <p>If an account already exists, the Account Wizard doesn&apos;t appear
>   automatically when the Mail window opens. Instead, after opening the Mail
>   window, open the File menu and choose New, then Account. For more details,
>   see <a href="#setting_up_additional_mail_and_news_accounts">Setting Up
>-  Additional Mail &amp; News Accounts</a>.</p>
>+  Additional Mail, News &amp; Blog Feeds Accounts</a>.</p>
Note: elsewhere you have blogs and news feeds accounts.

>@@ -122,33 +127,36 @@

>   <li><strong>Identity</strong>: Enter the name and email address appropriate
>-    for this account, then click the right arrow.</li>
>-  <li><strong>Server Information</strong>:
>+    for this account, then click the right arrow. This window is not available
>+    for Blogs &amp; News Feeds account type.</li>
Should there be "a" or "the" between "for" and "Blogs"
>+  <li><strong>Server Information</strong>: This window is not available for
>+    for Blogs &amp; News Feeds account type.
Should there be "a" or "the" between "for" and "Blogs"

>@@ -163,17 +171,18 @@

>   <li><strong>User Names</strong>: Enter the incoming and outgoing user names
>-    provided by your ISP or email provider, then click the right arrow.</li>
>+    provided by your ISP or email provider, then click the right arrow. This
>+    window is not available for Blogs &amp; News Feeds account type.</li>
Should there be "a" or "the" between "for" and "Blogs"

>@@ -204,29 +213,32 @@

>+        
>+        <p><strong>Note:</strong> You can't set as default a blogs &amp; news
>+          feeds account.</p>
"You can't set a blogs &amp; news feeds account as default."

>@@ -2990,16 +3019,249 @@ to filter unwanted mail, and how phishin

>+<h2 id="subscribing_to_blogs_and_news_feeds">Subscribing to blogs &amp; news
>+  feeds</h2>
>+
>+<p>If you have set up a
>+  <a href="#setting_up_additional_mail_and_news_accounts">Blogs &amp; News
>+  account</a>, you can subscribe to Blogs &amp; News feeds.</p>
>+
>+<p>To subscribe to a feed, begin from the Mail window:</p>
>+
>+<ol>
>+  <li>In the accounts pane, click your desired Blogs &amp; News Feeds account
>+    to manage, or a feed inside it.</li>
>+  <li>Open the File menu and choose Subscribe. You see the RSS Subscriptions
>+    dialog box.</li>
>+  <li>Click the Add button. The Feed properties dialog will appear.</li>
>+  <li>Type the feed URL in the Feed URL field.</li>
Or copy and paste?

>+  <li>Click the Store articles in dropdown list and choose the item list where
>+    you want the articles to be stored. This allows you to merge multiple feeds
>+    in one list item.</li>
>+  <li>Set the Show the article summary instead of loading the web page flag to
>+    display a brief summary that blog feeds usually include for each article.
>+    
>+    <p><strong>Tip:</strong> Showing the article summary reduces the bandwidth
>+      traffic and is faster, since the summary is already downloaded when the
>+      feed is checked for new items. However, if you usually are interested in
>+      the full article, you will save time by unchecking this option.</p>
>+  </li>
>+  <li>Click OK to confirm the feed addition.</li>
>+</ol>
Where checkboxes are being refereed to it is usual to put the associated text in double quotes. This is throughout the new section...

>+<h2 id="removing_a_feed">Removing a feed</h2>
>+
>+<p>If you no longer want to follow one of the feeds in your blogs &amp; news
>+  account, you can remove it.</p>
>+
>+<p>To remove a feed in your selected blogs &amp; news account, begin from the
>+  Mail window:</p>
>+
>+<ol>
>+  <li>In the accounts pane, click your desired Blogs &amp; News account to
>+    manage, or a feed inside it.</li>
>+  <li>Open the File menu and choose Subscribe. You see the RSS Subscription
>+    dialog box.</li>
>+  <li>Click on a feed in the feed list. You may need to expand the folders in
>+    the feed list to see each individual feed.</li>
>+  <li>Click the Remove button. You will be asked to confirm the deletion of the
>+    feed.</li>
>+</ol>
It might be worth noting that previously downloaded articles/items are still available until you delete the actual blogs and news feeds account. Do some testing to see exact behaviour.
>+
>+<p>[<a href="#getting_started_with_blogs">Return to beginning of
>+  section</a>]</p>
>+
>+<h2 id="using_different_blogs_and_news_feeds_accounts">Using different blogs
>+  &amp; news feeds accounts</h2>
>+
>+<p>A single blogs &amp; news feeds account can contain any number of feeds in
>+  it, so you don't strictly need more than a blogs &amp; news feeds account.
"..more than one blogs..."

>+  However, you may want to create several blogs &amp; news feeds accounts.
>+  Some reasons to do that are:</p>
>+
>+<ul>
>+  <li>You can use different accounts to categorize your feeds. For example, you
>+    can create an account named <q>Mozilla News</q> to put in it all your
>+    feeds related to Mozilla, and another one named <q>Today Headlines</q> to
>+    put in it all your feeds with general news.</li>
>+  <li>If you have several accounts, each one can have different settings. This
>+    way, you can choose, for example, different time intervals for each account
>+    (and, therefore, their feeds.)</li>
>+</ul>
>+
>+<p>[<a href="#getting_started_with_blogs">Return to beginning of
>+  section</a>]</p>
>+
Might be worth adding some information about organising feeds, drag and dropping between accounts, etc. Again do some testing to get exact behaviour.

>@@ -3506,29 +3768,57 @@ to filter unwanted mail, and how phishin

>+      <li><strong>Manage Subscriptions...</strong>: Shows the RSS Subscriptions
>+        dialog, that allows you to add, edit and remove feeds to this blogs
>+        &amp; news feeds account.</li>
"...add, edit, organize and remove feeds..." or something similar.

A good start but still some more to add so r-, thanks for your work so far though.
Attachment #373583 - Flags: review?(iann_bugzilla) → review-
(Assignee)

Comment 31

9 years ago
(In reply to comment #30)

Thank you for the review, and sorry for not showing up these days. I've fixed everything but these:


> >diff --git a/suite/locales/en-US/chrome/common/help/mail_help.xhtml b/suite/locales/en-US/chrome/common/help/mail_help.xhtml
> >+<h2 id="removing_a_feed">Removing a feed</h2>
> >+
> >+<p>If you no longer want to follow one of the feeds in your blogs &amp; news
> >+  account, you can remove it.</p>
> >+
> >+<p>To remove a feed in your selected blogs &amp; news account, begin from the
> >+  Mail window:</p>
> >+
> >+<ol>
> >+  <li>In the accounts pane, click your desired Blogs &amp; News account to
> >+    manage, or a feed inside it.</li>
> >+  <li>Open the File menu and choose Subscribe. You see the RSS Subscription
> >+    dialog box.</li>
> >+  <li>Click on a feed in the feed list. You may need to expand the folders in
> >+    the feed list to see each individual feed.</li>
> >+  <li>Click the Remove button. You will be asked to confirm the deletion of the
> >+    feed.</li>
> >+</ol>
> It might be worth noting that previously downloaded articles/items are still
> available until you delete the actual blogs and news feeds account. Do some
> testing to see exact behaviour.


OK, I've been testing that, but I'd say that articles are available until you delete the folder (or the whole B&N account, of course). Is that OK or am I missing something?


> >+  However, you may want to create several blogs &amp; news feeds accounts.
> >+  Some reasons to do that are:</p>
> >+
> >+<ul>
> >+  <li>You can use different accounts to categorize your feeds. For example, you
> >+    can create an account named <q>Mozilla News</q> to put in it all your
> >+    feeds related to Mozilla, and another one named <q>Today Headlines</q> to
> >+    put in it all your feeds with general news.</li>
> >+  <li>If you have several accounts, each one can have different settings. This
> >+    way, you can choose, for example, different time intervals for each account
> >+    (and, therefore, their feeds.)</li>
> >+</ul>
> >+
> >+<p>[<a href="#getting_started_with_blogs">Return to beginning of
> >+  section</a>]</p>
> >+
> Might be worth adding some information about organising feeds, drag and
> dropping between accounts, etc. Again do some testing to get exact behaviour.


I've just downloaded a Linux nightly and done some testing, and I don't see any way to drag and drop *feeds* between B&N accounts; when you drag and drop, you're doing it just with the folder.

And, BTW, I've also been unable to choose which B&N account I want to put a feed when I'm subscribing to it from the browser component. I'm going to search for a existing bug on it.
(Reporter)

Comment 32

9 years ago
(In reply to comment #31)
> (In reply to comment #30)
> 
> > Might be worth adding some information about organising feeds, drag and
> > dropping between accounts, etc. Again do some testing to get exact behaviour.
> 
> 
> I've just downloaded a Linux nightly and done some testing, and I don't see any
> way to drag and drop *feeds* between B&N accounts; when you drag and drop,
> you're doing it just with the folder.
> 
You can drag and drop feeds within the subscribe window for each account as well as drag and drop of feed folders within the 3-pane window.

> And, BTW, I've also been unable to choose which B&N account I want to put a
> feed when I'm subscribing to it from the browser component. I'm going to search
> for a existing bug on it.
It is an issue I am aware of but not sure if there is a bug for it.
(Assignee)

Comment 33

9 years ago
Created attachment 375416 [details] [diff] [review]
Second, more complete, full patch

Second patch. Addressed comments on the first full patch, added a section "Organizing your feeds", and (hopefully!) merged recent changes in mail_help.xhtml.
Attachment #373583 - Attachment is obsolete: true
(Assignee)

Updated

9 years ago
Attachment #375416 - Flags: review?(iann_bugzilla)
(Assignee)

Comment 34

9 years ago
(In reply to comment #33)
> Created an attachment (id=375416) [details]
> Second, more complete, full patch
> 
> Second patch. Addressed comments on the first full patch, added a section
> "Organizing your feeds", and (hopefully!) merged recent changes in
> mail_help.xhtml.


Tsk, tsk... Please, forget this for some minutes. I've realized that today's build allows to drag and drop feeds inside RSS Subscription window (last week didn't). I'm going to correct the text in mail_help.xhtml and provide a new patch.
(Assignee)

Comment 35

9 years ago
Created attachment 375420 [details] [diff] [review]
Third, more complete and hopefully correct full patch
Attachment #375416 - Attachment is obsolete: true
Attachment #375416 - Flags: review?(iann_bugzilla)
(Assignee)

Updated

9 years ago
Attachment #375420 - Flags: review?(iann_bugzilla)

Comment 36

9 years ago
+<dt id="rss">RSS (Really Simple Syndication)</dt><dd>An XML data format for web
+  <a href="#feed">feeds</a>. Actually, RSS is a set of several formats, of
+  which the most current, RSS 2.0, is the most standardized and complete.</dd>

(no need to change anything because of my comments)

Might want to linkify XML. Hmm, we'll probably forget to update this when RSS 2.0 is obsolete... So maybe we shouldn't mention anything about which is the most current format.
(Assignee)

Comment 37

9 years ago
(In reply to comment #36)
> (no need to change anything because of my comments)
> 
> Might want to linkify XML. Hmm, we'll probably forget to update this when RSS
> 2.0 is obsolete... So maybe we shouldn't mention anything about which is the
> most current format.


Both things are sensible. What about something like this?


<dt id="rss">RSS (Really Simple Syndication)</dt><dd>An <a href="#xml">XML</a>
  data format for web <a href="#feed">feeds</a>. Actually, RSS is a set of
  several formats, with different internal structures.</dd>

Comment 38

9 years ago
(In reply to comment #37)
> (In reply to comment #36)
> > (no need to change anything because of my comments)
> > 
> > Might want to linkify XML. Hmm, we'll probably forget to update this when RSS
> > 2.0 is obsolete... So maybe we shouldn't mention anything about which is the
> > most current format.
> 
> 
> Both things are sensible. What about something like this?
> 
> 
> <dt id="rss">RSS (Really Simple Syndication)</dt><dd>An <a href="#xml">XML</a>
>   data format for web <a href="#feed">feeds</a>. Actually, RSS is a set of
>   several formats, with different internal structures.</dd>

I think the key thing here is that it's XML, so I'd skip the last sentence, because it might raise questions (what formats? what does it mean with "different internal structures").
(Assignee)

Comment 39

9 years ago
Created attachment 375482 [details] [diff] [review]
Fourth try :-)

OK, this time I don't want to invent anything else. :-)
Attachment #375420 - Attachment is obsolete: true
Attachment #375482 - Flags: review?(iann_bugzilla)
Attachment #375420 - Flags: review?(iann_bugzilla)
(In reply to comment #39)
> Created an attachment (id=375482) [details]

> +        <rdf:li> <rdf:Description ID="mail-doc-blogs" nc:name="Getting Started With Blogs &amp; News Feds" nc:link="mail_help.xhtml#getting_started_with_blogs_and_news_feeds" /> </rdf:li>

Beware of News Feds! :-)

This just caught my eye, no need to post another patch before getting a real review. You may already replace the ' occurrences by &apos; and consistently use Blogs &amp; News Feeds, though (sometimes News is missing, sometimes Feeds).
(Assignee)

Comment 41

9 years ago
Created attachment 376318 [details]
Diff with corrections between patch in attachment 375482 [details] [diff] [review] and current status

I have corrected several inconsistencies in Blogs &amp; News Feeds accounts spelling, and replaced "'" by &apos;.

Note, however, that:

1) Current patch must updated to reflect recent changes in comm-central, I'm afraid. :-(
2) There are many more "'" occurrences not made by me still present in files included in my patch.
(Assignee)

Comment 42

9 years ago
(In reply to comment #41)
> Created an attachment (id=376318) [details]
> Diff with corrections between patch in attachment 375482 [details] [diff] [review] and current status


Just to be sure: who's waiting for whom here? :-) Am I expected to provide the latest full patch?
(Reporter)

Comment 43

9 years ago
(In reply to comment #42)
> (In reply to comment #41)
> > Created an attachment (id=376318) [details] [details]
> > Diff with corrections between patch in attachment 375482 [details] [diff] [review] [details] and current status
> 
> 
> Just to be sure: who's waiting for whom here? :-) Am I expected to provide the
> latest full patch?

Probably best to generate a full patch, just as a note make sure your changes for "'" don't cause lines to be longer than 80 characters.
(Assignee)

Comment 44

9 years ago
Created attachment 378137 [details] [diff] [review]
Full patch to add Blogs & News Feeds account information to help
Attachment #375482 - Attachment is obsolete: true
Attachment #375482 - Flags: review?(iann_bugzilla)
(Assignee)

Updated

9 years ago
Attachment #378137 - Flags: review?(iann_bugzilla)
(Assignee)

Comment 45

9 years ago
(In reply to comment #43)
> Probably best to generate a full patch, just as a note make sure your changes
> for "'" don't cause lines to be longer than 80 characters.


There it is. Yes, I took into account the right margin, and I've checked that changes in the mainstream repository are indeed merged into my local copy files.
(Assignee)

Comment 46

9 years ago
(In reply to comment #43)
> Probably best to generate a full patch, just as a note make sure your changes
> for "'" don't cause lines to be longer than 80 characters.


Can anyone comment on the new full patch? :-)
(Reporter)

Updated

9 years ago
Attachment #378137 - Flags: review?(iann_bugzilla) → review-
(Reporter)

Comment 47

9 years ago
Comment on attachment 378137 [details] [diff] [review]
Full patch to add Blogs & News Feeds account information to help

>+++ b/suite/locales/en-US/chrome/common/help/mail_help.xhtml
>@@ -281,20 +293,22 @@
>+      <li><strong>Disk Space (POP and blogs &amp; news feeds accounts
>+        only)</strong>: This setting determines the maximum size of messages
>+        that you are willing to download to your hard disk. For more
>+        information, see <a href="#disk_space_settings_pop">Disk Space Settings
>+        (POP)</a> or <a href="#disk_space_settings_blog">Disk Space Settings
>+        (Blogs)</a>.</li>
This is not quite correct, there is nothing to do with maximum size of messages in News & Blogs, so you will probably have to generalise this text a bit more. Perhaps something like - "These settings help you manage the amount of disk space that downloaded messages take up on your hard disk."

>@@ -330,16 +344,25 @@
>+<p>For news accounts, expanding the account newsgroups list will automatically
>+  check for new items, as it will just selecting one of the newsgroups. While
Missing a word I think "...as it will by just selecting..."

>+  reading a newsgroup, you can force checking for new items by clicking Get
>+  Msgs.</p>

>@@ -3001,16 +3030,348 @@ to filter unwanted mail, and how phishin

>+<h2 id="subscribing_to_blogs_and_news_feeds">Subscribing to blogs &amp; news
>+  feeds</h2>
>+
>+<p>If you have set up a
>+  <a href="#setting_up_additional_mail_and_news_accounts">Blogs &amp; News
>+  account</a>, you can subscribe to Blogs &amp; News feeds.</p>
>+
>+<p>To subscribe to a feed, begin from the Mail window:</p>
>+
>+<ol>
>+  <li>In the accounts pane, click your desired Blogs &amp; News Feeds account
>+    to manage, or a feed inside it.</li>
>+  <li>Open the File menu and choose Subscribe. You see the RSS Subscriptions
>+    dialog box.</li>
>+  <li>Click the Add button. The Feed properties dialog will appear.</li>
>+  <li>Type (or copy and paste) the feed URL in the Feed URL field.</li>
"into" rather than "in"

>+<h2 id="reading_blogs_and_news_feed_messages">Reading blogs &amp; news feeds
>+  messages</h2>
>+
Is it worth mentioning/referencing the View->"Feed Message Body As" options here?

>+<h2 id="exporting_and_importing_feeds">Exporting and importing feeds</h2>
>+
>+<p>If you have set up a
>+  <a href="#setting_up_additional_mail_and_news_accounts">Blogs &amp; News
>+  account</a>, you can export or import Blogs &amp; News feed collections using
>+  the OPML format (Outline Processor Markup Language).</p>
>+
>+<p>To export the feeds in your selected blogs &amp; news account, begin from
>+  the Mail window:</p>
>+
>+<ol>
>+  <li>In the accounts pane, click your desired Blogs &amp; News account to
>+    manage, or a feed inside it.</li>
>+  <li>Open the File menu and choose Subscribe. You see the RSS Subscription
>+    dialog box.</li>
Do you mention elsewhere all the various ways to get into the Feed Subscriptions dialog? File menu, context menu, Account Central, Mail & Newsgroups Account Settings, etc. 

>+<h3 id="feeds_vs_folders">Feeds versus folders</h3>
>+
>+<p>Blogs &amp; News Feeds accounts are organized through two main concepts:
>+  <strong>feeds</strong> and <strong>folders</strong>.</p>
>+  
>+<ul>
>+  <li><strong>Feeds</strong> are sources for articles/posts. They provide
>+    the mean to get new articles from blogs. You subscribe to feeds.</li>
"means" rather than "mean"

>+  <li><strong>Folders</strong> in Blogs &amp; News Feeds accounts work pretty
>+    much like in any other account type. Folders store articles/posts you got
>+    through the feeds.</li>
>+</ul>
>+
>+<p>You use the RSS Subscription dialog to tell &brandShortName; which feed
"Feed Subscription" you mean?

>+<h3 id="downloading_multiple_feeds_in_a_single_folder">Downloading multiple
>+  feeds in a single folder</h3>
>+
>+<p>You may want to use a single folder to store articles/items coming from
>+  more than one feed. To do this, you just need to add additional feeds in
>+  that folder. Begin from the Mail window:</p>
>+
>+<ol>
>+  <li>In the accounts pane, click your desired Blogs &amp; News Feeds account
>+    to manage, or a feed inside it.</li>
>+  <li>Open the File menu and choose Subscribe. You see the RSS Subscriptions
"Feed Subscriptions" again.

>+    dialog box.</li>
>+  <li>Click in the desired folder, then click the Add button. The Feed
>+    properties dialog will appear.</li>
>+  <li>Type (or copy and paste) the feed URL in the Feed URL field.</li>
>+  <li>Click OK to confirm the feed addition.</li>
>+</ol>
>+
>+<p>[<a href="#organizing_your_feeds">Return to beginning of section</a>]</p>
>+
>+<h3 id="moving_a_feed_to_another_folder">Moving a feed to another folder</h3>
>+
>+<p>You can move a feed from a folder to another one using any of these
>+  methods:</p>
>+
>+<ul>
>+  <li>Drag &amp; drop a feed while inside the RSS Subscription window.</li>
"Feed Subscriptions" again.

>@@ -3517,33 +3878,61 @@ to filter unwanted mail, and how phishin
>+  <li>For Blogs &amp; News Feeds accounts:
>+    <ul>
>+      <li><strong>Check for new articles at startup</strong>: Select this
>+        checkbox if you want to check this account automatically for new blogs
>+        &amp; news messages whenever you start Mail &amp; Newsgroups.</li>
>+      <li><strong>Check for new articles every [__] minutes</strong>: Select
>+        this checkbox if you want to specify the number of minutes between feed
>+        checks. You can also check for new blogs &amp; news messages at any time
>+        by clicking Get Msgs in the Mail window.</li>
>+      <li><strong>By default, show the article summary instead of loading the
>+        web page</strong>: Select this checkbox if you want &brandShortName;
>+        to display a brief summary of the article (bundled inside the RSS
Do we really need "RSS" here?

>+        feed) instead of loading the full web page. Showing the article summary
>+        is slightly faster than the full web page, but you may miss part of the
>+        article content.</li>

>@@ -4040,16 +4430,57 @@ to filter unwanted mail, and how phishin

>+<h3 id="disk_space_settings_blogs">Disk Space Settings (Blogs)</h3>
>+
>+<p>Messages from blogs &amp; news feeds accounts only are stored in your local
"are only" rather than "only are".

>+  machine in their short form, ie. the article summary, regardless if your
"of whether" rather than "if"

>+  settings are to show the full articles by default. Still, there are options
(Assignee)

Comment 48

9 years ago
Created attachment 381926 [details] [diff] [review]
Differences between old patch in attachment 378137 [details] [diff] [review] and new full patch version
Attachment #376318 - Attachment is obsolete: true
(Assignee)

Comment 49

9 years ago
Created attachment 381928 [details] [diff] [review]
New full patch to add Blogs & News Feeds account information to help

Full patch addressing commments in previous review
Attachment #378137 - Attachment is obsolete: true
Attachment #381928 - Flags: review?(iann_bugzilla)
(Assignee)

Comment 50

9 years ago
(In reply to comment #47)
> (From update of attachment 378137 [details] [diff] [review])
> >+<h2 id="reading_blogs_and_news_feed_messages">Reading blogs &amp; news feeds
> >+  messages</h2>
> >+
> Is it worth mentioning/referencing the View->"Feed Message Body As" options
> here?


Done. Isn't this a recent feature in nightlies?


> Do you mention elsewhere all the various ways to get into the Feed
> Subscriptions dialog? File menu, context menu, Account Central, Mail &
> Newsgroups Account Settings, etc.


Added inside the Subscribing to blogs & feeds section, at the very start of the Blogs & Feeds whole section/chapter.


> >+<h3 id="feeds_vs_folders">Feeds versus folders</h3>
> >+
> >+  <li><strong>Folders</strong> in Blogs &amp; News Feeds accounts work pretty
> >+    much like in any other account type. Folders store articles/posts you got
> >+    through the feeds.</li>
> >+</ul>
> >+
> >+<p>You use the RSS Subscription dialog to tell &brandShortName; which feed
> "Feed Subscription" you mean?


No, I meant "RSS Subscriptions", which was the dialog title when I wrote it. :-) I have changed all references now. Still, I thought we were on a mainly frozen feature with only minor changes; are there still many pending changes for blogs & news feeds feature?
(Reporter)

Updated

9 years ago
Attachment #381928 - Flags: review?(iann_bugzilla) → review+
(Reporter)

Comment 51

9 years ago
Comment on attachment 381928 [details] [diff] [review]
New full patch to add Blogs & News Feeds account information to help

>+      <li><strong>Disk Space (POP and blogs &amp; news feeds accounts
>+        only)</strong>: This setting help you manage the amount of disk
Nit: helps not help
>+        space that downloaded messages take up on your hard disk. For more
>+        information, see <a href="#disk_space_settings_pop">Disk Space Settings
>+        (POP)</a> or <a href="#disk_space_settings_blog">Disk Space Settings
>+        (Blogs)</a>.</li>

>+<p>To subscribe to a feed, begin from the Mail window:</p>
>+
>+<ol>
>+  <li>Get into the Feed Subscriptions dialog. There are several ways to do
>+    this, all of them from the Mail window:
You've only just mentioned the Mail window in the previous sentence.

>+    <ul>
>+      <li>In the accounts pane, click your desired Blogs &amp; News Feeds
>+        account to manage, then click in the Manage Subscriptions in the right
>+        pane.</li>
>+      <li>In the accounts pane, click your desired Blogs &amp; News Feeds
>+        account to manage, or a feed inside it, then open the File menu and
>+        choose Subscribe.</li>
>+      <li>In the accounts pane, <strong>right click</strong> your desired Blogs
>+        &amp; News Feeds account to manage and choose Subscribe...</li>
>+      <li>Open the Edit menu and select the Mail &amp; Newsgroups Account
>+        Settings option. In the Mail &amp; Newsgroups Account Settings dialog,
>+        click on a Blogs &amp; News Feeds account main section, and then
>+        click the Manage Subscriptions... button.</li>
>+    </ul>
>+  </li>
Is it worth trying to somehow link to the above from the other sections?

>+<p>While browsing the web using &brandShortName;, you may find the Feed
>+  discovery icon while visiting a web page
>+  <img src="chrome://navigator/skin/btn1/feeds.png"
>+  class="feedMenu" alt="RSS feed discovery icon"/>. You can click on it to see
This alt text probably needs to have RSS removed from it.

>+  a list of available feeds and choose one to get it added to your first Blogs
>+  &amp; News Feeds account.</p>


>+<h3 id="disk_space_settings_blogs">Disk Space Settings (Blogs)</h3>
>+
>+<p>Messages from blogs &amp; news feeds accounts are only stored in your local
>+  machine in their short form, ie. the article summary, regardless of wether
Nit: whether not wether.

>+  your settings are to show the full articles by default. Still, there are
>+  options to control how much disk space is used by your blogs &amp; news feeds
>+  account. If you are not already viewing the Disk Space preferences for a
>+  blogs &amp; news feeds account, follow these steps:</p>

r=me with those issues addressed/answered.
(Assignee)

Comment 52

9 years ago
Created attachment 383025 [details] [diff] [review]
Revised  patch addressing/fixing comments and merging with latest changes in mail_help.xhtml and help-index1.rdf

Requesting new review, since some involved files have been updated in the mainstream repository and I have needed to manually merge some paragraphs.
Attachment #381928 - Attachment is obsolete: true
Attachment #383025 - Flags: review?(iann_bugzilla)
(Reporter)

Updated

9 years ago
Attachment #383025 - Flags: review?(iann_bugzilla) → review+
(Reporter)

Comment 53

9 years ago
Comment on attachment 383025 [details] [diff] [review]
Revised  patch addressing/fixing comments and merging with latest changes in mail_help.xhtml and help-index1.rdf

Is it worth linking in the section about how to open the feed subscription dialog into the index? (and maybe the contents of the new section). If so the wording might have to be tweaked to make sense in that context.

r=me either way.
(Assignee)

Comment 54

9 years ago
(In reply to comment #53)
> (From update of attachment 383025 [details] [diff] [review])
> Is it worth linking in the section about how to open the feed subscription
> dialog into the index? (and maybe the contents of the new section). If so the
> wording might have to be tweaked to make sense in that context.


I may be unispired, but I fail to see a good way to separate the explanation about getting into the feeds subscription dialog to its own section without breaking the continuity of the "Subscribing to blogs & news feeds" section.


> r=me either way.


I don't have permission to commit to comm-central. Anyway, I'm afraid I forgot to ask/solve a problem with the Feed icon (see comment #16). The problem I'm facing is that bringing the image with a <img src="chrome://..." /> doesn't work (nothing is displayed, because of security restrictions), and I don't know how to take advantage of navigator.css feed rules to display the image in a similar way as it is done with smileys.css (the rules are not exactly the same; smileys.css use content: url(...), while navigator.css uses list-style-image: and -moz-region-image). I must add that smileys do show up in a SM 2.0 browser window.

So, should I blindly trust to apply a style="clip: rect(0px 32px 16px 16px);" and hope to do it right?

Comment 55

9 years ago
Ricardo, you'd probably use "list-style-image" and "-moz-region-image" in the context of XUL elements only (e.g., icons on a toolbar). Since the help XHTML more has the nature of real content, I'd try something like:

  span.moz-feeds:before {
    content: url("chrome://navigator/skin/btn1/feeds.png");
    clip: rect(0px 32px 16px 16px);
  }

and define span.moz-feeds similar to the smileys.css definitions as an empty span, which you can then address with <span class="moz-feeds"/> in the text.

(In reply to comment #52)
> Requesting new review, since some involved files have been updated in the
> mainstream repository and I have needed to manually merge some paragraphs.

That was apparently my patch from bug 474525, sorry for the extra work. Just
as a heads-up, bug 326584 would change the retention-policy labels for those options and hide "Always delete unread messages" by default. If your patch checks in first, I'll add the RSS-label changes to my patch, otherwise I'll let you know which lines need to be adjusted. I'm adding a couple of dependencies.
Blocks: 459580
Depends on: 326584

Comment 56

9 years ago
Comment on attachment 383025 [details] [diff] [review]
Revised  patch addressing/fixing comments and merging with latest changes in mail_help.xhtml and help-index1.rdf

I found a few nits in the current patch:

> mail_help.xhtml @@ -3085,21 +3482,24 @@ 
>    <li>Check the box labeled <q>Keep messages for this account on this
>      computer</q>.</li>
>    <li>Click OK.</li>
> +  <li>In the folder pane, under the name of the account you want to use
> +    offline, click any folder other than the Inbox. For example, click the Sent
> +    or the Drafts folder. Then click the Inbox folder to start downloading its
> +    messages.</li>

I thought this was no longer necessary and therefore removed it in bug 474525, but leave it in if you known that it's still needed.

>    <li>Once downloading is complete, click the Online/Offline indicator
>      <img src="images/online.png" alt=""/> in the lower right corner of the
>      Mail window (to the left of the Cookie icon) to go offline.</li>
>  </ol>
> -
>  <p><strong>Note</strong>: This setting also applies to any new folders
>    created. While the per-account setting can be overridden for an

Are the white-space changes (here and some other locations) on purpose?

> suite-toc.rdf @@ -448,19 +481,20 @@ 
>  
>  <rdf:Description about="#mail-doc-offline-space">
>      <nc:subheadings>
>        <rdf:Seq>
> -        <rdf:li> <rdf:Description ID="mail_offline_imap" nc:name="IMAP"  nc:link="mail_help.xhtml#synchronization_and_storage_settings_imap"/> </rdf:li>
> -        <rdf:li> <rdf:Description ID="mail_offline_pop3" nc:name="POP"  nc:link="mail_help.xhtml#disk_space_settings"/> </rdf:li>
> -        <rdf:li> <rdf:Description ID="mail_offline_nntp" nc:name="News"  nc:link="mail_help.xhtml#synchronization_and_storage_settings_nntp"/> </rdf:li>
> +        <rdf:li> <rdf:Description ID="mail_offline_imap" nc:name="IMAP"  nc:link="mail_help.xhtml#offline_and_disk_space_settings_imap"/> </rdf:li>
> +        <rdf:li> <rdf:Description ID="mail_offline_pop3" nc:name="POP"  nc:link="mail_help.xhtml#disk_space_settings_pop"/> </rdf:li>
> +        <rdf:li> <rdf:Description ID="mail_offline_blogs" nc:name="Blogs"  nc:link="mail_help.xhtml#disk_space_settings_blogs"/> </rdf:li>
> +        <rdf:li> <rdf:Description ID="mail_offline_nntp" nc:name="News"  nc:link="mail_help.xhtml#offline_and_disk_space_settings_nntp"/> </rdf:li>
>        </rdf:Seq>
>      </nc:subheadings>
>    </rdf:Description>

Please change IMAP/News links back to synchronization_and_storage_settings_* otherwise those won't work.

Comment 57

9 years ago
The patch for bug 326584 has just been checked in, here the related changes:

> mail_help.xhtml @@ -4058,16 +4488,57 @@
> -  <li><strong>Delete all but the last [____] messages</strong>: Select this
> +  <li><strong>Delete all but the most recent [____] messages</strong>: Select this

This label has been rephrased to better indicate time dependency.

> -  <li><strong>Always delete read messages</strong>: Check this option to
> -    automatically delete messages once they are read, regardless of its
> -    age.</li>

This checkbox is now hidden by default, therefore I have removed that part from the general help description (mail and news) of the retention settings. I would suggest to do the same for feeds to avoid confusion.

That should be all.

Comment 58

9 years ago
(In reply to comment #54)
> I don't have permission to commit to comm-central.

No problem: Once you have a patch with all reviews ready for checkin, just set "checkin-needed" in the Keywords heading of this bug, someone will take care of it within a couple of days.
(Assignee)

Comment 59

9 years ago
(In reply to comment #55)
> Ricardo, you'd probably use "list-style-image" and "-moz-region-image" in the
> context of XUL elements only (e.g., icons on a toolbar). Since the help XHTML
> more has the nature of real content, I'd try something like:
> 
>   span.moz-feeds:before {
>     content: url("chrome://navigator/skin/btn1/feeds.png");
>     clip: rect(0px 32px 16px 16px);
>   }
> 
> and define span.moz-feeds similar to the smileys.css definitions as an empty
> span, which you can then address with <span class="moz-feeds"/> in the text.


Thanks for the directions. Sadly, I don't get it to work yet. :-( Just a guess, could it be that chrome://navigator/... can't be accessed from a browser window whereas chrome://communicator/... can be? It sounds weird, but it would explain while smileys.css can be loaded while navigator.css don't:

<link rel="stylesheet" href="chrome://communicator/skin/smileys.css"
      type="text/css"/>
<link rel="stylesheet" href="chrome://navigator/skin/navigator.css"
      type="text/css"/>



> (In reply to comment #52)
> > Requesting new review, since some involved files have been updated in the
> > mainstream repository and I have needed to manually merge some paragraphs.
> 
> That was apparently my patch from bug 474525, sorry for the extra work.


No problem, this could happen with any other help-related bug, since mine touches also RDFs. :-)
(Assignee)

Comment 60

9 years ago
(In reply to comment #56)
> (From update of attachment 383025 [details] [diff] [review])
> I found a few nits in the current patch:
> 
> > mail_help.xhtml @@ -3085,21 +3482,24 @@ 
> >    <li>Check the box labeled <q>Keep messages for this account on this
> >      computer</q>.</li>
> >    <li>Click OK.</li>
> > +  <li>In the folder pane, under the name of the account you want to use
> > +    offline, click any folder other than the Inbox. For example, click the Sent
> > +    or the Drafts folder. Then click the Inbox folder to start downloading its
> > +    messages.</li>
> 
> I thought this was no longer necessary and therefore removed it in bug 474525,
> but leave it in if you known that it's still needed.


I've checked and it really seems that it is not needed, so I'm removing it, although... 


> >    <li>Once downloading is complete, click the Online/Offline indicator
> >      <img src="images/online.png" alt=""/> in the lower right corner of the
> >      Mail window (to the left of the Cookie icon) to go offline.</li>


...the correct sequence of events would require to change above step for something like:

  <li>Click the Online/Offline indicator
    <img src="images/online.png" alt=""/> in the lower right corner of the
    Mail window (to the left of the Cookie icon) to go offline. You will be
    asked to download messages for them to be available while offline. Click
    on "Download" to proceed.</li>



> >  </ol>
> > -
> >  <p><strong>Note</strong>: This setting also applies to any new folders
> >    created. While the per-account setting can be overridden for an
> 
> Are the white-space changes (here and some other locations) on purpose?


They are created by using Meld to merge diffs, usually while merging differences spreading just to the previous line where the blank line is removed by Meld. At least, I've been unable to keep them except by manually re-inserting them.


> > suite-toc.rdf @@ -448,19 +481,20 @@ 
> >  
> >  <rdf:Description about="#mail-doc-offline-space">
> >      <nc:subheadings>
> >        <rdf:Seq>
> > -        <rdf:li> <rdf:Description ID="mail_offline_imap" nc:name="IMAP"  nc:link="mail_help.xhtml#synchronization_and_storage_settings_imap"/> </rdf:li>
> > -        <rdf:li> <rdf:Description ID="mail_offline_pop3" nc:name="POP"  nc:link="mail_help.xhtml#disk_space_settings"/> </rdf:li>
> > -        <rdf:li> <rdf:Description ID="mail_offline_nntp" nc:name="News"  nc:link="mail_help.xhtml#synchronization_and_storage_settings_nntp"/> </rdf:li>
> > +        <rdf:li> <rdf:Description ID="mail_offline_imap" nc:name="IMAP"  nc:link="mail_help.xhtml#offline_and_disk_space_settings_imap"/> </rdf:li>
> > +        <rdf:li> <rdf:Description ID="mail_offline_pop3" nc:name="POP"  nc:link="mail_help.xhtml#disk_space_settings_pop"/> </rdf:li>
> > +        <rdf:li> <rdf:Description ID="mail_offline_blogs" nc:name="Blogs"  nc:link="mail_help.xhtml#disk_space_settings_blogs"/> </rdf:li>
> > +        <rdf:li> <rdf:Description ID="mail_offline_nntp" nc:name="News"  nc:link="mail_help.xhtml#offline_and_disk_space_settings_nntp"/> </rdf:li>
> >        </rdf:Seq>
> >      </nc:subheadings>
> >    </rdf:Description>
> 
> Please change IMAP/News links back to synchronization_and_storage_settings_*
> otherwise those won't work.


Sorry, I got somewhat confused, it seems. I've however keep the anchor for POP ("#disk_space_settings_pop") instead of the original ("disk_space_settings") to be consistent with the one for blogs ("#disk_space_settings_blogs").

Comment 61

9 years ago
(In reply to comment #59)
> could it be that chrome://navigator/... can't be accessed from a browser window
> whereas chrome://communicator/... can be? It sounds weird, but it would explain
> while smileys.css can be loaded while navigator.css don't:

Based on smileys.css, I've tried appending the following to navigator.css:

span.moz-feeds {
  display: inline-block;
  vertical-align: middle;
  -moz-user-select: all;
}

span.moz-feeds > span {
  display: none;
}

span.moz-feeds:before {
  content: url("chrome://navigator/skin/btn1/feeds.png");
  clip: rect(0px 32px 16px 16px);
}

This didn't show up anything for <span class="moz-feeds"/> despite having

> <link rel="stylesheet" href="chrome://navigator/skin/navigator.css"
>       type="text/css"/>

in mail_help.xhtml; however, appending the same to smileys.css showed indeed
up the feeds.png image. Thus, either your "chrome://" path is wrong or there is some restriction to access that style sheet (where on the other hand, getting feeds.png from a navigator-chrome URL works). The other problem is that neither "clip" nor "-moz-region-image" was applied, the image was always shown in full.

Thus, I think we need some help here from someone more familiar with the CSS rules for those chrome elements (Ian or Stefan?).


(In reply to comment #60)
> I've checked and it really seems that it is not needed, so I'm removing it,
> although... 
> 
> > >    <li>Once downloading is complete, click the Online/Offline indicator
> > >      <img src="images/online.png" alt=""/> in the lower right corner of the
> > >      Mail window (to the left of the Cookie icon) to go offline.</li>
> 
> ...the correct sequence of events would require to change above step for
> something like:
> 
>   <li>Click the Online/Offline indicator
>     <img src="images/online.png" alt=""/> in the lower right corner of the
>     Mail window (to the left of the Cookie icon) to go offline. You will be
>     asked to download messages for them to be available while offline. Click
>     on "Download" to proceed.</li>

I've only removed the first paragraph as I thought it did no longer apply, but didn't touch the second one, which is obviously confusing now. Thus, please go ahead and update it to make sense again.

> > > suite-toc.rdf @@ -448,19 +481,20 @@ 
> > Please change IMAP/News links back to synchronization_and_storage_settings_*
> > otherwise those won't work.
> 
> Sorry, I got somewhat confused, it seems. I've however keep the anchor for POP
> ("#disk_space_settings_pop") instead of the original ("disk_space_settings") to
> be consistent with the one for blogs ("#disk_space_settings_blogs").

That's fine, it's just that all links have to match their respective anchors.

Comment 62

9 years ago
> could it be that chrome://navigator/... can't be accessed from a browser window
> whereas chrome://communicator/... can be? It sounds weird, but it would explain
> while smileys.css can be loaded while navigator.css don't:

Yes. The communicator package has the contentaccessible=yes flag while the navigator package doesn't so browser content can't refer to files in navigator, only to files in communicator.

Comment 63

9 years ago
>   content: url("chrome://navigator/skin/btn1/feeds.png");

This part still works though, despite accessing "chrome://navigator/..." from
a communicator page, so that's a bit confusing.

Comment 64

9 years ago
(In reply to comment #17)
> IIRC, there's another stand-alone icon somewhere.

The only other one I found is chrome://communicator/skin/icons/feedIcon.png and would be in the correct location. However, it is 32x32 rather than 16x16, thus either go with the large size or some way would be needed to shrink it.
(Assignee)

Comment 65

9 years ago
(In reply to comment #61)
> (In reply to comment #59)
> 
> Based on smileys.css, I've tried appending the following to navigator.css:
> 
> span.moz-feeds {
>   display: inline-block;
>   vertical-align: middle;
>   -moz-user-select: all;
> }
> 
> span.moz-feeds > span {
>   display: none;
> }
> 
> span.moz-feeds:before {
>   content: url("chrome://navigator/skin/btn1/feeds.png");
>   clip: rect(0px 32px 16px 16px);
> }


I've copied that into a <style type="text/css"> tag into the <head> section, furthermore adding

span.moz-feeds:before {
  -moz-image-region: rect(0px 32px 16px 16px);
}

and put mail_help.xhtml into en-US.jar.

And the image shows up in SeaMonkey help viewer, :-) but I've been unable to get the clip to work, too. :-(

> (In reply to comment #60)
> > > >    <li>Once downloading is complete, click the Online/Offline indicator
> > > >      <img src="images/online.png" alt=""/> in the lower right corner of the
> > > >      Mail window (to the left of the Cookie icon) to go offline.</li>
> > 
> > ...the correct sequence of events would require to change above step for
> > something like:
> > 
> >   <li>Click the Online/Offline indicator
> >     <img src="images/online.png" alt=""/> in the lower right corner of the
> >     Mail window (to the left of the Cookie icon) to go offline. You will be
> >     asked to download messages for them to be available while offline. Click
> >     on "Download" to proceed.</li>
> 
> I've only removed the first paragraph as I thought it did no longer apply, but
> didn't touch the second one, which is obviously confusing now. Thus, please go
> ahead and update it to make sense again.


Updated. I've also fixed a missing parenthesis here:

http://hg.mozilla.org/comm-central/rev/c64d9a572e6e#l1.365

(In reply to comment #64)
> (In reply to comment #17)
> > IIRC, there's another stand-alone icon somewhere.
> 
> The only other one I found is chrome://communicator/skin/icons/feedIcon.png
> and would be in the correct location. However, it is 32x32 rather than
> 16x16, thus either go with the large size or some way would be needed to
> shrink it.


Oh, nice! I've tried with this:

<img src="chrome://communicator/skin/icons/feedIcon.png" width="16px" height="16px" />

and it displays good enough, I'd say. So I'm going to go with it.

Thanks a lot for all your help.

Comment 66

9 years ago
You are welcome, and thanks back for the corrections to my patch. :-)

> And the image shows up in SeaMonkey help viewer, :-) but I've been unable to
> get the clip to work, too. :-(

That was the same experience I had too, must be some other way to do that.

> <img src="chrome://communicator/skin/icons/feedIcon.png" width="16px"
> height="16px" />

I had tried that with setting this URL in the "content:" field, and then specifying "width:" and "height:" within the same CSS entry, but it didn't
work this way either. Thus, reformatting or cropping the image within such
a construct is either not possible or needs some other trick.
(Assignee)

Comment 67

9 years ago
(In reply to comment #66)
> > <img src="chrome://communicator/skin/icons/feedIcon.png" width="16px"
> > height="16px" />
> 
> I had tried that with setting this URL in the "content:" field, and then
> specifying "width:" and "height:" within the same CSS entry, but it didn't
> work this way either. Thus, reformatting or cropping the image within such
> a construct is either not possible or needs some other trick.

It works for me inside the help viewer, but not with CSS style rules, just "style: width: 16px; height: 16px;" in the <img /> tag.

Comment 68

9 years ago
Yepp, works like a charm with <img> and the full path name but not with <span> linked through the CSS entry...

Nevertheless, hope that will work for Ian and Stefan and your patch can go in.

BTW: There is still "online.png" which should probably be taken from the theme
as well, thus some follow-up bug identifying and cleaning up these cases might
be good to have (if it doesn't exist yet).
(Assignee)

Comment 69

9 years ago
Created attachment 384508 [details] [diff] [review]
New iteration of patch to document blogs

This patch solves the feed icon display issue, and includes minor fixes to other, non-related to blogs, parts of mail_help.xhtml (see @@ -3085,19 +3479,20 and @@ -4128,17 +4592,17).
Attachment #381926 - Attachment is obsolete: true
Attachment #383025 - Attachment is obsolete: true
Attachment #384508 - Flags: review?(iann_bugzilla)
(Assignee)

Comment 70

9 years ago
(In reply to comment #68)
> Yepp, works like a charm with <img> and the full path name but not with <span>
> linked through the CSS entry...
> 
> Nevertheless, hope that will work for Ian and Stefan and your patch can go in.


Yep, I know this is not the best solution, but I can't find a better one. :-)


> BTW: There is still "online.png" which should probably be taken from the theme
> as well, thus some follow-up bug identifying and cleaning up these cases might
> be good to have (if it doesn't exist yet).


I'll search if I can find one and, if not, I'll file one.

Comment 71

9 years ago
Still a broken link in attachment 384508 [details] [diff] [review] though, at the very end:

> suite-toc.rdf @@ -449,18 +482,19 @@
> <rdf:Description ID="mail_offline_nntp" nc:name="News" nc:link="mail_help.xhtml#ynchronization_and_storage_settings_nntp"/>

Should be "mail_help.xhtml#synchronization_and_storage_settings_nntp"
(Assignee)

Comment 72

9 years ago
Created attachment 384650 [details] [diff] [review]
Link fixed in suite-toc.rdf

Sorry, hope this time is fine. :-)
Attachment #384508 - Attachment is obsolete: true
Attachment #384650 - Flags: review?(iann_bugzilla)
Attachment #384508 - Flags: review?(iann_bugzilla)
(Reporter)

Updated

9 years ago
Attachment #384650 - Flags: review?(iann_bugzilla) → review+
(Reporter)

Comment 73

9 years ago
Comment on attachment 384650 [details] [diff] [review]
Link fixed in suite-toc.rdf

Seems fine, there should be valid alt="description of image" for all <img> tags you adding (for accessibility purposes), but doing the other ones you are not touching is outside of scope of this bug really, but could you log one if one does not exist on that issue?
(Assignee)

Updated

9 years ago
Blocks: 501907
(Assignee)

Comment 74

9 years ago
(In reply to comment #73)
> (From update of attachment 384650 [details] [diff] [review])
> Seems fine, there should be valid alt="description of image" for all <img> tags
> you adding (for accessibility purposes), but doing the other ones you are not
> touching is outside of scope of this bug really, but could you log one if one
> does not exist on that issue?


Done:

https://bugzilla.mozilla.org/show_bug.cgi?id=501907

I've set in this bug (286975) the "checkin-needed" keyword.
Keywords: checkin-needed
Comment on attachment 384650 [details] [diff] [review]
Link fixed in suite-toc.rdf

>diff --git a/suite/locales/en-US/chrome/common/help/suite-toc.rdf b/suite/locales/en-US/chrome/common/help/suite-toc.rdf
>--- a/suite/locales/en-US/chrome/common/help/suite-toc.rdf
>+++ b/suite/locales/en-US/chrome/common/help/suite-toc.rdf

nc:link="mail_help.xhtml#local_folders"/> </rdf:li>
>         <rdf:li> <rdf:Description ID="mail_smtp" nc:name="Outgoing Server (SMTP)"  nc:link="mail_help.xhtml#outgoing_server"/> </rdf:li>
>       </rdf:Seq>
>+        <rdf:li> <rdf:Description ID="mail-doc-choose-IMAP" nc:name="About IMAP"  nc:link="mail_help.xhtml#about_internet_message_access_protocol"/> </rdf:li>
>+        <rdf:li> <rdf:Description ID="mail-doc-choose-POP" nc:name="About POP"  nc:link="mail_help.xhtml#about_post_office_protocol"/> </rdf:li>
>+        <rdf:li> <rdf:Description ID="mail_server_imap" nc:name="IMAP Server Settings"  nc:link="mail_help.xhtml#imap_server_settings"/> </rdf:li>
>+        <rdf:li> <rdf:Description ID="mail-doc-imap-adva
>     </nc:subheadings>
>   </rdf:Description>

I guess something went wrong here. Maybe accidentally added and unrelated to this patch?











> <rdf:Description about="#mail-doc-offline-space">
>     <nc:subheadings>
>       <rdf:Seq>
>         <rdf:li> <rdf:Description ID="mail_offline_imap" nc:name="IMAP"  nc:link="mail_help.xhtml#synchronization_and_storage_settings_imap"/> </rdf:li>
>-        <rdf:li> <rdf:Description ID="mail_offline_pop3" nc:name="POP"  nc:link="mail_help.xhtml#disk_space_settings"/> </rdf:li>
>+        <rdf:li> <rdf:Description ID="mail_offline_pop3" nc:name="POP"  nc:link="mail_help.xhtml#disk_space_settings_pop"/> </rdf:li>
>+        <rdf:li> <rdf:Description ID="mail_offline_blogs" nc:name="Blogs"  nc:link="mail_help.xhtml#disk_space_settings_blogs"/> </rdf:li>
>         <rdf:li> <rdf:Description ID="mail_offline_nntp" nc:name="News"  nc:link="mail_help.xhtml#synchronization_and_storage_settings_nntp"/> </rdf:li>
>       </rdf:Seq>
>     </nc:subheadings>
>   </rdf:Description>
> 
> <rdf:Description about="#mail_security_settings">
>     <nc:subheadings>
>       <rdf:Seq>
Gosh, pls ignore the <rdf:Description about="#mail-doc-offline-space">
section, it wasn't intended to be included in the comment. Sorry.
(Assignee)

Comment 77

9 years ago
(In reply to comment #75)
> (From update of attachment 384650 [details] [diff] [review])
> >diff --git a/suite/locales/en-US/chrome/common/help/suite-toc.rdf b/suite/locales/en-US/chrome/common/help/suite-toc.rdf
> >--- a/suite/locales/en-US/chrome/common/help/suite-toc.rdf
> >+++ b/suite/locales/en-US/chrome/common/help/suite-toc.rdf
> 
> nc:link="mail_help.xhtml#local_folders"/> </rdf:li>
> >         <rdf:li> <rdf:Description ID="mail_smtp" nc:name="Outgoing Server (SMTP)"  nc:link="mail_help.xhtml#outgoing_server"/> </rdf:li>
> >       </rdf:Seq>
> >+        <rdf:li> <rdf:Description ID="mail-doc-choose-IMAP" nc:name="About IMAP"  nc:link="mail_help.xhtml#about_internet_message_access_protocol"/> </rdf:li>
> >+        <rdf:li> <rdf:Description ID="mail-doc-choose-POP" nc:name="About POP"  nc:link="mail_help.xhtml#about_post_office_protocol"/> </rdf:li>
> >+        <rdf:li> <rdf:Description ID="mail_server_imap" nc:name="IMAP Server Settings"  nc:link="mail_help.xhtml#imap_server_settings"/> </rdf:li>
> >+        <rdf:li> <rdf:Description ID="mail-doc-imap-adva
> >     </nc:subheadings>
> >   </rdf:Description>
> 
> I guess something went wrong here. Maybe accidentally added and unrelated to
> this patch?


Somehow part of the next section got duplicated here. Sorry. :-( I've fixed it and checked it against current version in upstream repository. I'll attach a new patch in a moment.
Keywords: checkin-needed
(Assignee)

Comment 78

9 years ago
Created attachment 386485 [details] [diff] [review]
Revised patch to add News & Blogs Feeds help content

Sorry for causing so much trouble; I've reviewed the patch to ensure no new glitches enter in it.
Attachment #384650 - Attachment is obsolete: true
Attachment #386485 - Flags: review?(iann_bugzilla)

Comment 79

9 years ago
Does this actually need another review? Ian has plused it several times now.
The corrections in comment #77 are rather of editorial nature, and doing the images right has been deferred to what bug 249744 comes up with.

On the other hand, slushy string freeze for 2.0b1 is in effect now...
(Reporter)

Updated

9 years ago
Attachment #386485 - Flags: review?(iann_bugzilla) → review+
(Reporter)

Comment 80

9 years ago
It's possible, as we want to get tabmail in this release, that dates may be changed, but who knows...
(Assignee)

Comment 81

9 years ago
checkin-needed keyword added.

This may hurt localizers :-) (I for one don't have the es-ES translation ready, and will probably not have it ready for 2.0b1, because I'm about to be a week offline on holidays).

Should I warn localizers in m.d.l10n?
Keywords: checkin-needed

Comment 82

9 years ago
http://hg.mozilla.org/comm-central/rev/90ebbb182e9a

(In reply to comment #81)
> Should I warn localizers in m.d.l10n?

I just did ;-)
Status: ASSIGNED → RESOLVED
Last Resolved: 9 years ago
Keywords: checkin-needed
Resolution: --- → FIXED
Target Milestone: --- → seamonkey2.0b1

Comment 83

9 years ago
Nice, 8-) guess the blocking request will no longer be needed now.
Flags: blocking-seamonkey2?
You need to log in before you can comment on or make changes to this bug.