You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
260 lines
12 KiB
260 lines
12 KiB
<!DOCTYPE HTML>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
<title>Semantic Modules</title>
|
|
|
|
<link rel="stylesheet" href="../src/ui/flat/state.js" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="../src/ui/flat/panel.css" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="../src/ui/flat/button.css" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="../src/ui/flat/menu.css" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="../src/ui/flat/form.css" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="../src/ui/flat/icons.css" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="../src/ui/flat/table.css" type="text/css" media="screen" />
|
|
|
|
<link rel="stylesheet" href="../src/modules/shape.css" type="text/css" media="screen" />
|
|
|
|
<link rel="stylesheet" href="library/sidr.css" type="text/css" media="screen" />
|
|
<link rel="stylesheet" href="stylesheets/example.css" type="text/css" media="screen" />
|
|
|
|
<script src="../dependencies/jquery.js" type="text/javascript"></script>
|
|
<script src="../src/modules/behavior/state.js" type="text/javascript"></script>
|
|
|
|
<script src="library/sidr.js" type="text/javascript"></script>
|
|
<script src="library/waypoints.js" type="text/javascript"></script>
|
|
<script src="javascript/example.js" type="text/javascript"></script>
|
|
|
|
</head>
|
|
|
|
<body id="example">
|
|
|
|
<div class="sidr" id="menu">
|
|
<ul>
|
|
<li class="active"><a href="module.html">Introduction</a></li>
|
|
<li><a>Download</a></li>
|
|
<li><a href="#">UI</a>
|
|
<ul>
|
|
<li><a href="button.html">Button</a></li>
|
|
<li><a>Text</a></li>
|
|
<li><a>Headers</a></li>
|
|
<li><a>Columns</a></li>
|
|
<li><a>Elements (Grid System)</a></li>
|
|
<li><a>Tags</a></li>
|
|
<li><a>Items (Lists of Content)</a></li>
|
|
<li><a>Panels (Type of Menu)</a></li>
|
|
<li><a>Forms</a></li>
|
|
<li><a>Fields</a></li>
|
|
<li><a>Checkboxes</a></li>
|
|
<li><a>Icons</a></li>
|
|
<li><a>Dividers</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">UI Modules</a>
|
|
<ul>
|
|
<li><a>Accordion</a></li>
|
|
<li><a>Chat Room</a></li>
|
|
<li><a>Modal</a></li>
|
|
<li><a>Nag</a></li>
|
|
<li><a>Popup</a></li>
|
|
<li><a>Search</a></li>
|
|
<li><a>Star Rating</a></li>
|
|
<li><a>Tabs</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Behavioral Modules</a>
|
|
<ul>
|
|
<li><a>API</a></li>
|
|
<li><a>Animation</a></li>
|
|
<li><a>Form Validation</a></li>
|
|
<li><a>Placeholder Text</a></li>
|
|
<li><a class="shape.html">Shape</a></li>
|
|
<li><a>State</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="ui large fixed transparent black menu">
|
|
<div class="container">
|
|
<div class="title item">
|
|
Semantic UI: Introduction
|
|
</div>
|
|
<div class="previous link item">
|
|
<i class="icon left-open"></i>
|
|
</div>
|
|
<div class="section dropdown page item">
|
|
1 <span class="of">of</span> 5
|
|
<div class="menu">
|
|
<div class="active item">1. Introduction</div>
|
|
<div class="item">2. Download</div>
|
|
<div class="item">3. UI Library</div>
|
|
<div class="item">4. UI Modules</div>
|
|
<div class="item">5. Behavioral Modules</div>
|
|
</div>
|
|
</div>
|
|
<div class="next link item">
|
|
<i class="icon right-open"></i>
|
|
</div>
|
|
<a class="right item" href="http://github.com/quirky/quirkyinc/semantic">
|
|
<i class="icon github"></i>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div class="ui huge left attached vertical side buttons">
|
|
<div class="ui menu blue button"><i class="icon th-list"></i> Menu</div>
|
|
</div>
|
|
<div class="segment">
|
|
<div class="container">
|
|
<h1>Semantic</h1>
|
|
<p>UI is the DNA of the web. Semantic empowers designers and developers by creating a shared vocabulary for UI.</p>
|
|
</div>
|
|
</div>
|
|
<div class="main container">
|
|
|
|
<div class="ui large vertical pointing panel peek">
|
|
<li class="active">What is Semantic?</li>
|
|
<li>The UI Spec</li>
|
|
<li>The Module Spec</li>
|
|
<li>The Semantic Library</li>
|
|
</div>
|
|
<h2>What is Semantic?</h2>
|
|
|
|
<p>Semantic has two parts. The <a href="#standard">semantic specification</a>, and the <a href="#library">semantic library</a>.</b></p>
|
|
|
|
<a name="standard"></a>
|
|
<h2>The UI Specification</h2>
|
|
<p>The semantic specification creates a standard language for describing user interface elements.</p>
|
|
|
|
<table class="ui table">
|
|
<tr>
|
|
<td>UI Elements</td>
|
|
<td>UI Only</td>
|
|
<td>menus, columns, grids, tables, buttons, forms</td>
|
|
</tr>
|
|
<tr>
|
|
<td>UI Modules</td>
|
|
<td>UI + Behavior</td>
|
|
<td>popups, modals, chat rooms</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Behavioral Modules</td>
|
|
<td>Behavior Only</td>
|
|
<td>form validation, state management, polyfills, history</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Exchanging Designs</h3>
|
|
<p>Semantic creates an exchange format for UI, by defining HTML structures and class names for UI elements that attempt to create a common language and make front end development <a href="http://instruct.westvalley.edu/lafave/DFW_present_tense.html">less prescriptive</a>.</p>
|
|
<p>Sharing a language for UI releases the burden from developers at being a naming authorities in their own projects. We can share a common visual vocabulary as a community, and design interchangeable interface elements without having to rely on the prescribed standards of a single developer.</p>
|
|
|
|
<h3>What's in an Element?</h3>
|
|
<p>UI elements definitions are made of 4 parts:
|
|
<table class="ui table">
|
|
<tr>
|
|
<td>A prototype form of an element</td>
|
|
<td>A bunny has two long ears and is furry</td>
|
|
<tr>
|
|
<td>A definition of the relationship between a plural and singular instance of an element</td>
|
|
<td>Three white bunnies are each white</td>
|
|
</tr>
|
|
<tr>
|
|
<td>A definition of possible variations of the element</td>
|
|
<td> A bunny can be large or small and can be spotted or fuzzy</td>
|
|
</tr>
|
|
<tr>
|
|
<td>A list of states which the element can exist</td>
|
|
<td> A bunny can either be hopping, eating or sitting still</td>
|
|
</tr>
|
|
</table>
|
|
<p>UI elements can be thought of as nouns, and variations as adjectives. Variations are written so to only describe the innate features of that variation, and must account for the differences when declared along-side other variations.</p>
|
|
<p>For example, in English, a large planet has a different meaning than a large chair, and would require different specific contextual definitions, but both are the same variant "largeness" to the person using the word.</p>
|
|
<p>Variations can be used together without negating each other unless used in a paradoxical way (A large small bunny).</p>
|
|
|
|
<h3>Just Show Me the Code</h3>
|
|
<p>If you'd like to shortcut any more explanation, check out the standard definition for a UI button for a live example.</p>
|
|
<a class="blue ui button" href="button.html">UI Button Spec</a>
|
|
|
|
<h2>The Module Specification</h2>
|
|
<p>In Semantic, modules are user interface elements which require a behavioral definition. For example, a pop-up is understood by the actual action that occurs, it "pops up". Without this logic any pop-up is incomplete.</p>
|
|
<p>Semantic UI modules have two components, a definition of the UI element and a behavioral definition in javascript. Semantic includes a standard javascript module pattern, which helps in defining interface elements in a similar context to UI.</p>
|
|
|
|
<p>The goal of the module design pattern is primarily to accomplish three things:</p>
|
|
<ol>
|
|
<li>Make debugging modules simpler by making techniques like performance profiling, and logging easier and more useful.</li>
|
|
<li>Make understanding new code easier, by defining a common pattern for initializing, destroying elements, modifying settings, and allowing more advanced features.</li>
|
|
<li>Reduce prescriptive aspects of</li>
|
|
</ol>
|
|
|
|
<h3>Why use Semantic Modules?</h3>
|
|
<ol>
|
|
<li><b>Puts accessibility first</b>.
|
|
<p>Although Coffeescript is beautiful, and Angular is smart, Semantic has a different agenda: to be easy to use, and opinionless. Semantic can be thought of more as the <a href="http://en.wikipedia.org/wiki/Aaron_Copland">Aaron Copland</a> of programming libraries. It only requires an understanding of jQuery and Javascript to begin writing code. If you're stuck there are also <a href="#">plenty of examples</a> to help you get started.</p>
|
|
</li>
|
|
<li><b>Is self documenting.</b>
|
|
<p>Instead of reading through inline comments to determine what a developer is intending, semantic allows developers to pass meaningful debug data where its most useful: the javascript console. This allows you to see the sequence of events that occur in a module , along with useful debug information, like the value of significant variables. If you're in the source code, debug statements also read similarly to code comments which provide context. <a href="#">Show me</a>
|
|
</p>
|
|
</li>
|
|
<li><b>Separates arbitrary decisions from the fundamental mechanics of your module.</b>
|
|
<p>Ever scroll through an unfimiliar library looking for the line of code where they define the ID tag for an expected html structure? Semantic keeps you from ever having to do that again. Developer decisions like metadata, classnames, selectors, and messages are separated from the less arbitrary parts of code. <a href="#">Show me</a></p>
|
|
</li>
|
|
<li><b>Lets you access anything, and change everything.</b>
|
|
<p>Methods defined as part of module definitions are all invokable. Semantic also maps from dot notation to their appropriate locations inside the module, allowing developers not to only make flat modules. Settings can be changed at initialization, or after. Module defaults can be changed whenever. <a href="#">Show me</a></p>
|
|
</li>
|
|
<li><b>Plays nice with other libraries</b>.
|
|
<p>Modules include a destroy method which will remove any bound events or initialized code. Modules also use namespaced events so you can have more flexibility over defining and clearing them
|
|
</p>
|
|
</li>
|
|
<li><b>Patterns for every need</b>.
|
|
<p>Semantic has patterns that work well both as a widget factory, and as a single entity.</p>
|
|
</li>
|
|
</ol>
|
|
|
|
<h3>You really like to talk. Lets see some code</h3>
|
|
<p>For a complete definition of the specification check to annotated source:</p>
|
|
|
|
<div class="ui blue buttons">
|
|
<a class="ui button">Single Instance</a>
|
|
<a class="ui button" href="generated/multiple.html">Many Instances</a>
|
|
</div>
|
|
|
|
<a name="library"></a>
|
|
<h2>The Libraries</h2>
|
|
<p>To semantic library is a set of UI elements and javascript modules that provides an example implementation of the Semantic standard. The purpose is to be useful in their own right for developers, but also to provide a guide for how the standard can be used.</p>
|
|
<h3>The UI Library</h3>
|
|
<ul class="list">
|
|
<li><a href="button.html">Buttons</a></li>
|
|
<li><a>Text</a></li>
|
|
<li><a>Headers</a></li>
|
|
<li><a>Columns</a></li>
|
|
<li><a>Elements (Grid System)</a></li>
|
|
<li><a>Tags</a></li>
|
|
<li><a>Items (Lists of Content)</a></li>
|
|
<li><a>Panels (Type of Menu)</a></li>
|
|
<li><a>Forms</a></li>
|
|
<li><a>Fields</a></li>
|
|
<li><a>Checkboxes</a></li>
|
|
<li><a>Icons</a></li>
|
|
<li><a>Dividers</a></li>
|
|
</ul>
|
|
<h3>The module library</h3>
|
|
<p>Javascript modules.</p>
|
|
<ul class="list">
|
|
<li>Accordion</li>
|
|
<li>API</li>
|
|
<li>Animation</li>
|
|
<li>Chat Room</li>
|
|
<li>Form Validation</li>
|
|
<li>Placeholder Text</li>
|
|
<li>Modal</li>
|
|
<li>Nag</li>
|
|
<li>Popup</li>
|
|
<li>Search</li>
|
|
<li>Star Rating</li>
|
|
<li>Shape</li>
|
|
<li>State</li>
|
|
<li>Tabs</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</body>
|
|
|
|
</html>
|