From: Aleksey G. <agu...@me...> - 2004-11-07 00:05:37
Attachments:
frontmatter.py.diff
|
The attached tiny path implements the DocInfo transformation for the ":Authors:" field as per http://docutils.sourceforge.net/docs/ref/doctree.html#authors, making the following warning obsolete: 'Bibliographic field "%s" incompatible with extraction: ' 'it must contain either a single paragraph (with authors ' 'separated by one of "%s"), multiple paragraphs (one per ' 'author), or a bullet list with one paragraph (one author) ' 'per item.' -- Aleksey Gurtovoy MetaCommunications Engineering |
From: David G. <go...@py...> - 2004-11-07 04:30:54
Attachments:
signature.asc
|
[Aleksey Gurtovoy] > The attached tiny path implements the DocInfo transformation for the > ":Authors:" field as per > http://docutils.sourceforge.net/docs/ref/doctree.html#authors, Sorry, I don't see the relevance of that link. Could you explain please? > making the following warning obsolete: > > 'Bibliographic field "%s" incompatible with extraction: ' > 'it must contain either a single paragraph (with authors ' > 'separated by one of "%s"), multiple paragraphs (one per ' > 'author), or a bullet list with one paragraph (one author) ' > 'per item.' I don't see how your patch helps. Could you provide example input showing a case where this makes a difference? -- David Goodger <http://python.net/~goodger> |
From: Aleksey G. <agu...@me...> - 2004-11-07 10:49:00
|
David Goodger writes: > [Aleksey Gurtovoy] > > The attached tiny path implements the DocInfo transformation for the > > ":Authors:" field as per > > http://docutils.sourceforge.net/docs/ref/doctree.html#authors, > > Sorry, I don't see the relevance of that link. Could you explain > please? It's only slightly relevant, sorry for the confusion. I was referring to this part of the linked fragment: ((author, organization?, address?, contact?)+) which of course doesn't have to do anything with the front end. > > > making the following warning obsolete: > > > > 'Bibliographic field "%s" incompatible with extraction: ' > > 'it must contain either a single paragraph (with authors ' > > 'separated by one of "%s"), multiple paragraphs (one per ' > > 'author), or a bullet list with one paragraph (one author) ' > > 'per item.' > > I don't see how your patch helps. Could you provide example input > showing a case where this makes a difference? Sure. Given this document: Document ======== :Authors: :Author: Aleksey Gurtovoy :Organization: MetaCommunications :Contact: agurtovoy -at- meta-comm.com :Author: David Goodger :Contact: your-email-address Here's what you get before: <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> <!-- Generated by Docutils 0.3.6 --> <document id="document" name="document" source="a.rst"> <title>Document</title> <docinfo> <field> <field_name>Authors</field_name> <field_body> <field_list> <field> <field_name>Author</field_name> <field_body><paragraph>Aleksey Gurtovoy</paragraph></field_body> </field> <field> <field_name>Organization</field_name> <field_body><paragraph>MetaCommunications</paragraph></field_body> </field> <field> <field_name>Contact</field_name> <field_body><paragraph>agurtovoy -at- meta-comm.com</paragraph></field_body> </field> <field> <field_name>Author</field_name> <field_body><paragraph>David Goodger</paragraph></field_body> </field> <field> <field_name>Contact</field_name> <field_body><paragraph>your-email-address</paragraph></field_body> </field> </field_list> <system_message level="2" line="4" source="a.rst" type="WARNING"> <paragraph>Bibliographic field "Authors" incompatible with extraction: it must contain either a single paragraph (with authors separated by one of ";,"), multiple paragraphs (one per author), or a bullet list with one paragraph (one author) per item. </paragraph> </system_message> </field_body> </field> </docinfo> </document> And here's the output with the patch: <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> <!-- Generated by Docutils 0.3.6 --> <document id="document" name="document" source="a.rst"> <title>Document</title> <docinfo> <authors> <author>Aleksey Gurtovoy</author> <organization>MetaCommunications</organization> <contact>agurtovoy -at- meta-comm.com</contact> <author>David Goodger</author> <contact>your-email-address</contact> </authors> </docinfo> </document> -- Aleksey Gurtovoy MetaCommunications Engineering |
From: Aleksey G. <agu...@me...> - 2004-11-15 17:42:39
|
David, Any reply on this one? > > David Goodger writes: > > [Aleksey Gurtovoy] > > > The attached tiny path implements the DocInfo transformation for the > > > ":Authors:" field as per > > > http://docutils.sourceforge.net/docs/ref/doctree.html#authors, > > > > Sorry, I don't see the relevance of that link. Could you explain > > please? > > It's only slightly relevant, sorry for the confusion. I was > referring to this part of the linked fragment: > > ((author, organization?, address?, contact?)+) > > which of course doesn't have to do anything with the front end. > > > > > > making the following warning obsolete: > > > > > > 'Bibliographic field "%s" incompatible with extraction: ' > > > 'it must contain either a single paragraph (with authors ' > > > 'separated by one of "%s"), multiple paragraphs (one per ' > > > 'author), or a bullet list with one paragraph (one author) ' > > > 'per item.' > > > > I don't see how your patch helps. Could you provide example input > > showing a case where this makes a difference? > > Sure. Given this document: > > Document > ======== > > :Authors: > > :Author: Aleksey Gurtovoy > :Organization: MetaCommunications > :Contact: agurtovoy -at- meta-comm.com > > :Author: David Goodger > :Contact: your-email-address > > > Here's what you get before: > > <?xml version="1.0" encoding="utf-8"?> > <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" > "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> > <!-- Generated by Docutils 0.3.6 --> > <document id="document" name="document" source="a.rst"> > <title>Document</title> > <docinfo> > <field> > <field_name>Authors</field_name> > <field_body> > <field_list> > <field> > <field_name>Author</field_name> > <field_body><paragraph>Aleksey Gurtovoy</paragraph></field_body> > </field> > <field> > <field_name>Organization</field_name> > <field_body><paragraph>MetaCommunications</paragraph></field_body> > </field> > <field> > <field_name>Contact</field_name> > <field_body><paragraph>agurtovoy -at- meta-comm.com</paragraph></field_body> > </field> > <field> > <field_name>Author</field_name> > <field_body><paragraph>David Goodger</paragraph></field_body> > </field> > <field> > <field_name>Contact</field_name> > <field_body><paragraph>your-email-address</paragraph></field_body> > </field> > </field_list> > <system_message level="2" line="4" source="a.rst" type="WARNING"> > <paragraph>Bibliographic field "Authors" incompatible with extraction: it > must contain either a single paragraph (with authors separated by one of > ";,"), multiple paragraphs (one per author), or a bullet list with > one paragraph (one author) per item. > </paragraph> > </system_message> > </field_body> > </field> > </docinfo> > </document> > > > And here's the output with the patch: > > <?xml version="1.0" encoding="utf-8"?> > <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" > "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> > <!-- Generated by Docutils 0.3.6 --> > <document id="document" name="document" source="a.rst"> > <title>Document</title> > <docinfo> > <authors> > <author>Aleksey Gurtovoy</author> > <organization>MetaCommunications</organization> > <contact>agurtovoy -at- meta-comm.com</contact> > <author>David Goodger</author> > <contact>your-email-address</contact> > </authors> > </docinfo> > </document> > -- Aleksey Gurtovoy MetaCommunications Engineering |
From: David G. <go...@py...> - 2004-11-15 18:09:19
Attachments:
signature.asc
|
[Aleksey Gurtovoy] > Any reply on this one? Sorry, another one that slipped through. I'm just back from a week-long client visit, catching up. Will re-examine and reply later today. Errands to run now though. -- David Goodger <http://python.net/~goodger> |
From: David G. <go...@py...> - 2004-11-16 03:49:02
Attachments:
signature.asc
|
[Aleksey Gurtovoy] > The attached tiny path implements the DocInfo transformation for the > ":Authors:" field as per > http://docutils.sourceforge.net/docs/ref/doctree.html#authors, The idea is to turn this: :Authors: :Author: Aleksey Gurtovoy :Organization: MetaCommunications :Contact: agurtovoy -at- meta-comm.com :Author: David Goodger :Contact: your-email-address into this: <docinfo> <authors> <author> Aleksey Gurtovoy <organization> MetaCommunications <contact> agurtovoy -at- meta-comm.com <author> David Goodger <contact> your-email-address The idea is sound. But the patch is too tiny, I'm afraid; it's too loose. It needs some verification code, otherwise invalid doctrees may result. For example, try this input: :Authors: :Organization: this shouldn't come first, Author should :Author: should :Date: today :Status: these fields shouldn't occur at all -- David Goodger <http://python.net/~goodger> |
From: Aleksey G. <agu...@me...> - 2004-11-16 18:33:48
|
David Goodger writes: > [Aleksey Gurtovoy] > > The attached tiny path implements the DocInfo transformation for the > > ":Authors:" field as per > > http://docutils.sourceforge.net/docs/ref/doctree.html#authors, > > The idea is to turn this: > > :Authors: > > :Author: Aleksey Gurtovoy > :Organization: MetaCommunications > :Contact: agurtovoy -at- meta-comm.com > > :Author: David Goodger > :Contact: your-email-address > > into this: > > <docinfo> > <authors> > <author> > Aleksey Gurtovoy > <organization> > MetaCommunications > <contact> > agurtovoy -at- meta-comm.com > <author> > David Goodger > <contact> > your-email-address > > The idea is sound. But the patch is too tiny, I'm afraid; it's too > loose. It needs some verification code, otherwise invalid doctrees > may result. I suspected you might want more :). > For example, try this input: > > :Authors: > > :Organization: this shouldn't come first, Author should > :Author: should > > :Date: today > :Status: these fields shouldn't occur at all I'll see into adding validation to it. -- Aleksey Gurtovoy MetaCommunications Engineering |