Thread: [Docstring-develop] Re: [Docstring-checkins] CVS: dps/spec gpdi.dtd,1.32,1.33
Status: Pre-Alpha
Brought to you by:
goodger
From: David G. <go...@us...> - 2002-02-22 02:42:41
|
I checked dps/spec/gpdi.dtd in to CVS: >> Log Message: >> - Made ``abstract`` a structural element, after ``docinfo``. Richard Jones wrote: > In my mind, the abstract forms a part of the docinfo. I've revised my design, for three reasons. First, I think of the docinfo as the "copyright page" metadata stuff, and the abstract doesn't belong there. Second, because unlike all the other docinfo elements which contain only text (%text.model;), abstracts may contain multiple body elements. Third, I already had (artificial, in retrospect) limitations on abstracts: there could be only one, and it had to be at the end of the docinfo. Working on my HTML Writer forced me to think about the roles of the various pieces. Abstracts work as a fixed-title mini section. Over time you'll see that I continually evolve my designs, searching for a sometimes-elusive ideal. Please bear with me, and consider *everything* experimental until 1.0. It's a pain, I know. (Believe me, I know. It's painful to *me* to rip out code sometimes.) But it's for the best. If you notice anything that smells bad, please point it out. Debates on the mailing lists have helped considerably. > I was actually going to stuff the abstract into the html head as a meta > description tag. You can still do that. But what if the abstract is half a page long? Or includes a bullet list or table? Besides, there's now a ``.. meta::`` directive specifically for HTML metadata. -- David Goodger go...@us... Open-source projects: - Python Docstring Processing System: http://docstring.sourceforge.net - reStructuredText: http://structuredtext.sourceforge.net - The Go Tools Project: http://gotools.sourceforge.net |
From: Richard J. <rj...@ek...> - 2002-02-22 03:15:36
|
On Fri, 22 Feb 2002 13:44, David Goodger wrote: > I've revised my design, for three reasons. First, I think of the docinfo as > the "copyright page" metadata stuff, and the abstract doesn't belong there. > Second, because unlike all the other docinfo elements which contain only > text (%text.model;), abstracts may contain multiple body elements. Third, I > already had (artificial, in retrospect) limitations on abstracts: there > could be only one, and it had to be at the end of the docinfo. > > Working on my HTML Writer forced me to think about the roles of the various > pieces. Abstracts work as a fixed-title mini section. OK, I was trying to shoe-horn abstracts into meta descriptions, which is out of their scope :) > Over time you'll see that I continually evolve my designs, searching for a > sometimes-elusive ideal. Please bear with me, and consider *everything* > experimental until 1.0. It's a pain, I know. (Believe me, I know. It's > painful to *me* to rip out code sometimes.) But it's for the best. Sounds fair enough to me. > If you notice anything that smells bad, please point it out. Debates on the > mailing lists have helped considerably. No problem, as long as it's welcome :) > > I was actually going to stuff the abstract into the html head as a meta > > description tag. > > You can still do that. But what if the abstract is half a page long? Or > includes a bullet list or table? The information destined for the HTML meta tags should be PCDATA, yes. > Besides, there's now a ``.. meta::`` > directive specifically for HTML metadata. I noticed that when it broke the parser :) Richard ps. sorry, meant to cc the list on the last mail, but hit the w0rng button ;) |
From: Tony J I. (Tibs) <to...@ls...> - 2002-02-22 09:02:07
|
David Goodger wrote: > Abstracts work as a fixed-title mini section. I like that. > Over time you'll see that I continually evolve my designs, > searching for a sometimes-elusive ideal. The *good* thing is that, so far, David has turned out to be rather good at this (in my opinion - I'm not very good at "humble" - at least). BTW - glad to see Richard joining in - the more the merrier. Tibs ...hoping to get back to spare-time work on DPS next week some time... -- Tony J Ibbs (Tibs) VoxNav - http://www.yeomannavigation.com/ - "We talk. You arrive" Turn-by-turn route planning to your mobile 'phone - 09050 505050 My views! Mine! Mine! (Unless Laser-Scan ask nicely to borrow them.) |
From: Richard J. <rj...@ek...> - 2002-02-24 21:53:42
|
On Fri, 22 Feb 2002 20:01, Tony J Ibbs (Tibs) wrote: > David Goodger wrote: > > Over time you'll see that I continually evolve my designs, > > searching for a sometimes-elusive ideal. > > The *good* thing is that, so far, David has turned out to be rather good > at this (in my opinion - I'm not very good at "humble" - at least). Oh, I agree - I've been very impressed with what I've seen so far. > BTW - glad to see Richard joining in - the more the merrier. > > Tibs > ...hoping to get back to spare-time work on DPS next week some time... Heh - here's hoping I can get some real time to devote to it. I'm definitely interested in incorporating ReST into Zope3, for example (though I haven't raised that with the Zope guys yet). Richard |