From ca2f60d6be639106f230911b5df64b48a1331a3d Mon Sep 17 00:00:00 2001 From: William DURAND Date: Fri, 2 Sep 2011 16:04:50 +0200 Subject: [PATCH] Updated documentation --- README.markdown | 26 +++++++++++++++++++++----- Resources/doc/README | 26 +++++++++++++++++++++----- Resources/doc/README.markdown | 26 +++++++++++++++++++++----- 3 files changed, 63 insertions(+), 15 deletions(-) diff --git a/README.markdown b/README.markdown index 3c279d6..e9fef85 100644 --- a/README.markdown +++ b/README.markdown @@ -231,17 +231,19 @@ SQL will be write in `app/propel/sql/`. You can load your own fixtures by using the following command: - > php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--connection[="..."]] + > php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--yml] [--connection[="..."]] As usual, `--connection` allows to specify a connection. The `--dir` option allows to specify a directory containing the fixtures (default is: `app/propel/fixtures/`). Note that the `--dir` expects a relative path from the root dir (which is `app/`). -The --xml parameter allows you to load only XML fixtures. -The --sql parameter allows you to load only SQL fixtures. -You can mix --xml parameter and --sql parameter to load XML and SQL fixtures. -If none of this parameter are set all files, XML and SQL, in the directory will be load. +The `--xml` parameter allows you to load only XML fixtures. +The `--sql` parameter allows you to load only SQL fixtures. +The `--yml` parameter allows you to load only YAML fixtures. + +You can mix `--xml`, `--yml` and `--sql` parameters to load XML, YAML and SQL fixtures. +If none of this parameter are set all files YAML, XML and SQL in the directory will be load. A valid _XML fixtures file_ is: @@ -252,6 +254,20 @@ A valid _XML fixtures file_ is: ``` +A valid _YAML fixtures file_ is: + +``` yaml +\Awesome\Object: + o1: + Title: My title + MyFoo: bar + + \Awesome\Related: + r1: + ObjectId: o1 + Description: Hello world ! +``` + ### Graphviz diff --git a/Resources/doc/README b/Resources/doc/README index 3c279d6..e9fef85 100644 --- a/Resources/doc/README +++ b/Resources/doc/README @@ -231,17 +231,19 @@ SQL will be write in `app/propel/sql/`. You can load your own fixtures by using the following command: - > php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--connection[="..."]] + > php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--yml] [--connection[="..."]] As usual, `--connection` allows to specify a connection. The `--dir` option allows to specify a directory containing the fixtures (default is: `app/propel/fixtures/`). Note that the `--dir` expects a relative path from the root dir (which is `app/`). -The --xml parameter allows you to load only XML fixtures. -The --sql parameter allows you to load only SQL fixtures. -You can mix --xml parameter and --sql parameter to load XML and SQL fixtures. -If none of this parameter are set all files, XML and SQL, in the directory will be load. +The `--xml` parameter allows you to load only XML fixtures. +The `--sql` parameter allows you to load only SQL fixtures. +The `--yml` parameter allows you to load only YAML fixtures. + +You can mix `--xml`, `--yml` and `--sql` parameters to load XML, YAML and SQL fixtures. +If none of this parameter are set all files YAML, XML and SQL in the directory will be load. A valid _XML fixtures file_ is: @@ -252,6 +254,20 @@ A valid _XML fixtures file_ is: ``` +A valid _YAML fixtures file_ is: + +``` yaml +\Awesome\Object: + o1: + Title: My title + MyFoo: bar + + \Awesome\Related: + r1: + ObjectId: o1 + Description: Hello world ! +``` + ### Graphviz diff --git a/Resources/doc/README.markdown b/Resources/doc/README.markdown index 3c279d6..e9fef85 100644 --- a/Resources/doc/README.markdown +++ b/Resources/doc/README.markdown @@ -231,17 +231,19 @@ SQL will be write in `app/propel/sql/`. You can load your own fixtures by using the following command: - > php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--connection[="..."]] + > php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--yml] [--connection[="..."]] As usual, `--connection` allows to specify a connection. The `--dir` option allows to specify a directory containing the fixtures (default is: `app/propel/fixtures/`). Note that the `--dir` expects a relative path from the root dir (which is `app/`). -The --xml parameter allows you to load only XML fixtures. -The --sql parameter allows you to load only SQL fixtures. -You can mix --xml parameter and --sql parameter to load XML and SQL fixtures. -If none of this parameter are set all files, XML and SQL, in the directory will be load. +The `--xml` parameter allows you to load only XML fixtures. +The `--sql` parameter allows you to load only SQL fixtures. +The `--yml` parameter allows you to load only YAML fixtures. + +You can mix `--xml`, `--yml` and `--sql` parameters to load XML, YAML and SQL fixtures. +If none of this parameter are set all files YAML, XML and SQL in the directory will be load. A valid _XML fixtures file_ is: @@ -252,6 +254,20 @@ A valid _XML fixtures file_ is: ``` +A valid _YAML fixtures file_ is: + +``` yaml +\Awesome\Object: + o1: + Title: My title + MyFoo: bar + + \Awesome\Related: + r1: + ObjectId: o1 + Description: Hello world ! +``` + ### Graphviz