Difference between revisions of "Human Interface Guidelines/Introduction"

From Sugar Labs
Jump to: navigation, search
(How to Read This Document)
 
(39 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{hig-nav|prev=Introduction|next=Core Ideas}}
+
<noinclude><div style="background-color: #F5F5F5;">
 +
{{Translations}}{{GoogleTrans-en}}
 +
 
 +
</noinclude>
 +
<div style="background-color: #FFF; margin-left:auto; margin-right: auto; border-left:1px solid #888; border-right:1px solid #888; width: 95%;">
 +
{{hig-nav|prev=Introduction|curr=Introduction|next=Core Ideas}}
 +
<div style="margin: 8px;">
 +
{{TOCright}}
 
==Introduction==
 
==Introduction==
  
 
===Who Should Read This Document===
 
===Who Should Read This Document===
  
These guidelines are targeted primarily at developers who are building tools for the OLPC laptop. They provide an in-depth view of the various features of [[Sugar]], the laptop user interface, and focus closely on the parts of the UI that pertain directly to software development and the ways in which applications, embedded into "[[OLPC_Human_Interface_Guidelines#Activities|activities]]," interact with the operating system.
+
These guidelines are targeted primarily at developers who are building tools for the OLPC laptop. They provide an in-depth view of the various features of [[What is Sugar?|Sugar]], the laptop user interface, and focus closely on the parts of the UI that pertain directly to software development and the ways in which applications, presented as  "[[Human_Interface_Guidelines/Activities|activities]]," interact with the operating system.
  
However, as these guidelines are intended to provide a comprehensive overview of the user interface, these pages should also be of general interest. Hopefully the descriptions of the various UI elements, particularly in the [[OLPC_Human_Interface_Guidelines#The_Laptop_Experience|Laptop Experience]] section, will quench the thirst of all who want to better understand the project and its goals.
+
However, as these guidelines are intended to provide a comprehensive overview of the user interface, these pages should also be of general interest. Hopefully, the descriptions of the various UI elements, particularly in the [[Human_Interface_Guidelines/The_Laptop_Experience|Laptop Experience]] section, will quench the thirst of all who want to better understand the project and its goals.
  
 
===How to Read This Document===
 
===How to Read This Document===
  
Undoubtedly, many who have made it to this page have read at least one set of human-interface guidelines in the past. Nonetheless, we strongly request that you read the content of this document in full. Many of the terms contained within will be quite familiar to you, however, we urge you to review them anyway, since our approach to the user experience shifts away from the traditional desktop. As such, this document may introduce some unfamiliar ideas around such otherwise familiar terms that you should consider throughout development.
+
Although many who make it to this page will have read at least one set of human-interface guideline, we strongly request that you read the content of this document in full. While many of the terms contained within will be quite familiar to you, we urge you to review them anyway, since our approach to the user experience shifts away from some traditional models. This document may introduce some unfamiliar ideas around such otherwise familiar terms that you should consider throughout development.
 +
 
 +
We urge you to read this document once from start to finish, but extensive use of both internal and external hyperlinks will also allow you to peruse its contents at will.  Hopefully, this will make revisiting particular parts of the guidelines quick and easy, and will allow you to move naturally through the most pertinent details.  Additionally, the document has been laid out in a 3-tier structure &mdash; document, chapters, and pages.  Feel free to view the document in full to get a broad picture or to print a hardcopy, or use the integrated navigation to move through one chapter or page at a time.
  
While we would urge you to read this document once from start to finish, extensive use of both internal and external hyperlinking allows you to peruse its contents at will.  Hopefully this will make revisiting particular parts of the guidelines quick and easy, and will allow you to move naturally through the details that pertain most to you.
 
 
{|border=1 cellpadding=1 cellspacing=0 style="float: right; width: 175px; border: 1px #666666 solid; border-collapse: collapse; background: #f9f9f9;"
 
{|border=1 cellpadding=1 cellspacing=0 style="float: right; width: 175px; border: 1px #666666 solid; border-collapse: collapse; background: #f9f9f9;"
 
!style="background:#D6784C"|API Reference
 
!style="background:#D6784C"|API Reference
Line 19: Line 27:
 
|}
 
|}
  
Additionally, where relevant we have included links to the APIs in order to make the relationship between design and implementation clearer.  Please take advantage of this as you develop for the laptops.
+
We have included relevant links to the APIs in order to make the relationship between design and implementation clearer.  Please take advantage of this as you develop for the laptops.
  
 +
===Providing Feedback===
 +
This document remains in constant flux as the project moves forward.  We value any feedback that you might have, and would ask that you share any thoughts and suggestions via the discussion pages.  Discussions surround each tier of the document; if you have specific comments, please post them in the discussion for the corresponding page.  For more general comments, feel free to use the talk pages at the chapter level or for the HIG as a whole.  Links to the talk pages reside next to each section header.
  
 +
<br clear='all'>
 +
</div>{{hig-nav|prev=Introduction|curr=Introduction|next=Core Ideas}}</div>
 +
<noinclude>
  
:Several have noted that we may need to split these guidelines into several wiki pages due to its increasing length. This makes sense for web viewing, but eliminates the possibility of reading straight through the document.  It has been written to read from beginning to end, and this format also provides the ability to print it in its entirety, which we should certainly support.  We could, of course, reformat the entire document as a .pdf once "finished";  we could also just provide a printable page on the wiki that looks as this one does now.  In either case, we have a problem with keeping the two documents in sync after future revisions, but this is surmountable.  Thoughts?
+
 
:: Make each H2 section its own page, transclude them all into this one.  Add a little div around each page with links to the previous and next pages, so that people can catually read the pages one at a time (if they are on a slow connection, for instance). [[User:Sj|Sj]] 16:01, 27 November 2006 (EST)
+
</div></noinclude>
<br clear='all'>
 
{{hig-nav|prev=Introduction|next=Core Ideas}}
 

Latest revision as of 17:13, 22 October 2009

english | español | 한글 | português HowTo [ID# 39506]  +/-  


Introduction

Who Should Read This Document

These guidelines are targeted primarily at developers who are building tools for the OLPC laptop. They provide an in-depth view of the various features of Sugar, the laptop user interface, and focus closely on the parts of the UI that pertain directly to software development and the ways in which applications, presented as "activities," interact with the operating system.

However, as these guidelines are intended to provide a comprehensive overview of the user interface, these pages should also be of general interest. Hopefully, the descriptions of the various UI elements, particularly in the Laptop Experience section, will quench the thirst of all who want to better understand the project and its goals.

How to Read This Document

Although many who make it to this page will have read at least one set of human-interface guideline, we strongly request that you read the content of this document in full. While many of the terms contained within will be quite familiar to you, we urge you to review them anyway, since our approach to the user experience shifts away from some traditional models. This document may introduce some unfamiliar ideas around such otherwise familiar terms that you should consider throughout development.

We urge you to read this document once from start to finish, but extensive use of both internal and external hyperlinks will also allow you to peruse its contents at will. Hopefully, this will make revisiting particular parts of the guidelines quick and easy, and will allow you to move naturally through the most pertinent details. Additionally, the document has been laid out in a 3-tier structure — document, chapters, and pages. Feel free to view the document in full to get a broad picture or to print a hardcopy, or use the integrated navigation to move through one chapter or page at a time.

API Reference
Inline references to related APIs appear throughout.

We have included relevant links to the APIs in order to make the relationship between design and implementation clearer. Please take advantage of this as you develop for the laptops.

Providing Feedback

This document remains in constant flux as the project moves forward. We value any feedback that you might have, and would ask that you share any thoughts and suggestions via the discussion pages. Discussions surround each tier of the document; if you have specific comments, please post them in the discussion for the corresponding page. For more general comments, feel free to use the talk pages at the chapter level or for the HIG as a whole. Links to the talk pages reside next to each section header.