GNOME Bugzilla – Bug 677549
"Link Contacts" user documentation is wrong
Last modified: 2013-04-30 12:00:09 UTC
I tried to merge a few contacts today, but I couldn't figure out how, so I looked at the documentation. Unfortunately, it's out of date/wrong, because it talks about a "Link Contacts" option which doesn't exist. I did manage to figure it out (Information > Add to My Contacts > (Hope the other account gets auto detected?) > Click Yes), but clearly at least some part of the documentation needs some work.
It seems like this is about http://library.gnome.org/users/empathy/3.4/link-contacts.html.en Which Empathy version is this about? Patches are welcome, see http://live.gnome.org/TranslationProject
Yeah Empathy relies on gnome-contacts now for linking.
Created attachment 242619 [details] [review] patch for link-contact page in empathy
Created attachment 242625 [details] [review] updated patch for bug 677549
Review of attachment 242625 [details] [review]: The instructions are incorrect because Contacts has changed again, see general points below. The current instructions are in gnome-user-docs. ::: help/C/link-contacts.page @@ +66,3 @@ + <item> + <p> + From the <gui>Contact List</gui> window, right-click one of the contact "one of the contacts" or "a contact" @@ +69,3 @@ + that has different accounts, and select <gui style="menuitem">Information</gui>. + </p> + </item> At this point, I don't see the stuff below, but a request for me to set up my address book. You need to cover this case.
Created attachment 242673 [details] [review] revised patch for link contacts
Created attachment 242689 [details] [review] one more patch for link-contact page in empathy
Created attachment 242730 [details] [review] 0001-updated-link-contacts.page.patch
Created attachment 242731 [details] [review] 0001-updated-link-contacts.page.patch
Review of attachment 242731 [details] [review]: ::: help/C/link-contacts.page @@ +27,3 @@ </info> + <title>Link and Unlink contacts</title> Unlink should be lower case because it is mid-title and not a proper noun. @@ +30,3 @@ <p> + If one or more of your contacts has multiple accounts with different + messaging services you can combine them into a single contact. Add the comma after services back, it is needed. @@ +37,3 @@ </p> <p> + Suppose you have a contact called Jane Smith that is using three different "contact … who is using…" @@ +41,1 @@ services like: Why is this on a new line? @@ +59,3 @@ </list> <p> + You can link these contacts of Jane Smith into a single contact. The old version was more correct. @@ +63,2 @@ <section id="linking"> + <p> The way you can link your contacts is as under: Why is there a space after <p>? @@ +64,3 @@ + <p> The way you can link your contacts is as under: + </p> + <title>Link contacts</title> The section title should be above the first paragraph. @@ +65,3 @@ + </p> + <title>Link contacts</title> + <steps> Too much indenting here, indent the <steps> list by 4 spaces, and child tags by two more spaces each. @@ +68,3 @@ + <item> + <p> + In order to select entries you want to link locate and click tick button. Buttons are "pressed". Use a more active tone. For example, start the sentence with "Press…". @@ +73,3 @@ + <item> + <p> + This will enable <em>selection mode</em> and ckeckbox would appear against each entry. Move this into the step below or above, or split between the two. Each step should be the action that @@ +78,3 @@ + <item> + <p> + Select all the entries that belongs to the same person by putting a Use "contact", not "person" because you have been using "contact" up to now. @@ +79,3 @@ + <p> + Select all the entries that belongs to the same person by putting a + tick in checkbox. One doesn't "put a tick in a checkbox", one "ticks a checkbox". @@ +84,3 @@ + <item> + <p> + Click <gui style="button">Link</gui> Missing full stop at the end of the sentence. @@ +89,3 @@ + <item> + <p> + Repeat steps 3 and 4 in order to link other contacts. "in order" is not needed here. This also shouldn't be part of the <steps>. If you feel that it is needed, have it in a paragraph after the <steps>. @@ +98,3 @@ + If somehow you wish to unlink any linked contact then follow instructions given below: + </p> + <title>Unlink contacts</title> Same as above. @@ +102,3 @@ <item> <p> + Locate and select contact that is to be unlinked. "Locate" is not the appropriate word to use here. Use definite articles as needed. "that is to be" is too passive, be more active. @@ +108,3 @@ <p> + In the top-right corner of <app>Contacts</app> click <gui style="button">Edit</gui>--> + <gui style="button">Linked Contacts</gui> --> <gui style="button">Remove</gui>. This should be three steps. In other cases, <guiseq> can be used for a sequence of <gui> items, but here is not the right place to do it because they are in three different places in the UI and in two different windows. @@ +113,3 @@ <item> + <p> + If you want unlink more contacts repeat steps 1 and 2. This shouldn't be part of the <steps>, but a paragraph after the steps. @@ +123,3 @@ <item> <p> + Finally click <gui style="button">Done</gui> once editing is over. Too passive.
Created attachment 242746 [details] [review] 0001-updated-link-contacts.page.patch
Created attachment 242747 [details] [review] 0001-updated-link-contacts.page.patch
Comment on attachment 242747 [details] [review] 0001-updated-link-contacts.page.patch Just some quick comments which are my personal point of view, Kat has the last word. :) >+ The way you can link your contacts is as under: Sentence feels weird to me, but I'm not a native speaker. Maybe "is as follows"? >+ Press tick button to select entries you want to link.This will enable "Press tick button" needs an article, as there is only one button. There is a whitespace missing after the full stop. >+ A ckeckbox would appear against each entry. Typo in "checkbox". Maybe "A checkbox will appear for each entry"? >+ Select all the entries that belongs to the same contact by ticking the checkbox. "belong", as "all the entries" is plural. Not sure about "all the entries" or "all entries". Maybe "ticking the corresponding checkboxes for each entry"? Plus "ticking" feels weird. Maybe "selecting"? >+ If somehow you wish to unlink any linked contact then follow instructions given below: I understand the "somehow", I wonder if "for some reasons" would sound better. >- From the <gui>Contact List</gui>, right-click the contact >- to separate, and select <gui style="menuitem">Link Contacts...</gui>. >+ select contact you wish to unlink. Missing capitalization, plus contact needs an article as you refer to one contact. >+ Press <gui style="button">Close</gui> if you do not want unlink any more. Either "anymore" or "any more contacts" (probably the latter to be clearer).
Created attachment 242803 [details] [review] 0001-updated-link-contacts.page.patch
Review of attachment 242803 [details] [review]: ::: help/C/link-contacts.page @@ +68,3 @@ <item> <p> + Press tick button to select entries you want to link. This will enable "Press tick button" needs an article, as there is only one button. @@ +74,3 @@ <item> <p> + A ckeckbox will appear for each entry. checkbox This should be inside the previous step as it does not require action from the user. @@ +79,3 @@ + <item> + <p> + Tick the respective checkboxes to select all entries that belong to the same contact. Respective to what? Corresponding is a better word to use, but you need to say what the checkboxes correspond to. @@ +126,3 @@ + <item> + <p> + Finally, Press <gui style="button">Done</gui> to stop editing. Mid-sentence capital here. Finish, not stop.
Created attachment 242807 [details] [review] 0001-updated-link-contacts.page.patch
Created attachment 242816 [details] [review] 0001-updated-link-contacts.page.patch
Comment on attachment 242816 [details] [review] 0001-updated-link-contacts.page.patch >+ Tick checkbox which corresponds to an entry one by one to select all the entries >+ that belong to the same contact. That sentence is a bit hard to read. "Tick all checkboxes which correspond to a contact in order to select all the entries that belong to the same contact" maybe? Doesn't sound really great either though. :-/ Apart from that I think this is fine. Good work! :)
Review of attachment 242807 [details] [review]: ::: help/C/link-contacts.page @@ +74,3 @@ <item> <p> + Tick checkbox which corrresponds to an entry one by one to select all the entries "Tick the checkboxes that correspond to the <app>Contacts</app> entries which belong to the same contact." @@ +93,3 @@ + <p> + If for some reasons you wish to unlink any linked contact then follow instructions + given below: Remove "for some reasons" and "given below", which would require the sentence to be reworded. So "To unlink a linked contact:" is what I'd end up with. @@ +98,3 @@ <item> <p> + To unlink the contact select it from your list of contacts. You've already said "to unlink a contact", so without repeating that, you should end up with "Select the contact from your list."
Created attachment 242826 [details] [review] 0001-updated-link-contacts.page.patch
Review of attachment 242826 [details] [review]: This is the last thing that I can see! ::: help/C/link-contacts.page @@ +30,3 @@ <p> + If one or more of your contacts has multiple accounts with different + messaging services, you can combine them into a single contact. "these accounts" instead of "them"
Created attachment 242900 [details] [review] 0001-updated-link-contacts.page.patch
Comment on attachment 242900 [details] [review] 0001-updated-link-contacts.page.patch Pushed to master in commit c1f6327303dfa50e97a02bfad8161553aa549575