Browse Source

iterating on intro docs

pull/258/head
jlukic 11 years ago
parent
commit
f672b074d9
5 changed files with 22 additions and 33 deletions
  1. 31
      node/src/documents/introduction/definitions.html.eco
  2. 12
      node/src/documents/introduction/getting-started.html.eco
  3. 4
      node/src/documents/introduction/types.html.eco
  4. 6
      node/src/draft/specification/getting-started.html
  5. 2
      node/src/files/stylesheets/semantic.css

31
node/src/documents/introduction/definitions.html.eco

@ -1,7 +1,6 @@
---
layout : 'default'
css : 'guide'
status : 'draft'
title : 'Definitions'
description : 'Definitions provide a re-usable format for sharing an interface design'
@ -15,10 +14,7 @@ type : 'UI Introduction'
<div class="ui vertical pointing secondary menu">
<a class="active item">Definitions</a>
<a class="item">Elements</a>
<a class="item">Collections</a>
<a class="item">Modules</a>
<a class="item">Views</a>
<a class="item">Authoring</a>
<a class="item">Types</a>
</div>
</div>
@ -163,8 +159,9 @@ type : 'UI Introduction'
</tr>
</tr>
</table>
<h2 class="ui dividing header">Types of Definitions</h2>
<h2 class="ui dividing header">UI Elements</h2>
<h3 class="ui dividing header">UI Elements</h3>
<p>UI Elements are page elements which are indivisible. This can be thought of as similar in definition as an "element" in chemistry.</p>
@ -214,7 +211,7 @@ type : 'UI Introduction'
</tr>
</table>
<h2 class="ui dividing header">UI Collections</h2>
<h3 class="ui dividing header">UI Collections</h3>
<p>UI Collections are groups of heterogeneous page elements which are usually found together. Carrying the chemistry metaphor, these can be thought of as molecules.</p>
@ -228,9 +225,9 @@ type : 'UI Introduction'
<li>Menus</li>
</ul>
<h2 class="ui dividing header">UI Modules</h2>
<h3 class="ui dividing header">UI Modules</h3>
<p>UI modules are elements where it's behavior is a fundamental part of its definition. UI Modules are dependent on the javascript which carry their definition. They also may be more complex, and have a variety of different functions. Further abusing the scientific analogy: These can be thought of as "organs".</p>
<p>UI modules are elements whose behavior is a fundamental part of its definition. UI Modules are usually dependent on javascript which carries the implementation of it's behavior, although in some special circumstances the behavior can include css alone.</p>
<p>Examples of UI modules:</p>
<ul class="ui list">
@ -239,9 +236,9 @@ type : 'UI Introduction'
<li>Chat Rooms</li>
</ul>
<h2 class="ui dividing header">UI Views</h2>
<h3 class="ui dividing header">UI Views</h3>
<p>UI Views are common ways to present content so that it can be understood more easily. A view's definition in semantic only describes the content which typically occupies the view.</p>
<p>UI Views are common tropes for presenting specific types of information. Unlike collections which focus specifically on the relation of interface elements, views focus specifically on the relation of site content to other pieces of site content.</p>
<h3 class="ui header">Examples of UI views:</h3>
<ul class="ui list">
@ -250,22 +247,10 @@ type : 'UI Introduction'
<li>Product List</li>
</ul>
<!-- <a class="ui large right labeled teal icon button">
Authoring Guide
<i class="right arrow icon"></i>
</a>
-->
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/introduction/types.html">
Next: Element Types
<i class="right arrow icon"></i>
</a>
<!--
<h3 class="ui header" class="ui header">Known Limitations</h3>
<p>Semantic uses the UI namespace to separate element definitions from the content that they define. This means that namespaces might conflict with other definitions if a variation or a type used matches the namespace of another ui definition.</p>
-->
</div>

12
node/src/documents/introduction/getting-started.html.eco

@ -2,7 +2,7 @@
layout : 'default'
css : 'guide'
title : 'Getting Started'
title : 'Semantic Coding'
description : 'An introduction to Semantic coding'
type : 'UI Introduction'
---
@ -21,13 +21,17 @@ $(document)
<div class="main container">
<div class="peek">
<div class="ui vertical pointing secondary menu">
<a class="active item">Interfacing Carefully</a>
<a class="item">Semantic APIs</a>
<a class="active item">Interfacing</a>
<a class="item">APIs</a>
</div>
</div>
<h2 class="ui dividing header">Interfacing Carefully</h2>
<p>UI definitions in Semantic are given the class name <code>ui</code>. This is to help tell the difference between ui elements and parts of the definition of an element. For example a menu may have menu items inside of it. These items are contained as part of the menu definition but do not receive the class name <code>ui</code>.</p>
<p>UI definitions in Semantic are given the class name <code>ui</code>. This is to help tell the difference between ui elements and parts of the definition of an element. This means any element with the class name UI has a corresponding UI definition.
<p>For example a menu may have menu items inside of it. These items are contained as part of the menu definition but do not receive the class name <code>ui</code> because they are part of a UI menu collection.</p>
<h3 class="ui header">Namespacing</h3>
<p>Class names in semantic always use single english words. If a class name is an adjective it is either a <a href="/introduction/types.html">type</a> of element or <a href="/introduction/variations.html">variation</a> of an element. <b>CSS definitions always define adjectives in the context of a noun</b>. In this way class names cannot pollute the namespace.</p>

4
node/src/documents/introduction/types.html.eco

@ -18,10 +18,10 @@ type : 'UI Introduction'
<h2 class="ui dividing header">Overview</h2>
<p>A <b>type</b> is a mutually exclusive change to an element. Types may require different html structures to work correctly, or expect different content.</p>
<p>A <b>type</b> is a mutually exclusive change to an element. Types may require different html structures to work correctly, or expect different content. </p>
<h3 class="ui header">Content</h3>
<p>An icon menu might expect you to include glyphs instead of text to be formatted correctly</p>
<p>For example, an icon menu might expect different content like icons glyphs instead of text to be formatted correctly</p>
<div class="code" data-type="html" data-label="true" data-preview="true">
<div class="ui icon menu">

6
node/src/draft/specification/getting-started.html

@ -69,7 +69,7 @@ type : 'UI Specification'
</a>
<div class="ui divider"></div>
<h2 class="ui header">Why Use Semantic?</h2>
<p>
@ -79,7 +79,7 @@ type : 'UI Specification'
<h3 class="ui header">Definitions and Language</h3>
<p>Natural language is <em>particularly good</em> at describing visual scenes, i.e. dogs, trees, flowers and hard at defining abstractions: behavior, emotions, etc. Where programming languages are <em>particularly good</em> at describing behavior, but can be more obtuse at describing layouts.</p>
<p>Natural language is <em>particularly good</em> at describing visual scenes, i.e. dogs, trees, flowers and hard at defining abstractions: behavior, emotions, etc. Where programming languages are <em>particularly good</em> at describing behavior, but can be more obtuse at describing layouts.</p>
<p>Semantic adopts concepts from natural languages like: plurals, adjectives, and tense so web developers can enjoy some of the more useful features of natural language. Semantic also aspires for developers to make decision based on common usage instead of deciding arbitrarily how to name things.</p>
@ -130,5 +130,5 @@ type : 'UI Specification'
Semantic components are self documenting, giving you the ability to download a component, and get working immediately. Each component contains a spec file, which describes what a component can do. This is used to generate documentation automatically that lives alongside your project, making sure you know exactly what exists in your CSS.</p>
</div>

2
node/src/files/stylesheets/semantic.css

@ -205,7 +205,7 @@ a:hover {
---------------*/
body.guide .main h3 {
margin: 3rem 0em 0.5rem;
margin: 2rem 0em 0.5rem;
}
body.guide .main.container > * {
max-width: 800px;

Loading…
Cancel
Save