Merge pull request #2532 from bootstraponline/master_tables

Update docs for Slate
This commit is contained in:
bootstraponline
2014-05-10 14:07:39 -07:00
5 changed files with 22 additions and 9 deletions

View File

@@ -1,5 +1,7 @@
# Appium 服务关键字
<expand_table>
|关键字|描述|实例|
|----|-----------|-------|
|`app`|`.ipa` or `.apk`文件所在的本地绝对路径或者远程路径,也可以是一个包括两者的`.zip`. Appium会先尝试安装路径对应的应用在适当的真机或模拟器上.也可以是一个`chrome`或者`chromium`这样就会在android系统中其中chrome或chromium,也可以是`safari`会启动ios上的safari. 针对Android系统如果你指定`app-package``app-activity`(具体见下面)的话,那么就可以不指定`app`.|比如`/abs/path/to/my.apk``http://myapp.com/app.ipa`, Android上的`chrome`, `chromium`, iOS的`safari`|
@@ -11,6 +13,8 @@
### Android特有
<expand_table>
|关键字|描述|实例|
|----|-----------|-------|
|`app-activity`| 你要启动的Android 应用对应的Activity名称|比如`MainActivity`, `.Settings`|
@@ -21,6 +25,8 @@
### iOS特有
<expand_table>
|关键字|描述|实例|
|----|-----------|-------|
|`calendarFormat`| 为iOS的模拟器设置日历格式|比如. `gregorian`公历|

View File

@@ -5,6 +5,8 @@
###
所有的标志都是可选的,但是有一些标志需要组合在一起才能生效。
<expand_table>
|标志|默认值|描述|例子|
|----|-------|-----------|-------|
|`--shell`|null|进入 REPL 模式||

View File

@@ -1,5 +1,7 @@
# Appium server capabilities
<expand_table>
|Capability|Description|Values|
|----|-----------|-------|
|`automationName`|Which automation engine to use|`Appium` (default) or `Selendroid`|
@@ -13,6 +15,8 @@
### Android Only
<expand_table>
|Capability|Description|Values|
|----|-----------|-------|
|`appActivity`| Activity name for the Android activity you want to launch from your package|`MainActivity`, `.Settings`|
@@ -29,6 +33,8 @@
### iOS Only
<expand_table>
|Capability|Description|Values|
|----|-----------|-------|
|`calendarFormat`| (Sim-only) Calendar format to set for the iOS Simulator|e.g. `gregorian`|

View File

@@ -3,9 +3,12 @@
Usage: `node . [flags]`
## Server flags
All flags are optional, but some are required in conjunction with certain others.
<expand_table>
|Flag|Default|Description|Example|
|----|-------|-----------|-------|
|`--shell`|null|Enter REPL mode||
@@ -64,4 +67,4 @@ All flags are optional, but some are required in conjunction with certain others
|`--key-password`|android|(Android-only) Key password||
|`--show-config`|false|Show info about the appium server configuration and exit||
|`--command-timeout`|60|The default command timeout for the server to use for all sessions. Will still be overridden by newCommandTimeout cap||
|`--keep-keychains`|false|(iOS) Whether to keep keychains (Library/Keychains) when reset app between sessions||
|`--keep-keychains`|false|(iOS) Whether to keep keychains (Library/Keychains) when reset app between sessions||

View File

@@ -565,16 +565,12 @@ module.exports.installAndroidApp = function (grunt, appName, cb) {
module.exports.generateServerDocs = function (grunt, cb) {
var p = parser();
var docFile = path.resolve(__dirname, "docs/en/server-args.md");
var md = "---\n" +
"title: Appium server arguments\n" +
"layout: default\n" +
"---\n\n" +
"Appium server arguments\n" +
"==========\n\n";
var md = "# Appium server arguments\n\n";
md += "Usage: `node . [flags]`\n\n";
md += "### Server flags\n";
md += "## Server flags\n";
md += "All flags are optional, but some are required in conjunction with " +
"certain others.\n\n";
md += "\n\n<expand_table>\n\n";
md += "|Flag|Default|Description|Example|\n";
md += "|----|-------|-----------|-------|\n";
_.each(p.rawArgs, function (arg) {