From bf15ce6de461ba5d2a3d823a2445155dc4e4dee9 Mon Sep 17 00:00:00 2001 From: Dirk Dougherty Date: Fri, 23 Oct 2009 19:17:12 -0700 Subject: doc change: add SDK sizes, checksums, small changes for online SDK doc set, add layoutopt doc. Bug:2160782 Change-Id: I020b31e10f2733223aa37d03687cf8a63843afa7 --- docs/html/guide/developing/tools/index.jd | 5 ++ docs/html/guide/developing/tools/layoutopt.jd | 62 +++++++++++++++++ docs/html/guide/guide_toc.cs | 1 + docs/html/guide/topics/ui/declaring-layout.jd | 14 ++-- docs/html/guide/tutorials/localization/index.jd | 6 +- docs/html/sdk/RELEASENOTES.jd | 19 ++--- docs/html/sdk/adt_download.jd | 72 ++++++++++--------- docs/html/sdk/android-2.0.jd | 57 +++++++++++++++ docs/html/sdk/eclipse-adt.jd | 28 ++++---- docs/html/sdk/index.jd | 93 +++++++++++++++---------- docs/html/sdk/installing.jd | 63 ++++++++++++----- docs/html/sdk/sdk_toc.cs | 5 +- docs/html/sdk/tools-notes.jd | 20 ++++-- 13 files changed, 318 insertions(+), 127 deletions(-) create mode 100644 docs/html/guide/developing/tools/layoutopt.jd (limited to 'docs/html') diff --git a/docs/html/guide/developing/tools/index.jd b/docs/html/guide/developing/tools/index.jd index 91b430f..6e9fde1 100644 --- a/docs/html/guide/developing/tools/index.jd +++ b/docs/html/guide/developing/tools/index.jd @@ -32,6 +32,11 @@ applications on the emulator.

of the current display with a pixel grid, so you can get your layout just right. +
layoutopt
+
This tool lets you quickly analyze your application's layouts for +efficiency. +
+
Draw 9-patch
The Draw 9-patch tool allows you to easily create a {@link android.graphics.NinePatch} graphic using a WYSIWYG editor. It also previews stretched diff --git a/docs/html/guide/developing/tools/layoutopt.jd b/docs/html/guide/developing/tools/layoutopt.jd new file mode 100644 index 0000000..72a110d --- /dev/null +++ b/docs/html/guide/developing/tools/layoutopt.jd @@ -0,0 +1,62 @@ +page.title=layoutopt +@jd:body + +

layoutopt is a command-line tool that helps you optimize the +layouts and layout hierarchies of your applications. You can run it against your +layout files or resource directories to quickly check for inefficiencies or +other types of problems that could be affecting the performance of your +application.

+ +

To run the tool, open a terminal and launch layoutopt +<resources> from your SDK tools/ directory. In the +command, supply a list of uncompiled resource xml files or directories that you +want to analyze.

+ +

When run, the tool loads the specified XML files and analyzes their layout +structures and hierarchies according to a set of predefined rules. If it detects +issues, it outputs information about the issues, giving filename, line numbers, +description of issue, and for some types of issues a suggested resolution.

+ +

Here's an example of the output:

+ +
$ layoutopt samples/
+samples/compound.xml
+   7:23 The root-level <FrameLayout/> can be replaced with <merge/>
+   11:21 This LinearLayout layout or its FrameLayout parent is useless
+samples/simple.xml
+   7:7 The root-level <FrameLayout/> can be replaced with <merge/>
+samples/too_deep.xml
+   -1:-1 This layout has too many nested layouts: 13 levels, it should have <= 10!
+   20:81 This LinearLayout layout or its LinearLayout parent is useless
+   24:79 This LinearLayout layout or its LinearLayout parent is useless
+   28:77 This LinearLayout layout or its LinearLayout parent is useless
+   32:75 This LinearLayout layout or its LinearLayout parent is useless
+   36:73 This LinearLayout layout or its LinearLayout parent is useless
+   40:71 This LinearLayout layout or its LinearLayout parent is useless
+   44:69 This LinearLayout layout or its LinearLayout parent is useless
+   48:67 This LinearLayout layout or its LinearLayout parent is useless
+   52:65 This LinearLayout layout or its LinearLayout parent is useless
+   56:63 This LinearLayout layout or its LinearLayout parent is useless
+samples/too_many.xml
+   7:413 The root-level <FrameLayout/> can be replaced with <merge/>
+   -1:-1 This layout has too many views: 81 views, it should have <= 80!
+samples/useless.xml
+   7:19 The root-level <FrameLayout/> can be replaced with <merge/>
+   11:17 This LinearLayout layout or its FrameLayout parent is useless
+ +

The layoutopt tool is available in SDK Tools, Revision 3 or +later. If you do not have SDK Tools 3 or later installed in your SDK, you can +download it from the Android SDK repository site using the Android SDK and AVD +Manager. For information, see Adding SDK Components.

+ +

Usage

+ +

To run layoutopt against a given list of layout resources:

+ +
layoutopt <list of xml files or directories>
+ +

For example:

+ +
$ layoutopt res/layout-land
+
$ layoutopt res/layout/main.xml res/layout-land/main.xml
diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index e2acc4f..5215202 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -255,6 +255,7 @@
  • Draw 9-Patch
  • Emulator
  • Hierarchy Viewer
    • +
  • layoutopt
  • mksdcard
  • Monkey
  • sqlite3
    • diff --git a/docs/html/guide/topics/ui/declaring-layout.jd b/docs/html/guide/topics/ui/declaring-layout.jd index 7ef22a6..80ad7b8 100644 --- a/docs/html/guide/topics/ui/declaring-layout.jd +++ b/docs/html/guide/topics/ui/declaring-layout.jd @@ -25,6 +25,7 @@ parent.link=index.html
  • Size, Padding and Margins
  • Example Layout
    • + @@ -41,14 +42,17 @@ application can create View and ViewGroup objects (and manipulate their properti

    The Android framework gives you the flexibility to use either or both of these methods for declaring and managing your application's UI. For example, you could declare your application's default layouts in XML, including the screen elements that will appear in them and their properties. You could then add code in your application that would modify the state of the screen objects, including those declared in XML, at run time.

    -

    The Android Development Tools - (ADT) plugin for Eclipse offers a layout preview of your XML — - with the XML file opened, select the Layout tab.

    -

    You should also try the +

      +
    • The ADT + Plugin for Eclipse offers a layout preview of your XML — + with the XML file opened, select the Layout tab.
      • +
    • You should also try the Hierarchy Viewer tool, for debugging layouts — it reveals layout property values, draws wireframes with padding/margin indicators, and full rendered views while - you debug on the emulator or device.

      + you debug on the emulator or device.
      • +
    • The layoutopt tool lets + you quickly analyze your layouts and hierarchies for inefficiencies or other problems.

    The advantage to declaring your UI in XML is that it enables you to better separate the presentation of your application from the code that controls its behavior. Your UI descriptions are external to your application code, which means that you can modify or adapt it without having to modify your source code and recompile. For example, you can create XML layouts for different screen orientations, different device screen sizes, and different languages. Additionally, declaring the layout in XML makes it easier to visualize the structure of your UI, so it's easier to debug problems. As such, this document focuses on teaching you how to declare your layout in XML. If you're diff --git a/docs/html/guide/tutorials/localization/index.jd b/docs/html/guide/tutorials/localization/index.jd index eeade34..8a60814 100755 --- a/docs/html/guide/tutorials/localization/index.jd +++ b/docs/html/guide/tutorials/localization/index.jd @@ -539,8 +539,10 @@ height="158" style="margin-left:15px">

    using custom locale

    -

    For a list of supported locales in a specific Android platform, see the -associated notes in the "SDK" tab, under "Downloadable SDK Components."

    +

    For a list of locales available on different versions of the Android platform, +refer to the platform notes documents, listed under "Downloadable SDK Components" +in the "SDK" tab. For example, Android 2.0 locales.

    Run the application for each of the expected locales, plus one unexpected locale. Here are some of the results you should see:

    diff --git a/docs/html/sdk/RELEASENOTES.jd b/docs/html/sdk/RELEASENOTES.jd index 552b699..bca89f6 100644 --- a/docs/html/sdk/RELEASENOTES.jd +++ b/docs/html/sdk/RELEASENOTES.jd @@ -2,10 +2,10 @@ page.title=SDK Release Notes @jd:body

    This document provides version-specific information about Android SDK -releases. For the latest known issues, please ensure that you're viewing this +releases.

    Android SDK

    @@ -27,15 +27,16 @@ keep your development environment up-to-date.

    Note that if you are currently using the Android 1.6 SDK, you do not -necessarily need to install the new SDK, since your existing SDK incudes the -Android SDK and AVD Manager tool. To develop against Android 2.0, for example, -you could just download the Android 2.0 platform into your existing SDK.

    +necessarily need to install the new SDK, since your existing SDK already +includes the Android SDK and AVD Manager tool. To develop against Android 2.0, +for example, you could just download the Android 2.0 platform into your existing +SDK.

    -

    Release notes for Android platforms that are downloadable into the SDK are +

    Release notes for Android platforms and other SDK components are now available from the "SDK" tab, under "Downloadable SDK Components."