Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f9943d0e authored by Scott Main's avatar Scott Main Committed by Android (Google) Code Review
Browse files

Merge "add the JD docs for the Android Wear docs (delte the HTML versions)... 

Merge "add the JD docs for the Android Wear docs (delte the HTML versions) This depends on the following CL that makes this all work with template changes: I848f442b3bc66ee2fb87db8200df370d13762d29" into klp-docs
parents 09131844 039d4411

docs/html/wear/design/index.html→docs/html/wear/design/index.jd

+173 −0
Original line number Diff line number Diff line 
<!DOCTYPE html>

page.title=Design Principles of Android Wear



@jd:body



















































































































































































<html>

<head>





<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<meta name="viewport" content="width=device-width" />



<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />

<title>Design Principles of Android Wear | Android Developers</title>



<!-- STYLESHEETS -->

<link rel="stylesheet"

href="//fonts.googleapis.com/css?family=Roboto:light,regular,medium,thin,italic,mediumitalic,bold" title="roboto">

<link href="/assets/css/default.css" rel="stylesheet" type="text/css">







<!-- JAVASCRIPT -->

<script src="//www.google.com/jsapi" type="text/javascript"></script>

<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script>

<script type="text/javascript">

  var toRoot = "/";

  var metaTags = [];

  var devsite = false;

</script>

<script src="/assets/js/docs.js" type="text/javascript"></script>



<script type="text/javascript">

  var _gaq = _gaq || [];

  _gaq.push(['_setAccount', 'UA-5831155-1']);

  _gaq.push(['_trackPageview']);



  (function() {

    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

  })();

</script>

</head>



<body class="gc-documentation 

  " itemscope itemtype="http://schema.org/Article">





  

<a name="top"></a>



    <!-- Header -->

    <div id="header">

        <div class="wrap" id="header-wrap">

          <div class="col-3 logo-wear">

          <a href="/wear/index.html">

            <img src="/wear/images/android-wear.png" height="16" alt="Android Wear" />

          </a>

          </div>





	<div class="col-8" style="margin:0"><h1 style="margin:1px 0 0 20px;padding:0;line-height:16px;

  color:#666;font-weight:100;font-size:24px;">Developer Preview</h1></div>

            



          <!-- New Search -->

          <div class="menu-container">

            <div class="moremenu">

	        <div id="more-btn"></div>

	    </div>

  <div class="morehover" id="moremenu">

    <div class="top"></div>

    <div class="mid">

      <div class="header">Links</div>

      <ul>

        <li><a href="https://play.google.com/apps/publish/">Google Play Developer Console</a></li>

        <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li>

        <li><a href="/about/index.html">About Android</a></li>

      </ul>

      <div class="header">Android Sites</div>

      <ul>

        <li><a href="http://www.android.com">Android.com</a></li>

        <li class="active"><a>Android Developers</a></li>

        <li><a href="http://source.android.com">Android Open Source Project</a></li>

      </ul>

      

      

      

        <div class="header">Language</div>

          <div id="language" class="locales">

            <select name="language" onChange="changeLangPref(this.value, true)">

                <option value="en">English</option>

                <option value="es">Español</option>

                <option value="ja">日本語</option>

                <option value="ko">한국어</option>

                <option value="ru">Русский</option>

                <option value="zh-cn">中文 (中国)</option>

                <option value="zh-tw">中文 (台灣)</option>

            </select>

          </div>

        <script type="text/javascript">

          <!--

          loadLangPref();

            //-->

        </script>

      

      





      <br class="clearfix" />

    </div><!-- end mid -->

    <div class="bottom"></div>

  </div><!-- end morehover -->



  <div class="search" id="search-container">

    <div class="search-inner">

      <div id="search-btn"></div>

      <div class="left"></div>

      <form onsubmit="return submit_search()">

        <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q"

onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)"

onkeydown="return search_changed(event, true, '/')" 

onkeyup="return search_changed(event, false, '/')" />

      </form>

      <div class="right"></div>

        <a class="close hide">close</a>

        <div class="left"></div>

        <div class="right"></div>

    </div>

  </div><!--  end search -->



  <div class="search_filtered_wrapper reference">

    <div class="suggest-card reference no-display">

      <ul class="search_filtered">

      </ul>

    </div>

  </div>



  <div class="search_filtered_wrapper docs">

    <div class="suggest-card dummy no-display">&nbsp;</div>

    <div class="suggest-card develop no-display">

      <ul class="search_filtered">

      </ul>

      <div class="child-card guides no-display">

      </div>

      <div class="child-card training no-display">

      </div>

      <div class="child-card samples no-display">

      </div>

    </div>

    <div class="suggest-card design no-display">

      <ul class="search_filtered">

      </ul>

    </div>

    <div class="suggest-card distribute no-display">

      <ul class="search_filtered">

      </ul>

    </div>

  </div><!-- end search_filtered_wrapper -->



  </div>

  <!-- end menu_container -->





        </div><!-- end header-wrap -->

    </div>

    <!-- /Header -->





  <div id="searchResults" class="wrap" style="display:none;">

          <h2 id="searchTitle">Results</h2>

          <div id="leftSearchControl" class="search-control">Loading...</div>

  </div>



  



  



  <div class="wrap clearfix" id="body-content">

    <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">

      <div id="devdoc-nav" class="scroll-pane">

<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>



<ul id="nav">



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/preview/start.html">Get Started

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/design/user-interface.html">UI Overview

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/design/index.html">Design Principles

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/notifications/creating.html">Creating Notifications for Android Wear

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/notifications/remote-input.html">Receiving Voice Input from a Notification

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/notifications/pages.html">Adding Pages to a Notification

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/notifications/stacks.html">Stacking Notifications

      </a></div>

  </li>



  <li class="nav-section">

    <div class="nav-section-header"><a href="/reference/android/preview/support/package-summary.html">Notification Reference</a></div>

    <ul class="tree-list-children">

<li class="nav-section">

<div class="nav-section-header-ref"><span class="tree-list-subtitle package" title="android.preview.support.v4.app">android.preview.support.v4.app</span></div>

  <ul>

<li><a href="/reference/android/preview/support/v4/app/NotificationManagerCompat.html">NotificationManagerCompat</a></li>

  </ul>

</li>



<li class="nav-section">

<div class="nav-section-header-ref"><span class="tree-list-subtitle package" title="android.preview.support.wearable.notifications">android.preview.support.wearable.notifications</span></div>

<ul>



<li><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html">RemoteInput</a></li>

<li><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html" >RemoteInput.Builder</a></li>



<li><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.html">WearableNotifications</a></li>



<li><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></li>



<li><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html">WearableNotifications.Action.Builder</a></li>



<li><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html">WearableNotifications.Builder</a></li>

	</ul>

  </li>

</ul>

</li>







  <li class="nav-section">

    <div class="nav-section-header empty"><a href="/wear/license.html">License Agreement</a></div>

  </li>





</ul>



        



      </div>

    </div> <!-- end side-nav -->

    <script>

      $(document).ready(function() {

        scrollIntoView("devdoc-nav");

        });

    </script>









<div class="col-12" id="doc-col" >





  

    

      

        <h1 itemprop="name" >Design Principles of Android Wear</h1>

      

    

  





  

  <div id="jd-content">





    <div class="jd-descr" itemprop="articleBody">

<style>

h3 {

 padding:30px 0 10px;
@@ -381,16 +10,16 @@ h3 { 
<p>

Android wearables provide just the right information at just the right time, allowing you to be connected to the virtual world and present in the real world.</p>



<img src="/wear/images/05_images.png" height="200" width="169" style="float:right;clear:right;margin:0 0 60px 60px" />

<img src="{@docRoot}wear/images/05_images.png" height="200" width="169" style="float:right;clear:right;margin:0 0 60px 60px" />



<p>Here you’ll find some guidelines for designing great user experiences on the Android Wear

platform. Designing for Android Wear is substantially different than designing for phones or

tablets, so we’ll start by describing how your content can work in tandem with the overall

Android Wear vision. To better understand the user experience on Android Wear, also be sure

to read the <a href="/wear/design/user-interface.html">UI Overview</a>.</p>

to read the <a href="{@docRoot}wear/design/user-interface.html">UI Overview</a>.</p>





<img src="/wear/images/02_notifications.png" height="200" width="169" style="float:right;clear:right;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/02_notifications.png" height="200" width="169" style="float:right;clear:right;margin:0 0 20px 60px" />
@@ -418,7 +47,7 @@ By providing a smart connection to the rest of the world while respecting the us 
<p>Android notifications appear as cards in the main stream and form the core of the Android Wear experience. Many of the main <a href="http://developer.android.com/design/patterns/notifications.html">Android Design guidelines for notifications</a> apply in Android Wear. Be respectful of users' attention and aware of how unnecessary interruptions will reflect on your application’s reputation.</p>



<p>Omit needless text from your notifications. Design for glanceability, not reading. Use words and phrases, not sentences. Show, don't tell: where possible use simple icons, glyphs, and visualizations to convey your message.</p>

<img src="/wear/images/circle_message2.png" height="200" style="float:right;clear:right;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/circle_message2.png" height="200" style="float:right;clear:right;margin:0 0 20px 60px" />



<p>In some cases, particularly with messaging applications, cards will contain dynamic content which may not fit on a single screen. In these cases the content will be automatically truncated to fit on the card and the user may tap to expand, so the full message should be provided.</p>
@@ -429,16 +58,19 @@ By providing a smart connection to the rest of the world while respecting the us 


<h3 id="NotifictionActions" style="clear:both">Actions</h3>



<img src="/wear/images/circle_message2_reply.png" height="200" style="float:right;clear:right;margin:0 0 20px 40px" />

<img src="{@docRoot}wear/images/circle_message2_reply.png" height="200" style="float:right;clear:right;margin:0 0 20px 40px" />



<p>Actions appear to the right of your notification, allowing the user to act on your notification. Up to three actions are permitted. The most-used action should be placed first, so that it is a single swipe away from your content.</p>



<p>Actions consist of an icon and a caption. Icons should be PNG files, white on transparent background, 32 × 32 dp (with 8 dp padding), as specified in the <a href="/design/style/iconography.html#action-bar">Iconography</a> design guide

for the action bar icons. Captions should be verb-driven and short, and will be automatically truncated at one line.</p>

<p>Actions consist of an icon and a caption. Icons should be PNG files, white on transparent

background, 32 × 32 dp (with 8 dp padding), as specified in the <a

href="/design/style/iconography.html#action-bar">Iconography</a> design guide for action bar

icons. Captions should be verb-driven and short, and will be automatically truncated at one line.

</p>



<p>Actions are optional. Many useful notifications will not need to include actions at all.</p>



<p>For developer details about action buttons, see <a href="/wear/notifications/creating.html">Creating

<p>For developer details about action buttons, see <a href="{@docRoot}wear/notifications/creating.html">Creating

Notifications for Android Wear</a>.</p>
@@ -448,16 +80,17 @@ Notifications for Android Wear</a>.</p> 


<h3 id="Images" style="clear:both">Images</h3>



<img src="/wear/images/circle_badge_B.png" height="200" style="float:right;clear:right;margin:0 0 20px 40px" />

<img src="{@docRoot}wear/images/circle_badge_B.png" height="200" style="float:right;clear:right;margin:0 0 20px 40px" />





<p>Images appear behind cards in the stream, providing context and additional glanceability. Your image should support the core message of the notification; for example, a card about a sports team could include the team color and logo; a message from a contact should display that person's profile photo.</p>



<p>Bear in mind that the card will partially cover the lower part of the image. Images should be sized as

appropriate for the notification appearance on handsets, which is 64 x 64 dp. Image backgrounds move when horizontally swiped, so landscape-oriented images work better on notifications that include pages or actions.</p>

<p>Bear in mind that the card will partially cover the lower part of the image. Images should

be sized as appropriate for the notification appearance on handsets, which is 64 x 64 dp. Image backgrounds move when horizontally swiped, so landscape-oriented images work better on notifications that include pages or actions.</p>



<p>To add large images, use <code><a href="/reference/android/support/v4/app/NotificationCompat.Builder.html#setLargeIcon(android.graphics.Bitmap)">setLargeIcon()</a></code> with any notification, as

shown in <a href="/wear/notifications/creating.html">Creating

<p>To add large images, use {@link android.support.v4.app.NotificationCompat.Builder#setLargeIcon

setLargeIcon()} with any notification, as

shown in <a href="{@docRoot}wear/notifications/creating.html">Creating

Notifications for Android Wear</a>.</p>
@@ -466,7 +99,7 @@ Notifications for Android Wear</a>.</p> 


<h3 id="AppIcons" style="clear:both">Application Icons</h3>



<img src="/wear/images/07_appicons.png" height="200" style="float:right;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/07_appicons.png" height="200" style="float:right;margin:0 0 20px 60px" />



<p>Your application’s launcher icon will be automatically placed on the card, identifying your notification. Do not use the notification title or background image to identify or brand your application. Instead, allow your icon to identify itself and focus on delivering a clear, succinct message in the card and image. You can choose not to display this icon using

 <a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html#setHintHideIcon(boolean)"><code>setHintHideIcon()</code></a>.
@@ -482,9 +115,9 @@ Notifications for Android Wear</a>.</p> 


<p>Pages are additional cards that can appear to the right of your main card in the stream. If your core message is longer than a short snippet, do not sacrifice glanceability by packing a lot of information into your primary notification. Instead, use pages to provide additional content.</p>



<img src="/wear/images/08_pages.png" height="200" style="float:left;margin:0 0 20px 0px" />

<img src="/wear/images/09_pages.png" height="200" style="float:left;margin:0 0 20px 60px" />

<img src="/wear/images/10_pages.png" height="200" style="float:left;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/08_pages.png" height="200" style="float:left;margin:0 0 20px 0px" />

<img src="{@docRoot}wear/images/09_pages.png" height="200" style="float:left;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/10_pages.png" height="200" style="float:left;margin:0 0 20px 60px" />



<p style="clear:left">Pages appear immediately to the right of the main notification card. They are typically used to provide additional details or alternate views of the main card’s content. For example:</p>

<ul>
@@ -498,7 +131,7 @@ Notifications for Android Wear</a>.</p> 
<p>Pages are optional. Many useful notifications will not need to include pages at all.</p>



<p>For developer details about pages, see

described in <a href="/wear/notifications/pages.html">Adding

described in <a href="{@docRoot}wear/notifications/pages.html">Adding

Pages to a Notification</a>.</p>
@@ -507,8 +140,8 @@ Pages to a Notification</a>.</p> 


<h3 id="NotificationStacks" style="clear:both">Notification Stacks</h3>



<img src="/wear/images/11_bundles_B.png" height="200" style="float:right;margin:0 0 20px 60px" />

<img src="/wear/images/11_bundles_A.png" height="200" style="float:right;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/11_bundles_B.png" height="200" style="float:right;margin:0 0 20px 60px" />

<img src="{@docRoot}wear/images/11_bundles_A.png" height="200" style="float:right;margin:0 0 20px 60px" />



<p>Stacks may be used to collect multiple notifications from the same application into a single stack of cards. Whereas pages are used to provide additional detail on a single notification, stacks are used to collect multiple sibling notifications together. A stack may be expanded by the user to access each individual card contained within.</p>
@@ -517,7 +150,7 @@ Pages to a Notification</a>.</p> 
<p>Each notification within a stack can contain separate pages and separate actions that are relevant to that specific notification. The user can access these actions after expanding that notification's card within the stack.</p>



<p>For developer details about stacks, see

described in <a href="/wear/notifications/stacks.html">Stacking

described in <a href="{@docRoot}wear/notifications/stacks.html">Stacking

Notifications</a>.</p>
@@ -528,82 +161,13 @@ Notifications</a>.</p> 
<h3 id="VoiceReplies" style="clear:both">Voice Replies</h3>





<img src="/wear/images/circle_voice_B.png" height="200" style="float:right;margin:0 0 20px 40px" />

<img src="/wear/images/circle_voice_A.png" height="200" style="float:right;margin:0 0 20px 40px" />

<img src="{@docRoot}wear/images/circle_voice_B.png" height="200" style="float:right;margin:0 0 20px 40px" />

<img src="{@docRoot}wear/images/circle_voice_A.png" height="200" style="float:right;margin:0 0 20px 40px" />



<p>Voice replies are primarily used by messaging applications to provide a hands-free way of dictating a short message. You can also provide a up to five suggested replies or “canned responses” that are useful in a wide range of cases. These canned responses can be tapped by the user, allowing for a fast method of sending simple replies in cases where speaking may not be desirable.</p>



<p>You should attempt to cover a range of simple, neutral replies in your choices. Longer voice replies may be automatically truncated in the Voice reply UI.</p>



<p>For developer details about enabling voice replies, see

described in <a href="/wear/notifications/remote-input.html">Receiving Voice Input from

described in <a href="{@docRoot}wear/notifications/remote-input.html">Receiving Voice Input from

a Notification</a>.</p>
 


    </div>



      <div class="content-footer layout-content-row"

                    itemscope itemtype="http://schema.org/SiteNavigationElement">

        <div class="layout-content-col col-9" style="padding-top:4px">

          

            <div class="g-plusone" data-size="medium"></div>

          

        </div>

        

        <div class="paging-links layout-content-col col-4">

          

        </div>

        

      </div>



      

      



  </div> <!-- end jd-content -->



<div id="footer" class="wrap" >

        



  <div id="copyright">

    

  Except as noted, this content is 

  licensed under <a href="http://creativecommons.org/licenses/by/2.5/">

  Creative Commons Attribution 2.5</a>. For details and 

  restrictions, see the <a href="/license.html">Content 

  License</a>.

  </div>





  <div id="footerlinks">

    

  <p>

    <a href="/about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;

    <a href="/legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;

    <a href="/support.html">Support</a>

  </p>

  </div>



</div> <!-- end footer -->

</div><!-- end doc-content -->



</div> <!-- end body-content --> 













<!-- Start of Tag -->

<script type="text/javascript">

var axel = Math.random() + "";

var a = axel * 10000000000000;

document.write('<iframe src="https://2507573.fls.doubleclick.net/activityi;src=2507573;type=other026;cat=googl348;ord=' + a + '?" width="1" height="1" frameborder="0" style="display:none"></iframe>');

</script>

<noscript>

<iframe src="https://2507573.fls.doubleclick.net/activityi;src=2507573;type=other026;cat=googl348;ord=1?" width="1" height="1" frameborder="0" style="display:none"></iframe>

</noscript>

<!-- End of Tag -->

</body>

</html>

docs/html/wear/design/user-interface.html

deleted100644 → 0
+0 −498

File deleted.

Preview size limit exceeded, changes collapsed.

docs/html/wear/design/user-interface.jd

0 → 100644
+58 −0
Original line number Diff line number Diff line 
page.title=UI Overview

page.customHeadTag=<link rel="stylesheet" type="text/css" href="/wear/css/wear.css">



@jd:body



<style>

h3 {

 padding:30px 0 10px;

}

</style>



<p>A new form factor deserves a new UI model. At a high level, the Android Wear UI consists of two

main spaces centered around the core functions of <strong>Suggest</strong> and

<strong>Demand</strong>. Your application will have an important role to play in both of these

spaces.</p>







<h3 id="Stream">Suggest: The Context Stream</h3>



<div class="wear-inset-video-container" style="float:right;margin:0 -22px 60px 40px">

  <img class="wear-bezel-only" src="{@docRoot}wear/images/screens/bezel.png" alt="">

  <img class="gif" src="{@docRoot}wear/images/screens/stream.gif">

</div>



<p>The context stream is a vertical list of cards, each showing a useful or timely piece of

information. Much like Google Now on Android phones and tablets, users swipe vertically to navigate

from card to card for a brief and comprehensive update about what's important to them. Only one card

is displayed on screen at a time, and background images are used to provide additional visual

information. Your application can create cards and inject them into the stream when they are most

likely to be useful.</p>



<p>Cards in the stream are more than simple notifications. They can be swiped horizontally to

reveal additional pages. Further horizontal swiping may reveal tappable buttons, allowing the user

to take action on the notification. Cards can also be dismissed by swiping left to right, removing

them from the stream until the next time they have useful information to display.

In the emulator, hovering the mouse over the top of the screen illuminates a blue bar at

the top of the device that takes you home when clicked.</p>







<h3 id="CueCard">Demand: The Cue Card</h3>



<div class="wear-inset-video-container" style="float:right;margin:0 -22px 60px 40px">

  <img class="wear-bezel-only" src="{@docRoot}wear/images/screens/bezel.png" alt="">

  <img class="gif" src="{@docRoot}wear/images/screens/cuecard.gif">

</div>



<p>For cases where the context stream can't anticipate what the user would like to do, the cue card

allows users to speak to their device. The cue card is opened by saying, "Ok Google" or by tapping

on the "g" icon on the home screen. Swiping up on the cue card shows a list of actions, which can

also be tapped.</p>



<p>The list of actions includes Android intents for voice actions. The upcoming Android Wear SDK

will enable developers to match their applications to these intents so users can perform actions

using these voice commands. Multiple applications may register for a single voice intent, and users

will have the opportunity to choose which application they prefer to use.</p>

docs/html/wear/index.html→docs/html/wear/index.jd

+9 −343

File changed and moved.

Preview size limit exceeded, changes collapsed.

docs/html/wear/license.html→docs/html/wear/license.jd

+3 −442

File changed and moved.

Preview size limit exceeded, changes collapsed.