yak
[Top] [All Lists]

[yak@collab] SmashedWord Style Guide

To: yak <yak@xxxxxxxxxxxxxxxxxxx>
From: Eric Armstrong <Eric.Armstrong@xxxxxxx>
Date: Wed, 03 Mar 2004 15:21:11 -0800
Message-id: <40466867.7040200@sun.com>
Recommendations for effective use of the
SmashedWord style in Wiki pages:    (01)

1. A SmashedWord in CamelCase is necessary
    to create a Wiki page, but not to
    reference it.    (02)

2. The Smashed Word separated by spaces, and
    with initial caps should be recognized as a
    Wiki word and automatically linked.    (03)

3. An open question is whether the following
    should be recognized as Wiki words:
      * Smashed word
      * smashed word
      * smashed Word    (04)

    These posibilities allow for variants of the
    basic style.    (05)

4. In any Wiki page, only the first occurence
    of a Wiki word should be visible, so that you
    see:
       A _SmashedWord_ is useful because a
       SmashedWord lets you identify an important
       concept, without confusing it with something
       that is not a SmashedWord.    (06)

    instead of:
       A _SmashedWord_ is useful because a
       _SmashedWord_ lets you identify an important
       concept, without confusing it with something
       that is not a _SmashedWord_.    (07)

   The other words can be linked, but they should be
   rendered in the normal font.    (08)


-- 
This message is archived at:    (09)

http://collab.blueoxen.net/forums/cgi-bin/mesg.cgi?a=yak&i=40466867.7040200@sun.com    (010)
<Prev in Thread] Current Thread [Next in Thread>