Skip to content

Commit ec80d7f

Browse files
scottamainscottamain
committed
docs: consistency fixit for the quickview boxes in the dev guide
Change-Id: Ibd81091fc6002a77ce43f553b63facec53f16a38
1 parent ba944cc commit ec80d7f

33 files changed

+232
-167
lines changed

‎docs/html/guide/appendix/market-filters.jd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page.title=Market Filters
44
<div id="qv-wrapper">
55
<div id="qv">
66

7-
<h2 align="left">Market filters quickview</h2>
7+
<h2>Quickview</h2>
88
<ul> <li>Android Market applies filters to that let you control whether your app is shown to a
99
user who is browing or searching for apps.</li>
1010
<li>Filtering is determined by elements in an app's manifest file,

‎docs/html/guide/practices/design/performance.jd‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,37 @@
11
page.title=Designing for Performance
22
@jd:body
33

4+
<div id="qv-wrapper">
5+
<div id="qv">
6+
7+
<h2>In this document</h2>
8+
<ol>
9+
<li><a href="#intro">Introduction</a></li>
10+
<li><a href="#optimize_judiciously">Optimize Judiciously</a></li>
11+
<li><a href="#object_creation">Avoid Creating Objects</a></li>
12+
<li><a href="#myths">Performance Myths</a></li>
13+
<li><a href="#prefer_static">Prefer Static Over Virtual</a></li>
14+
<li><a href="#internal_get_set">Avoid Internal Getters/Setters</a></li>
15+
<li><a href="#use_final">Use Static Final For Constants</a></li>
16+
<li><a href="#foreach">Use Enhanced For Loop Syntax</a></li>
17+
<li><a href="#avoid_enums">Avoid Enums Where You Only Need Ints</a></li>
18+
<li><a href="#package_inner">Use Package Scope with Inner Classes</a></li>
19+
<li><a href="#avoidfloat">Use Floating-Point Judiciously</a> </li>
20+
<li><a href="#library">Know And Use The Libraries</a></li>
21+
<li><a href="#native_methods">Use Native Methods Judiciously</a></li>
22+
<li><a href="#closing_notes">Closing Notes</a></li>
23+
</ol>
24+
25+
</div>
26+
</div>
27+
428
<p>An Android application will run on a mobile device with limited computing
529
power and storage, and constrained battery life. Because of
630
this, it should be <em>efficient</em>. Battery life is one reason you might
731
want to optimize your app even if it already seems to run "fast enough".
832
Battery life is important to users, and Android's battery usage breakdown
933
means users will know if your app is responsible draining their battery.</p>
1034

11-
<p>This document covers these topics: </p>
12-
<ul>
13-
<li><a href="#intro">Introduction</a></li>
14-
<li><a href="#optimize_judiciously">Optimize Judiciously</a></li>
15-
<li><a href="#object_creation">Avoid Creating Objects</a></li>
16-
<li><a href="#myths">Performance Myths</a></li>
17-
<li><a href="#prefer_static">Prefer Static Over Virtual</a></li>
18-
<li><a href="#internal_get_set">Avoid Internal Getters/Setters</a></li>
19-
<li><a href="#use_final">Use Static Final For Constants</a></li>
20-
<li><a href="#foreach">Use Enhanced For Loop Syntax</a></li>
21-
<li><a href="#avoid_enums">Avoid Enums Where You Only Need Ints</a></li>
22-
<li><a href="#package_inner">Use Package Scope with Inner Classes</a></li>
23-
<li><a href="#avoidfloat">Use Floating-Point Judiciously</a> </li>
24-
<li><a href="#library">Know And Use The Libraries</a></li>
25-
<li><a href="#native_methods">Use Native Methods Judiciously</a></li>
26-
<li><a href="#closing_notes">Closing Notes</a></li>
27-
</ul>
28-
2935
<p>Note that although this document primarily covers micro-optimizations,
3036
these will almost never make or break your software. Choosing the right
3137
algorithms and data structures should always be your priority, but is

‎docs/html/guide/practices/design/responsiveness.jd‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,37 @@
11
page.title=Designing for Responsiveness
22
@jd:body
33

4+
<div id="qv-wrapper">
5+
<div id="qv">
6+
7+
<h2>In this document</h2>
8+
<ol>
9+
<li><a href="#anr">What Triggers ANR?</a></li>
10+
<li><a href="#avoiding">How to Avoid ANR</a></li>
11+
<li><a href="#reinforcing">Reinforcing Responsiveness</a></li>
12+
</ol>
13+
14+
</div>
15+
</div>
16+
417
<div class="figure">
518
<img src="{@docRoot}images/anr.png" alt="Screenshot of ANR dialog box" width="240" height="320"/>
619
<p><strong>Figure 1.</strong> An ANR dialog displayed to the user.</p>
720
</div>
821

22+
<p>It's possible to write code that wins every performance test in the world, but still sends users
23+
in a fiery rage when they try to use the application. These are the applications that aren't
24+
<em>responsive</em> enough &mdash; the ones that feel
25+
sluggish, hang or freeze for significant periods, or take too long to process
26+
input. </p>
27+
28+
<p>In Android, the system guards against applications that are insufficiently responsive for a
29+
period of time by displaying a dialog to the user, called the Application Not Responding (ANR)
30+
dialog. The user can choose to let the application continue, but the user won't appreciate having to
31+
act on this dialog every time he or she uses your application. So it's important to design
32+
responsiveness into your application, so that the system never has cause to display an ANR to the
33+
user. </p>
34+
935
<p>It's possible to write code that wins every performance test in the world,
1036
but still sends users in a fiery rage when they try to use the application.
1137
These are the applications that aren't <em>responsive</em> enough &mdash; the

‎docs/html/guide/practices/design/seamlessness.jd‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
page.title=Designing for Seamlessness
22
@jd:body
33

4+
<div id="qv-wrapper">
5+
<div id="qv">
6+
7+
<h2>In this document</h2>
8+
<ol>
9+
<li><a href="#drop">Don't Drop Data</a></li>
10+
<li><a href="#expose">Don't Expose Raw Data</a></li>
11+
<li><a href="#interrupt">Don't Interrupt the User</a></li>
12+
<li><a href="#threads">Got a Lot to Do? Do it in a Thread</a></li>
13+
<li><a href="#multiple-activities">Don't Overload a Single Activity Screen</a></li>
14+
<li><a href="#themes">Extend System Themes</a></li>
15+
<li><a href="#flexui">Design Your UI to Work with Multiple Screen Resolutions</a></li>
16+
<li><a href="#network">Assume the Network is Slow</a></li>
17+
<li><a href="#keyboard">Don't Assume Touchscreen or Keyboard</a></li>
18+
<li><a href="#battery">Do Conserve the Device Battery</a></li>
19+
</ol>
20+
21+
</div>
22+
</div>
23+
424
<p>Even if your application is fast and responsive, certain design decisions can
525
still cause problems for users &mdash; because of unplanned interactions with
626
other applications or dialogs, inadvertent loss of data, unintended blocking,
@@ -42,20 +62,7 @@ system as just an even-larger federation of these components. This benefits you
4262
by allowing you to integrate cleanly and seamlessly with other applications, and
4363
so you should design your own code to return the favor.</p>
4464

45-
<p>This document discusses common seamlessness problems and how to avoid them.
46-
It covers these topics: </p>
47-
<ul>
48-
<li><a href="#drop">Don't Drop Data</a></li>
49-
<li><a href="#expose">Don't Expose Raw Data</a></li>
50-
<li><a href="#interrupt">Don't Interrupt the User</a></li>
51-
<li><a href="#threads">Got a Lot to Do? Do it in a Thread</a></li>
52-
<li><a href="#multiple-activities">Don't Overload a Single Activity Screen</a></li>
53-
<li><a href="#themes">Extend System Themes</a></li>
54-
<li><a href="#flexui">Design Your UI to Work with Multiple Screen Resolutions</a></li>
55-
<li><a href="#network">Assume the Network is Slow</a></li>
56-
<li><a href="#keyboard">Don't Assume Touchscreen or Keyboard</a></li>
57-
<li><a href="#battery">Do Conserve the Device Battery</a></li>
58-
</ul>
65+
<p>This document discusses common seamlessness problems and how to avoid them.</p>
5966

6067
<h2 id="drop">Don't Drop Data</h2>
6168

‎docs/html/guide/practices/screens_support.jd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ page.title=Supporting Multiple Screens
55
<div id="qv-wrapper">
66
<div id="qv">
77

8-
<h2>Multiple screens quickview: </h2>
8+
<h2>Quickview</h2>
99
<ul>
1010
<li>Android runs on devices that have different screen sizes and resolutions.</li>
1111
<li>The screen on which your application is displayed can affect its user interface.</li>

‎docs/html/guide/practices/ui_guidelines/activity_task_design.jd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page.title=Activity and Task Design Guidelines
44
<div id="qv-wrapper">
55
<div id="qv">
66

7-
<h2>Activity and task design quickview</h2>
7+
<h2>Quickview</h2>
88

99
<ul>
1010
<li>Activities are the main building blocks of Android applications. </li>

‎docs/html/guide/practices/ui_guidelines/icon_design.jd‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page.title=Icon Design Guidelines, Android 2.0
44
<div id="qv-wrapper">
55
<div id="qv">
66

7-
<h2>Icon design quickview</h2>
7+
<h2>Quickview</h2>
88

99
<ul>
1010
<li>You can use several types of icons in an Android application.</li>
@@ -35,25 +35,30 @@ page.title=Icon Design Guidelines, Android 2.0
3535

3636
</ol>
3737

38-
<h2>See also</h2>
39-
40-
<ol>
41-
<li><a href="{@docRoot}guide/practices/screens_support.html">Supporting Multiple
42-
Screens</a></li>
43-
<li><a href="{@docRoot}shareables/icon_templates-v2.0.zip">Android Icon
44-
Templates Pack, v2.0 &raquo;</a></li>
45-
</ol>
46-
4738
<h2>Older versions</h2>
4839

4940
<ol>
5041
<li style="margin-top:4px;"><a
5142
href="{@docRoot}guide/practices/ui_guidelines/icon_design_1.html">Icon Design
5243
Guidelines, Android 1.0</a></li>
44+
</ol>
45+
46+
<h2>Downloads</h2>
47+
48+
<ol>
49+
<li><a href="{@docRoot}shareables/icon_templates-v2.0.zip">Android Icon
50+
Templates Pack, v2.0 &raquo;</a></li>
5351
<li><a href="{@docRoot}shareables/icon_templates-v1.0.zip">Android Icon
5452
Templates Pack, v1.0 &raquo;</a></li>
5553
</ol>
5654

55+
<h2>See also</h2>
56+
57+
<ol>
58+
<li><a href="{@docRoot}guide/practices/screens_support.html">Supporting Multiple
59+
Screens</a></li>
60+
</ol>
61+
5762

5863
</div>
5964
</div>

‎docs/html/guide/practices/ui_guidelines/icon_design_1.jd‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page.title=Icon Design Guidelines, Android 1.0
44
<div id="qv-wrapper">
55
<div id="qv">
66

7-
<h2>Icon design quickview</h2>
7+
<h2>Quickview</h2>
88

99
<ul>
1010
<li>You can use several types of icons in an Android application.</li>
@@ -35,14 +35,19 @@ application can use the standard icons by referencing them as resources.</li>
3535

3636
</ol>
3737

38-
<h2>See also</h2>
38+
<h2>Downloads</h2>
3939

4040
<ol>
41-
<li><a href="{@docRoot}guide/practices/screens_support.html">Supporting Multiple Screens</a></li>
4241
<li><a href="{@docRoot}shareables/icon_templates-v1.0.zip">Android Icon
4342
Templates Pack, v1.0 &raquo;</a></li>
4443
</ol>
4544

45+
<h2>See also</h2>
46+
47+
<ol>
48+
<li><a href="{@docRoot}guide/practices/screens_support.html">Supporting Multiple Screens</a></li>
49+
</ol>
50+
4651

4752
<h2>Newer versions</h2>
4853

‎docs/html/guide/practices/ui_guidelines/menu_design.jd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page.title=Menu Design Guidelines
44
<div id="qv-wrapper">
55
<div id="qv">
66

7-
<h2>Menu design quickview</h2>
7+
<h2>Quickview</h2>
88

99
<ul>
1010
<li>An Options menu is for any commands that are global to the current activity. </li>

‎docs/html/guide/practices/ui_guidelines/widget_design.jd‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page.title=Widget Design Guidelines
44
<div id="qv-wrapper">
55
<div id="qv">
66

7-
<h2>Widget design quickview</h2>
7+
<h2>Quickview</h2>
88

99
<ul>
1010
<li>Widgets have six standard sizes on the Home screen</li>
@@ -27,7 +27,7 @@ page.title=Widget Design Guidelines
2727
<h2>See also</h2>
2828

2929
<ol>
30-
<li><a href="{@docRoot}guide/topics/appwidgets/index.html">AppWidgets</a> topic in the <em>Dev Guide</em></li>
30+
<li><a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a></li>
3131
<li><a href="http://android-developers.blogspot.com/2009/04/introducing-home-screen-widgets-and.html">AppWidgets blog post</a></li>
3232
</ol>
3333

0 commit comments

Comments
 (0)