xref: /aosp_15_r20/developers/build/templates/create/template-params.xml.ftl (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li<#ftl>
2*d353a188SXin Li<#--
3*d353a188SXin Li        Copyright 2014 The Android Open Source Project
4*d353a188SXin Li
5*d353a188SXin Li        Licensed under the Apache License, Version 2.0 (the "License");
6*d353a188SXin Li        you may not use this file except in compliance with the License.
7*d353a188SXin Li        You may obtain a copy of the License at
8*d353a188SXin Li
9*d353a188SXin Li        http://www.apache.org/licenses/LICENSE-2.0
10*d353a188SXin Li
11*d353a188SXin Li        Unless required by applicable law or agreed to in writing, software
12*d353a188SXin Li        distributed under the License is distributed on an "AS IS" BASIS,
13*d353a188SXin Li        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*d353a188SXin Li        See the License for the specific language governing permissions and
15*d353a188SXin Li        limitations under the License.
16*d353a188SXin Li-->
17*d353a188SXin Li<sample>
18*d353a188SXin Li    <name>${sample.name}</name>
19*d353a188SXin Li    <group>NoGroup</group>  <!-- This field will be deprecated in the future
20*d353a188SXin Li                            and replaced with the "categories" tags below. -->
21*d353a188SXin Li    <package>${sample.package}</package>
22*d353a188SXin Li
23*d353a188SXin Li    <!-- change minSdk if needed-->
24*d353a188SXin Li    <minSdk>${sample.minSdk}</minSdk>
25*d353a188SXin Li
26*d353a188SXin Li    <!-- Include additional dependencies here.-->
27*d353a188SXin Li    <!-- dependency>com.google.android.gms:play-services:5.0.+</dependency -->
28*d353a188SXin Li
29*d353a188SXin Li    <strings>
30*d353a188SXin Li        <intro>
31*d353a188SXin Li            <![CDATA[
32*d353a188SXin Li            Introductory text that explains what the sample is intended to demonstrate. Edit
33*d353a188SXin Li            in template-params.xml.
34*d353a188SXin Li            ]]>
35*d353a188SXin Li        </intro>
36*d353a188SXin Li    </strings>
37*d353a188SXin Li
38*d353a188SXin Li    <!-- The basic templates have already been enabled. Uncomment more as desired. -->
39*d353a188SXin Li    <template src="base" />
40*d353a188SXin Li    <!-- template src="ActivityCards" / -->
41*d353a188SXin Li    <!-- template src="FragmentView" / -->
42*d353a188SXin Li    <!-- template src="CardStream" / -->
43*d353a188SXin Li    <!-- template src="SimpleView" / -->
44*d353a188SXin Li    <template src="SingleView" />
45*d353a188SXin Li
46*d353a188SXin Li    <!-- Include common code modules by uncommenting them below. -->
47*d353a188SXin Li    <common src="logger" />
48*d353a188SXin Li    <!-- common src="activities"/ -->
49*d353a188SXin Li
50*d353a188SXin Li    <metadata>
51*d353a188SXin Li        <!-- Values: {DRAFT | PUBLISHED | INTERNAL | DEPRECATED | SUPERCEDED} -->
52*d353a188SXin Li        <status>DRAFT</status>
53*d353a188SXin Li        <!-- See http://go/sample-categories for details on the next 4 fields. -->
54*d353a188SXin Li        <!-- Most samples just need to udpate the Categories field. This is a comma-
55*d353a188SXin Li             seperated list of topic tags. Unlike the old category system, samples
56*d353a188SXin Li             may have multiple categories, so feel free to add extras. Try to avoid
57*d353a188SXin Li             simply tagging everything with "UI". :)-->
58*d353a188SXin Li        <categories>Getting Started, UI</categories>
59*d353a188SXin Li        <technologies>Android</technologies>
60*d353a188SXin Li        <languages>Java</languages>
61*d353a188SXin Li        <solutions>Mobile</solutions>
62*d353a188SXin Li        <!-- Values: {BEGINNER | INTERMEDIATE | ADVANCED | EXPERT} -->
63*d353a188SXin Li        <!-- Beginner is for "getting started" type content, or essential content.
64*d353a188SXin Li             (e.g. "Hello World", activities, intents)
65*d353a188SXin Li
66*d353a188SXin Li             Intermediate is for content that covers material a beginner doesn't need
67*d353a188SXin Li             to know, but that a skilled developer is expected to know.
68*d353a188SXin Li             (e.g. services, basic styles and theming, sync adapters)
69*d353a188SXin Li
70*d353a188SXin Li             Advanced is for highly technical content geared towards experienced developers.
71*d353a188SXin Li             (e.g. performance optimizations, custom views, bluetooth)
72*d353a188SXin Li
73*d353a188SXin Li             Expert is reserved for highly technical or specialized content, and should
74*d353a188SXin Li             be used sparingly. (e.g. VPN clients, SELinux, custom instrumentation runners) -->
75*d353a188SXin Li        <level>BEGINNER</level>
76*d353a188SXin Li        <!-- Dimensions: 512x512, PNG fomrat -->
77*d353a188SXin Li        <icon>screenshots/icon-web.png</icon>
78*d353a188SXin Li        <!-- Path to screenshots. Use <img> tags for each. -->
79*d353a188SXin Li        <screenshots>
80*d353a188SXin Li            <img>screenshots/1-main.png</img>
81*d353a188SXin Li            <img>screenshots/2-settings.png</img>
82*d353a188SXin Li        </screenshots>
83*d353a188SXin Li        <!-- List of APIs that this sample should be cross-referenced under. Use <android>
84*d353a188SXin Li        for fully-qualified Framework class names ("android:" namespace).
85*d353a188SXin Li
86*d353a188SXin Li        Use <ext> for custom namespaces, if needed. See "Samples Index API" documentation
87*d353a188SXin Li        for more details. -->
88*d353a188SXin Li        <api_refs>
89*d353a188SXin Li            <android>android.app.ActionBar</android>
90*d353a188SXin Li        </api_refs>
91*d353a188SXin Li
92*d353a188SXin Li        <!-- 1-3 line description of the sample here.
93*d353a188SXin Li
94*d353a188SXin Li            Avoid simply rearranging the sample's title. What does this sample actually
95*d353a188SXin Li            accomplish, and how does it do it? -->
96*d353a188SXin Li        <description>
97*d353a188SXin Li            Sample demonstrating how to instantiate an ActionBar on Android, define
98*d353a188SXin Li            action items, and set an "up" navigation link. Uses the Support Library
99*d353a188SXin Li            for compatibility with pre-3.0 devices.
100*d353a188SXin Li        </description>
101*d353a188SXin Li
102*d353a188SXin Li        <!-- Multi-paragraph introduction to sample, from an educational point-of-view.
103*d353a188SXin Li        Makrdown formatting allowed. This will be used to generate a mini-article for the
104*d353a188SXin Li        sample on DAC. -->
105*d353a188SXin Li        <intro>
106*d353a188SXin Li            Long intro here.
107*d353a188SXin Li
108*d353a188SXin Li            Multi-paragraph introduction to sample, from an educational point-of-view.
109*d353a188SXin Li            *Makrdown* formatting allowed. See [Markdown Documentation][1]
110*d353a188SXin Li            for details.
111*d353a188SXin Li
112*d353a188SXin Li            [1]: http://daringfireball.net/projects/markdown/syntax
113*d353a188SXin Li        </intro>
114*d353a188SXin Li    </metadata>
115*d353a188SXin Li</sample>
116