Browse Source

Rewrite of intro docs

beta
jlukic 11 years ago
parent
commit
8906cba6a6
  1. 54
      server/documents/introduction.html.eco
  2. 6
      server/documents/introduction/definitions.html.eco
  3. 23
      server/documents/introduction/overview.html.eco
  4. 28
      server/documents/introduction/types.html.eco

54
server/documents/introduction.html.eco

@ -1,9 +1,8 @@
---
layout : 'default'
css : 'guide'
title : 'Introduction'
description : 'Getting to know Semantic UI'
title : "What's Different"
description : 'Separating Semantic from the pack'
type : 'Semantic'
---
<script src="/javascript/intro.js"></script>
@ -17,31 +16,56 @@ type : 'Semantic'
</div>
</div>
<h2 class="ui dividing header">What's Different?</h2>
<h2 class="ui header">
Designed Completely with EM
<div class="sub header">asdoiasdjasdoji</div>
</h2>
<p>Every component is defined using <code>em</code> and <code>rem</code> so that components can be resized simply on the fly. Want a menu to get smaller on mobile? Simply have it's font-size change using a media query.</p>
<h3 class="ui header">Descriptive not Prescriptive</h3>
<p> Writing front end code shouldn't require learning the naming or programming conventions of a particular developer. Instead of using short-hand, or codified naming conventions, Semantic uses simple, common language for parts of interface elements, and familiar patterns found in natural languages for describing elements.</p>
<h2 class="ui header">
Self Explanatory
<div class="sub header">Descriptive not Prescriptive</div>
</h2>
<p> Writing front end code shouldn't require learning the naming or programming conventions of a particular developer.</p>
<p>Instead of using short-hand, or codifying naming conventions, Semantic uses simple, common language for parts of interface elements, and familiar patterns found in natural languages for describing elements.</p>
<h3 class="ui header">Tag ambivalent.</h3>
<h2 class="ui header">
Tag ambivalent
<div class="sub header">Use whatever html tags you please.</div>
</h2>
<p>Interface definitions in Semantic are tag ambivalent. That means you can use div, article, section, span without affecting the display of the element. Special tags like a, table, td still carry special meaning in certain circumstances however.</p>
<h3 class="ui header">Powerful tools for expressing groups and collections.</h3>
<h2 class="ui header">
Powerful tools for expressing groups and collections.
<div class="sub header">Don't repeat yourself</div>
</h2>
<p>In English it's much easier to say "There are three tall men" than "There is a tall man, a tall man and a tall man".</p>
<p>In Semantic element definitions can be expressed in groups have shared attributes like size, color, type avoiding repetitive declarations.</p>
<h3 class="ui header">Portable and self-contained.</h3>
<p>UI components in Semantic can be used individually, defining optional couplings with other components where their usage intersect. That means choosing to use semantic doesn't mean adopting an entire framework, or rewriting your codebase. You can pick and choose what elements you want to use.</p>
<h2 class="ui header">
Portable and self-contained.
<div class="sub header">Using Semantic doesn't mean adopting an entire framework, or rewriting your codebase</div>
</h2>
<p>Semantic components are written in a singular style, but are not part of mandated overarching library. Only like a couple components? No problem, use only what you need.</p>
<p>UI components in Semantic also define optional and required couplings with other components where their usage intersect. That means for example, a popup can check for the existence of CSS animation component before using the fallback javascript animations.</p>
<h2 class="ui header">
Shared language, different implementations
<div class="sub header">Restyle your site without Restructuring it</div>
</h2>
<h3 class="ui header">Shared language, different implementations</h3>
<p>Describing your site's content using a common language like Semantic allows other developers to create UI definitions to match one shared vocabulary. This means you can redesign your website without retooling your html. Simply alter the look and feel of your UI using a different UI style definition.</p>
<h3 class="ui header">Only the important stuff</h3>
<p>Instead of giving every possible variation, or behavior under the sun, element definitions are designed to be a starting off point. No oversized downloads, or kitchen sink, just the stuff to get you started.</p>
<h2 class="ui header">
Only the important stuff
<div class="sub header">Not the kitchen sink</div>
</h2>
<p>Instead of giving every possible variation or behavior under the sun, element definitions are designed to be a starting off point. No oversized downloads with optional features you will most likely never use, just the stuff to get you going.</p>
<div class="ui horizontal divider"><i class="circular heart icon"></i></div>
<a class="ui huge right labeled teal icon button" href="/introduction/getting-started.html">
Next: Getting Started
<a class="ui large right labeled teal icon button" href="/introduction/definitions.html">
Next: UI Definitions
<i class="right arrow icon"></i>
</a>

6
server/documents/introduction/definitions.html.eco

@ -247,9 +247,9 @@ type : 'UI Introduction'
<li>Product List</li>
</ul>
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/introduction/types.html">
Next: Element Types
<div class="ui section divider"></div>
<a class="ui large right labeled teal icon button" href="/introduction/overview.html">
Next: Semantic Coding
<i class="right arrow icon"></i>
</a>

23
server/documents/introduction/getting-started.html.eco → server/documents/introduction/overview.html.eco

@ -2,8 +2,8 @@
layout : 'default'
css : 'guide'
title : 'Semantic Coding'
description : 'An introduction to Semantic coding'
title : 'Overview'
description : 'An introduction to Semantic style coding'
type : 'UI Introduction'
---
<script src="/javascript/intro.js"></script>
@ -31,11 +31,18 @@ $(document)
<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>
<div class="code" data-type="html" data-title="A Simple Menu" data-preview="true">
<div class="ui menu">
<a class="item">Home</a>
<a class="item">Inbox</a>
</div>
</div>
<h3 class="ui header">Changing an Element</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>
<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>
<div class="code" data-type="html" data-label="true" data-preview="true">
<div class="code" data-type="html" data-title="A Compact Menu Variation" data-preview="true">
<div class="ui compact menu">
<a class="item">Home</a>
<a class="item">Inbox</a>
@ -48,7 +55,7 @@ $(document)
<p>For example you might want to include a badge inside a menu. A label inside of a menu will automatically function as a badge.</p>
<div class="code" data-type="html" data-label="true" data-preview="true">
<div class="code" data-type="html" data-title="Using a UI Label inside a UI Menu" data-preview="true">
<div class="ui compact menu">
<a class="item">Home</a>
<a class="item">
@ -102,8 +109,8 @@ $(document)
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/introduction/definitions.html">
Next: UI Definitions
<a class="ui large right labeled teal icon button" href="/introduction/types.html">
Next: UI Types
<i class="right arrow icon"></i>
</a>

28
server/documents/introduction/types.html.eco

@ -3,7 +3,7 @@ layout : 'default'
css : 'guide'
title : 'Types'
description : 'A type is an mutually exclusive change to an element'
description : 'A type is an mutually exclusive version of an element'
type : 'UI Introduction'
---
<script src="/javascript/intro.js"></script>
@ -18,12 +18,28 @@ 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 ui definition in Semantic usually contains a list of mutually exclusive variations on an element design. A type is designated by an additional class name on a UI element</p>
<div class="code" data-type="html" data-preview="true" data-title="Types of UI Button">
<div class="ui labeled icon button">
Download <i class="download icon"></i>
</div>
<div class="ui icon button">
<i class="download icon"></i>
</div>
<div class="ui button">
Download
</div>
<div class="ui facebook button">
<i class="facebook icon"></i>
Facebook
</div>
</div>
<h3 class="ui header">Content</h3>
<p>For example, an icon menu might expect different content like icons glyphs instead of text to be formatted correctly</p>
<p>Types may require different html structures to work correctly. 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="code" data-type="html" data-title="Icon Menu Type" data-preview="true">
<div class="ui icon menu">
<a class="item">
<i class="mail icon"></i>
@ -38,9 +54,9 @@ type : 'UI Introduction'
</div>
<h3 class="ui header">HTML Differences</h3>
<p>Types may also require different html. For example, a tiered menu needs html specified for a sub menu to display itself correctly</p>
<p>Types may also each require slightly different html. For example, a tiered menu needs html specified for a sub menu to display itself correctly</p>
<div class="code" data-type="html" data-label="true" data-preview="true">
<div class="code" data-type="html" data-title="Tiered Menu Type" data-preview="true">
<div class="ui tiered menu">
<div class="menu">
<div class="active item">

Loading…
Cancel
Save