From: Alan G I. <ai...@am...> - 2004-11-19 15:10:12
|
i. I like my doc-info to follow my document title. I find that if I include a subtitle to a document then rst2html puts my doc-info into a "field-list" table instead of a "docinfo" table. Correspondingly, the meta info is no longer written. This seems like a bug? ii. Separately, I have a query about the proper handling of end-of-lines in the author field. In academe it is very natural to want an author title associated with the author name. A natural syntax seems :Author: I.M. Someone Professor of Something rst2html simply writes the EOL to the docinfo or field-list table, which does not seem the right behavior. I propose it should write a BR element instead. When a META element is generated, the EOL is simply ignored. I propose it should be written as punctuation (a colon?). Or is this to be handled another way altogether? Thank you, Alan Isaac |
From: David G. <go...@py...> - 2004-11-19 16:04:13
Attachments:
signature.asc
|
[Alan G Isaac] > i. I like my doc-info to follow my document title. > I find that if I include a subtitle to a document > then rst2html puts my doc-info into a "field-list" > table instead of a "docinfo" table. Correspondingly, > the meta info is no longer written. This seems like > a bug? I doubt it. Show us an example. > ii. Separately, I have a query about the proper handling of > end-of-lines in the author field. The author field is simply a text field, a single paragraph. There's no support for a separate title. We could add one, but I'd rather not. The docinfo mechanism may already have too much special processing for its own good. > In academe it is very natural to want an author title associated > with the author name. A natural syntax seems > > :Author: I.M. Someone > Professor of Something How about :Author: I.M. Someone, Professor of Something > rst2html simply writes the EOL to the docinfo or field-list > table, which does not seem the right behavior. > I propose it should write a BR element instead. The "Address" docinfo field is handled as a line block. "Author" could be also, but it seems non-obvious to me. This triggered an idea though. Currently, if a docinfo field's content doesn't conform to the expected structure, a warning is generated in the generic field (field name & body) that remains. Example:: $ rst2pseudoxml.py <<EOF title ===== :Author: | name | title para EOF <stdin>:4: (WARNING/2) Cannot extract bibliographic field "Author" containing anything other than a single paragraph. <document id="title" name="title" source="<stdin>"> <title> title <docinfo> <field> <field_name> Author <field_body> <line_block> <line> name <line> title <system_message level="2" line="4" source="<stdin>" type="WARNING"> <paragraph> Cannot extract bibliographic field "Author" containing anything other than a single paragraph. <paragraph> para Perhaps that WARNING (normally rendered) should be demoted to an INFO-level system message (not normally rendered), allowing a nearly-transparent fallback to generic behavior. In this case, no "author" meta tag would be generated, but docinfo lists would be more flexible. Opinions? > When a META element is generated, the EOL is simply ignored. Not quite. The newline is turned into a space. > I propose it should be written as punctuation (a colon?). Why? -- David Goodger <http://python.net/~goodger> |
From: Felix W. <Fel...@gm...> - 2004-11-19 19:31:15
|
David Goodger wrote: > The "Address" docinfo field is handled as a line block. Not really (anymore). Should it generate a real line block, maybe? It might be more consistent and avoid special handling in the writers. > "Author" could be also, but it seems non-obvious to me. Agreed. > This triggered an idea though. Currently, if a docinfo field's > content doesn't conform to the expected structure, a warning is > generated in the generic field (field name & body) that remains. > Example:: > > [...] > <docinfo> > <field> > <field_name> > Author > <field_body> > <line_block> > [...] > <system_message type="WARNING" ... > [...] > > Perhaps that WARNING (normally rendered) should be demoted to an > INFO-level system message (not normally rendered), allowing a > nearly-transparent fallback to generic behavior. In this case, no > "author" meta tag would be generated, but docinfo lists would be more > flexible. Opinions? +1. -- When replying to my email address, please ensure that the mail header contains 'Felix Wiemann'. http://www.ososo.de/ |
From: Alan G I. <ai...@am...> - 2004-11-19 22:28:52
|
> [Alan G Isaac] >> i. I like my doc-info to follow my document title. >> I find that if I include a subtitle to a document >> then rst2html puts my doc-info into a "field-list" >> table instead of a "docinfo" table. Correspondingly, >> the meta info is no longer written. This seems like >> a bug? On Fri, 19 Nov 2004, David Goodger apparently wrote: > I doubt it. Show us an example. My apologies. I misunderstood the implications of this: When a field list is the first non-comment element in a document (after the document title, if there is one), it may have its fields transformed to document bibliographic data. Because I reused my subtitle decoration, it was no longer a subtitle, and thus my docinfo came after a section header, and was under this rule, actually not docinfo. Thank you, Alan Isaac |
From: Alan G I. <ai...@am...> - 2004-11-20 05:48:46
|
>> In academe it is very natural to want an author title associated >> with the author name. A natural syntax seems >> :Author: I.M. Someone >> Professor of Something On Fri, 19 Nov 2004, David Goodger apparently wrote: > How about > :Author: I.M. Someone, Professor of Something My thought was that an Author filed naturally takes either one line with a name on it or a second line for a title. :Author: I.M. Someone, Professor of Something will be processed the same as a long name, which is something different. > The "Address" docinfo field is handled as a line block. > "Author" could be also, but it seems non-obvious to me. In the academic fields I am familiar with, the author's title is almost always reported. This is a distinct piece of information. I am just trying to see how to keep it distinct from the name. >> When a META element is generated, the EOL is simply ignored. >> I propose it should be written as punctuation (a colon?). > Not quite. The newline is turned into a space. > Why? Well again: it seems to me that if two lines are written in an Author field, this is a deliberate attempt to communicate something. I am just looking for a way to respect that attempt. <meta name="author" content="I.M. Someone Professor of Something" /> seems much less satisfactory to me than <meta name="author" content="I.M. Someone: Professor of Something" /> However after your comments, I guess I like better having an AuthorTitle field, or something equivalent. fwiw, Alan Isaac |