Changes between Version 1 and Version 2 of MarkupConventions

Show
Ignore:
Timestamp:
07/17/10 05:36:11 (4 years ago)
Author:
MtnViewMark (IP: 198.144.208.18)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MarkupConventions

    v1 v2  
    4646Expected general formatting: 
    4747 
    48 * constructors - shown side-by-side w/doc 
    49 ** fields   - shown side-by-side w/doc 
    50 ** GADT args- shown side-by-side w/doc (does this exist?) 
    51 * methods      - shown stacked w/doc 
    52 ** args     - shown side-by-side w/doc (?) 
    53 * associated types - shown stacked w/doc 
    54 ** args     - shown side-by-side w/doc (?) 
    55 * args         - shown side-by-side w/doc 
    56 * instances    - shown side-by-side w/doc (in classes) 
    57 * instances    - just a list (no doc for types) 
     48 * constructors - shown side-by-side w/doc 
     49 ** fields   - shown side-by-side w/doc 
     50 ** GADT args- shown side-by-side w/doc (does this exist?) 
     51 * methods      - shown stacked w/doc 
     52 ** args     - shown side-by-side w/doc (?) 
     53 * associated types - shown stacked w/doc 
     54 ** args     - shown side-by-side w/doc (?) 
     55 * args         - shown side-by-side w/doc 
     56 * instances    - shown side-by-side w/doc (in classes) 
     57 * instances    - just a list (no doc for types) 
    5858                 
    5959{{{         
     
    7373== basic structure == 
    7474 
    75 * `div#xxx`     -- major page divs only 
    76 * `p.caption`   -- fixed header for some page sections & the name of the module (in .module-header) 
    77 * `h1`, `h2`...   -- interface's organization only 
     75 * `div#xxx`     -- major page divs only 
     76 * `p.caption`   -- fixed header for some page sections & the name of the module (in .module-header) 
     77 * `h1`, `h2`...   -- interface's organization only 
    7878 
    7979== formatting == 
    8080 
    81 * `.src`        -- declaration source - for source code styling applied to `li`, `p`, and `dt`, such source is *not* part of documentation 
     81 * `.src`        -- declaration source - for source code styling applied to `li`, `p`, and `dt`, such source is *not* part of documentation 
    8282 
    8383== documentation == 
    8484 
    85 * `p` 
    86 * `ul` 
    87 * `ol` 
    88 * `pre`         -- for blocks of preformatted code 
    89 * `code`        -- for inline source code 
    90 * `a`           -- both in-line and external links 
     85 * `p` 
     86 * `ul` 
     87 * `ol` 
     88 * `pre`         -- for blocks of preformatted code 
     89 * `code`        -- for inline source code 
     90 * `a`           -- both in-line and external links 
    9191 
    9292these are all "unadorned" by classes, or wrappers 
     
    9696== declaration structures == 
    9797 
    98 * `.short`- an element containing a single, "short" declaration, used in `#synopsis` and in mini-pages 
    99 * `.top` - an element containing a single, top level declaration & its doc, used in `#interface` 
    100 * `.subs` - an element containing multiple, sub-declaration parts of a decl 
    101 * `.arguments`, `.constructors`, `.methods`, `.instances`, `.associated-types`    -- various kinds of `.subs` 
     98 * `.short`- an element containing a single, "short" declaration, used in `#synopsis` and in mini-pages 
     99 * `.top` - an element containing a single, top level declaration & its doc, used in `#interface` 
     100 * `.subs` - an element containing multiple, sub-declaration parts of a decl 
     101 * `.arguments`, `.constructors`, `.methods`, `.instances`, `.associated-types`    -- various kinds of `.subs` 
    102102 
    103103