Re: [AD] Documentation update

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


On Wed, 2004-12-08 at 13:21 +0100, Evert Glebbeek wrote:
> > Yes, it does :| What should we do? Maybe just use normal ticks in the
> > _tx, and then let the text output convert it to `', but not the HTML
> > output. (Could do the other way around, but '' is easier to type I
> > find.)
> 
> Well, I find the exact opposite - I'd be really annoyed if I suddenly have
> to use '' instead of `'. ;)
> If the current docs have `', then I suppose it's also more convenient to
> do it this way, as it doesn't involve a lot of doc changes.
> 
> > As it looks, this is something for the new _tx, where all sorts
> > of docs modifications *should* be very easy to do :)
> 
> In that case, maybe consider a <begin quote>...<end quote> scheme
> (<q>...</q>?) in the new _tx documentation. This is neutral with respect to
> `' or ''.
> 

Hm, I assume, English keyboard layouts have a ` key on them. Here, it's
hard to type, requiring a mode switch.

Maybe we could just say that quoted parameter names should use *name*.
That's already used in _tx at some places to emphasize words, and is
easy to type, and looks better (IMHO) than `name', which is quite
assymetrical, since the ` falls left, but the ' doesn't fall right as it
should.

I really like the way wikipedia editing works
(http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page) - maybe
could also steal ideas from them.

But I'm ok with everything not involving a backtick :)

-- 
Elias Pschernig





Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/