Bug 20009
| Summary: | [PATCH] the FAQ needs an entry on bikesheds | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | brooks <brooks> | ||||
| Component: | Books & Articles | Assignee: | alex <alex> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | ||||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
|
Description
brooks
2000-07-18 17:40:01 UTC
On Mon, 17 Jul 2000 23:13:54 MST, brooks@one-eyed-alien.net wrote: > People are confused by all the refrences on hackers, etc. to the color > of bikesheds. There should be a FAQ about this. Personally, I'd just give a reference to phk's original message. Ciao, Sheldon. On Tue, Jul 18, 2000 at 06:49:03PM +0200, Sheldon Hearn wrote:
> On Mon, 17 Jul 2000 23:13:54 MST, brooks@one-eyed-alien.net wrote:
> > People are confused by all the refrences on hackers, etc. to the color
> > of bikesheds. There should be a FAQ about this.
>
> Personally, I'd just give a reference to phk's original message.
The problem with that is that it won't work in print on offline. I don't
think it's very helpful to have FAQ entries that don't directly give
some sort of useful answer unless it's really not possiable.
-- Brooks
--
Any statement of the form "X is the one, true Y" is FALSE.
On Tue, 18 Jul 2000 10:10:33 MST, Brooks Davis wrote:
> The problem with that is that it won't work in print on offline. I don't
> think it's very helpful to have FAQ entries that don't directly give
> some sort of useful answer unless it's really not possiable.
Ah yes, good point.
Ciao,
Sheldon.
brooks@one-eyed-alien.net wrote: > People are confused by all the refrences on hackers, etc. to the color > of bikesheds. There should be a FAQ about this. I'm starting to think we'll need a "FreeBSD Jargon" section of the FAQ soon. We'd only really have four things to put it in for now though (MFC, repo-copy, bike shed, fairings) so I don't think it's worth it yet. OTOH, the kernel config part only has four questions, so perhaps we could. > + <para>"What is it about this bike shed ?" Some of you have I'd use “...” instead of "..." [I think that's right, it's either &[lr]dquo; or <quote>, not ".." anyway. I think the last agreement was &[lr]dquo;.] > + paying attention, that he is *here*.</para> Perhaps <emphasis>foo</emphasis> instead of *foo*, or something. The FAQ isn't limited to ASCII text like email is. :-) Other than that, this should probably go in the FAQ soon. I'll fix those minor things and maybe commit it soonish. /me adds it to TODO list. -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / On Tue, Jul 18, 2000 at 07:17:30PM +0100, Ben Smithurst wrote: > brooks@one-eyed-alien.net wrote: > > > People are confused by all the refrences on hackers, etc. to the color > > of bikesheds. There should be a FAQ about this. > > I'm starting to think we'll need a "FreeBSD Jargon" section of the FAQ > soon. We'd only really have four things to put it in for now though > (MFC, repo-copy, bike shed, fairings) so I don't think it's worth it > yet. OTOH, the kernel config part only has four questions, so perhaps > we could. That might not be a bad idea. The question in my mind is where do glossary entries stop (MFC and repo-copy seem to me to be those) and where do FAQ entries begin (bikeshed and fairings have significant context in their defination). > > + <para>"What is it about this bike shed ?" Some of you have > > I'd use “...” instead of "..." > > [I think that's right, it's either &[lr]dquo; or <quote>, not ".." > anyway. I think the last agreement was &[lr]dquo;.] I'm almost certain it was decided to do it the other way so quote characters would be automagicaly matched and localized properly. The problem was that quote styles aren't even consistant withing the same language. For instance, I've got at least one book published in the UK that uses quotes that look kinda like >>foo bar baz<< (except there are specific quote characters. > > + paying attention, that he is *here*.</para> > > Perhaps <emphasis>foo</emphasis> instead of *foo*, or something. The > FAQ isn't limited to ASCII text like email is. :-) I though of doing that, but it's quoted text. We could do that, but I'd want to be sure that the * (or similar) emphasis marks where being added in the text version. I don't know what w3m does. > Other than that, this should probably go in the FAQ soon. I'll fix > those minor things and maybe commit it soonish. Thinking about it some more, I think I'd also strike the <title> text from the blockquote. It's redundent and the rendering in HTML looks kinda stupid IMHO. -- Brooks -- Any statement of the form "X is the one, true Y" is FALSE. Brooks Davis wrote: > I'm almost certain it was decided to do it the other way so quote > characters would be automagicaly matched and localized properly. yep, you're right. I just checked some CVS logs. That means a couple of things I added recently are wrong. I guess I could put &[lr]dquo; -> <quote></quote> on my list of things to cleanup in the FAQ then. As well as "foo", 'foo', `foo', ``foo'', and $DEITY only knows how many other quoting styles are used. >>> + paying attention, that he is *here*.</para> >> >> Perhaps <emphasis>foo</emphasis> instead of *foo*, or something. The >> FAQ isn't limited to ASCII text like email is. :-) > > I though of doing that, but it's quoted text. We could do that, but > I'd want to be sure that the * (or similar) emphasis marks where being > added in the text version. I don't know what w3m does. It doesn't add "*" in the text version. How important is that? I'd argue that removing that is just changing formatting and is no worse than re-wrapping the lines or changing "foo" to <quote>foo</quote>. *foo* is going to come out real ugly in HTML. :-( -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / On Tue, Jul 18, 2000 at 08:42:58PM +0100, Ben Smithurst wrote: > >>> + paying attention, that he is *here*.</para> > >> > >> Perhaps <emphasis>foo</emphasis> instead of *foo*, or something. The > >> FAQ isn't limited to ASCII text like email is. :-) > > > > I though of doing that, but it's quoted text. We could do that, but > > I'd want to be sure that the * (or similar) emphasis marks where being > > added in the text version. I don't know what w3m does. > > It doesn't add "*" in the text version. How important is that? I'd > argue that removing that is just changing formatting and is no worse > than re-wrapping the lines or changing "foo" to <quote>foo</quote>. > *foo* is going to come out real ugly in HTML. :-( I guess that's reasionable. I'd say it's a bug that emphasis is dropped in the ASCII mode, but that you're right in that we should either clean the text up to look like normaly formatted DocBook text or include it in the DocBook equivalent of <pre> tags. There's a cleaned up diff with "'s and *'s replaced at: http://www.one-eyed-alien.net/~brooks/FreeBSD/bikeshed.diff -- Brooks -- Any statement of the form "X is the one, true Y" is FALSE. Responsible Changed From-To: freebsd-doc->alex I'll add it State Changed From-To: open->closed Entry added, thank you! |
