GNOME Bugzilla – Bug 435942
bridgehead tag not displayed in Evo help
Last modified: 2013-09-13 00:53:41 UTC
The DocBook bridgehead tag is used many times in Evolution help document, but Yelp discard this tag. We should either replace the bridghead tag by something more appropriate, or implement this tag in Yelp (see #352700).
I just saw in another part of the help document that it uses the formalpara tag with a title subtag. Maybe the right solution?
Created attachment 87624 [details] [review] Replace bridgehead tag by formalpara This patch remove all bridgehead tags and replace them with formalpara.
probably the problem is that novell uses an internal help revision app
These xml files are generated out from Frame+Novell documentation app. Radhika can you look into this?
The transitioned version of Evolution Doc replaces bridgehead tag with section tag. And will be posted shortly
uhm, evil. just also ran into this. i'm losing information here at it is not displayed.
Radhika, some news about the version you planned to commit?
Yes:-)for 2.11.4
Please do reassign the bug to me..
Radhika: Please ask one of the people that are marked as Evolution developers in Bugzilla (srini, chen, harish, gicmo, ross) to set you as the default assignee for user doc bug reports, instead of mark.
So let's hope it will be for 2.11.5 :-)
I have already handed off the patch to the Engineering contact: Srag
My bad. I was mailed of the patch and I missed to commit. Radhika, please attach to the bug, and I can mark it as accepted_commit_now, so that I don't miss here after. This is at-least one checklist item, I run before the build.
Created attachment 90266 [details] [review] patch for 2.12 evo user guide
Created attachment 90267 [details] [review] new image files
that patch is the internal revision, right?
it was for 2.11.4. Please do refer to #13
what i wanted to express is that i cannot apply the patch, because it's the patch for onvell's internal doc system and not for the version in gnome svn. :-)
I will commit this for 2.11.5
As Andre said, it is a bit weird because the original version in the patch (evolution210.xml) is not equal to the current SVN version, so the patch cannot be applied to the current version of evolution.xml.
As I have informed you, I have migrated from using Framemaker 7.0 to Framemaker 7.2 to generate XML, and PDF for Evo user guide. The new version will give the book a new look and feel for the users as compared to the older versions (Frame 7.0). The new book also replaces 'bridgehead' tag with 'Formal Para'. Let me know your thoughts on 'Authoring Tool' We use here for Evolution. Do we continue with the older version or move to better , enhanced versions.
Can we replace the current SVN version with the new XML?
Currently I am investigating why the patch cannot be applied to the current SVN version ..let me find some solution to solve this issue from the XML veterans at Novell:-)
Created attachment 91166 [details] [review] latest patch for evo user guide I am attaching the patch for Evolution User Doc. Hope it works..:-)
NO, NO, NO. -<?xml version="1.0" encoding="ISO-8859-1"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//Novell//DTD NovDoc XML V1.0//EN" "novdocx.dtd"> you're obviously changing the document type. GNOME uses DocBook format, not "NovDoc" format. NO.
Oh ok, it's a mistake from my side.. Let me back port the bug fixes manually to the old format or get it transitioned back to the old template by Novell internal prod specialist.. Sorry for the confusions..
Created attachment 91598 [details] [review] patch for evolution user guide Attached is the patch. And Sorry for all the confusions.. By giving the Evo Guide in a new document type, our sole intention was to provide the community with the new functionalities like "search" in the generated HTML file and a better look and feel for the PDF.
Sorry but this patch still cannot be applied to current trunk version: File to patch: evolution.xml patching file evolution.xml Hunk #1 FAILED at 7. Hunk #2 FAILED at 31. Hunk #3 FAILED at 49. Hunk #4 FAILED at 59. Hunk #5 FAILED at 77. Hunk #6 FAILED at 3019. Hunk #7 FAILED at 5246. Hunk #8 FAILED at 5286. Hunk #9 FAILED at 5337. ?? Maybe you could attach to this bug report your complete updated guide...
$:andre\> patch -p0 < 435942-helppatch.diff File to patch: evolution.xml patching file evolution.xml Hunk #1 FAILED at 7. Hunk #2 FAILED at 31. Hunk #3 FAILED at 49. Hunk #4 FAILED at 59. Hunk #5 FAILED at 77. Hunk #6 FAILED at 3019. Hunk #7 FAILED at 5246. Hunk #8 FAILED at 5286. Hunk #9 FAILED at 5337. 9 out of 9 hunks FAILED -- saving rejects to file evolution.xml.rej
Created attachment 91715 [details] [review] patch for evolution user guide patch is attached
(what i asked myself the whole time: are these patches tested at all, or is that outsourced to claude and me?) here, yelp complains "This XML file does not appear to have any style information associated with it. The document tree is shown below." Radhika, did you open your xml file with yelp, gnome's help browser? does it work for you? perhaps it's only a local issue here...
I've been able to open the file without errors. However I still have to check some things, because the new file contain some unusual tags not often present in GNOME help files.
The first problem I encountered is the location of figures. They should be in the figure subdir. This isn't the case in your patch. Could you correct that?
Please do list the figures you are not able to view
In fact, this involves all figures. It's a sort of convention in GNOME help, figures are always in a "figures" subdirectory. See http://svn.gnome.org/viewcvs/evolution/trunk/help/C/
radhika: claude wrote "They should be in the figure subdir". he did not write "i cannot view some figures". please get this done FAST, so translators have time to update the translation BEFORE 2.20.0 comes out. thanks.
I see another problem with non-ASCII chars. The file has been ISO-8859-1 encoded until now, but that wasn't really a problem as the non core ASCII chars were entity encoded (', «, etc.). Now it seems that you wrote these entities directly, not encoded. In this case, I suggest we pass the entire file in UTF-8, which it should be anyway. Otherwise, we'll soon encounter serious problems with translations. I hope it's only a matter of modifying a setting in your editor and resaving the file.
It's the problem with the tool we have used here to generate the xml file. As it is creating n no. of issues, let me switch back to the old tool we have used. I will commit the doc with all the new features went in for 2.11.5 and 2.11.6 for this release. The bug fixes for #438479 will not be available with this version since fixes for bug#438479 went into the new branch and manually back porting definitely needs some time. Hope it's ok with you.
Seems reasonable. Maybe then you could apply the first patch I submitted to this bug report?
sometimes i wonder whether the GNOME evolution documentation should be forked (away from novell), if novell does not have the power to do the things that have to be done.
Novell is capable....
Bridgehead tag has been removed. Committed an intermediate patch and new graphics images... Will Committ new patch for 2.11.8 with fixes for bug#438479.
Created attachment 92855 [details] [review] Typos in last commit OK, nice. But before closing this bug report, I would like to commit the typos I found while updating the French version :-/ Don't you practice proofreading by Novell ;-) I also reintroduced &appversion and &appname entities you suppressed, but which are still used in the document. If you approve the corrections, I can apply the patch.
Please, Radikha, just have a look on this, as it's only corrections, nothing revolutionary :-)
Updated the Doc, Done spell check (Thanks for reminding us!!)......
Thanks, but does this mean that I can commit the patch in SVN ?
Thanks a load for spotting the typos.. I have already incorporated your changes and Committed revision 33976. Please do verify the same..
(In reply to comment #43) > Created an attachment (id=92855) [edit] > Typos in last commit > > OK, nice. > But before closing this bug report, I would like to commit the typos I found > while updating the French version :-/ > Don't you practice proofreading by Novell ;-) > I also reintroduced &appversion and &appname entities you suppressed, but which > are still used in the document. > If you approve the corrections, I can apply the patch. > Incorporated the changes to the Doc
At last... Closed :-)
:-)
thanks for your work! http://svn.gnome.org/viewcvs/evolution/trunk/help/C/evolution.xml?r1=33936&r2=33976 with latest svn revision 33976, there are some issue left: "Select if you want to user the <emphasis>.folders</emphasis> summary file." user => use <para>evolution --disable -preview</para> <para>Disables all the preview panes when you restart Evolution. </para> <para>It lets Evolution not to open the last crashed mail, task or contact when you restart Evolution. Thus, it provides a way to avoid system crash caused by previewing messages, task or contact. </para> uhmmm... first of all, do not put another whitespace at the end of a sentence. it is not "contact. </para>", it must be "contact.</para>". this is a general hint, and i will not list every occurrence. entering "evolution --disable -preview" will never work. it must be "evolution --disable-preview". "the last crashed mail" is NOT possible in english language. it must either be email or message. mail is always plural. "messages, task or contact" - why is one singular, one plural? be consistent. "it provides" has one whitespace too much. "If you have new mails arrived in a number of folders, spacebar toggles between those folders." sigh. in the former version this was correct: "mail" instead of "mails". "mails" does NOT exist in english language. "This feature allows you to switch to the next unread mail" no: message. "a blinking tray icon" NO! there is no tray in gnome, it is called "notification area" everywhere. stick to standards if you want to be part of gnome! "e-mail" no. be consistent, it is "email". this happens several times, even in the same sentence. pretty sad. "There is also a gconf key for the default state for the expanded state of thread. Default is true and you can change at /apps/evolution/mail/display/thread_expand. If the value is false, the default state of threads are collapsed and the expanded states are remembered. When you change this option and restart Evolution, all the threads are made to this state. This is a higly advanced option only for super users." " " => " " higly => highly "the default state [...] are collapsed" ?! "Click the in drop-down list to select the scope" still wrong - "in"? "Previously we needed other trainer to train the spam filters." whatever this sentence should mean, i don't get it. perhaps it also should be "trainers". "by clicking “Not junk" button" is there a "the" missing? and duplicated whitespace, like always... "default.This" misses a whitespace "Checking the Status of an Item You have sent" "You"? why not "you"? (several times) <para> Specify how do you want to receive message receipts. You can set Send message receipts to Never, Always or Ask for each message. For more information refer <link linkend="b13uhy6r">Default Settings</link>.</para> "how *do* you"? no. this sentence is not a question. <para>You can change the default settings of your send items. Click Advanced Send Options to prioritize, classify your send messages. You can also set the date for reply request so that recipient will know the immediacy and can accordingly response to your message. Enable status tracking and set Return Notification for Mail, Calendar and Task.</para> "send items"? not "sent items"? You can also find this information online by selecting Help > Quich Reference in the Menubar. that's not online. that's just a damn pdf file on my local harddisk. "Sergey V. Mironov for Russian (.ru) and French (.fr)" Sergey did NOT translate this guide to french!
Radhika possible for Monday?
Committed revision 34011.
Created attachment 93816 [details] [review] Patch which corrects some things This patch removes some whitespaces, corrects typos, tries to use messages instead of mails, mail or e-mails. But needs to be reviewed from a native speaker though. Note: I don't claim, that this is neither complete nor correct, but I think it improves the current docs a lot.
Thanks a load. Few comments We cannot remove the blank spaces between <title>xyz: </title> as in replacing <title>USENET News: </title> with <title>USENET News:</title>. The attached image will give you an idea how it looks in Frame(the tool we use here to generate XML.
Created attachment 93982 [details] image file of the evolution source file The image gives you an idea how <title>USENET News: </title> looks in the frame file.
Created attachment 93983 [details] image file of the evolution source file
Created attachment 93986 [details] frame structural view For @@ -262,7 +262,7 @@ <section id="second-step"> <title>Receiving Mail</title> - <para>The Receiving E-mail option lets you determine where you get your e-mail. </para> + <para>The Receiving E-mail option lets you determine where you get your e-mail.</para>, please do view the image file of Frame structural view.
So,the space is automatically created while generating the XML file from FrameMaker.
Created attachment 94002 [details] inner structural workflow symbolization mockup draft (in response to comment #58) i also created a structural view of my workflow here, two kilometres under the earth in my top secret laboratory. please do view the image file. (to be honest: if you say that's it's not possible with framemaker, i trust you. you don't have to attach pictures that i don't understand. :-)
Andre: I appreciate your sense of humor... Sure, You can be a Gr8 Cartoonist!!!!;-)