You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by sh...@apache.org on 2012/07/13 03:10:06 UTC
ios commit: Moved FirstRun from CordovaInstaller subfolder, to root
Updated Branches:
refs/heads/master 3a180ca47 -> 95b9fa46c
Moved FirstRun from CordovaInstaller subfolder, to root
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/commit/95b9fa46
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/tree/95b9fa46
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/diff/95b9fa46
Branch: refs/heads/master
Commit: 95b9fa46cc4a249262b2fbace97e7dd1dc37aa76
Parents: 3a180ca
Author: Shazron Abdullah <sh...@apache.org>
Authored: Thu Jul 12 18:09:57 2012 -0700
Committer: Shazron Abdullah <sh...@apache.org>
Committed: Thu Jul 12 18:09:57 2012 -0700
----------------------------------------------------------------------
CordovaInstaller/CordovaInstaller.pmdoc/index.xml | 2 +-
CordovaInstaller/docs/.gitignore | 4 +-
CordovaInstaller/docs/finishup.md | 70 ----------------
FirstRun.md | 70 ++++++++++++++++
Makefile | 24 +++---
5 files changed, 85 insertions(+), 85 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/95b9fa46/CordovaInstaller/CordovaInstaller.pmdoc/index.xml
----------------------------------------------------------------------
diff --git a/CordovaInstaller/CordovaInstaller.pmdoc/index.xml b/CordovaInstaller/CordovaInstaller.pmdoc/index.xml
index d7aee92..6c57188 100644
--- a/CordovaInstaller/CordovaInstaller.pmdoc/index.xml
+++ b/CordovaInstaller/CordovaInstaller.pmdoc/index.xml
@@ -22,7 +22,7 @@
<resource relative="true" mod="true" type="background">cordova.png</resource>
<resource relative="true" mod="true" type="readme">docs/readme.rtf</resource>
<resource relative="true" mod="true" type="welcome">docs/releasenotes.rtf</resource>
- <resource relative="true" mod="true" type="conclusion">docs/finishup.rtf</resource>
+ <resource relative="true" mod="true" type="conclusion">docs/firstrun.rtf</resource>
</locale>
</resources>
<flags/>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/95b9fa46/CordovaInstaller/docs/.gitignore
----------------------------------------------------------------------
diff --git a/CordovaInstaller/docs/.gitignore b/CordovaInstaller/docs/.gitignore
index 25c33a0..560cf76 100644
--- a/CordovaInstaller/docs/.gitignore
+++ b/CordovaInstaller/docs/.gitignore
@@ -1 +1,3 @@
-*.rtf
\ No newline at end of file
+*.rtf
+*.html
+*.md
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/95b9fa46/CordovaInstaller/docs/finishup.md
----------------------------------------------------------------------
diff --git a/CordovaInstaller/docs/finishup.md b/CordovaInstaller/docs/finishup.md
deleted file mode 100644
index c0ab040..0000000
--- a/CordovaInstaller/docs/finishup.md
+++ /dev/null
@@ -1,70 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
--->
-## Thanks for installing Cordova {VERSION}!
-
-## Plugins
-
-* **DO NOT CHECK** the "Automatic Reference Counting" option when creating a new project, if not you will have compile errors.
-* Plugins **MUST** add their plugin mapping to their app's Cordova.plist Plugins key, if not they will not work (see your plugin's README)
-* Plugins **MUST** add any external hosts they connect to to the white-list in Cordova.plist/ExternalHosts (add hostnames **only**, NO protocols nor paths)
-* A plugin's Objective-C code **MUST** be added to the project properly in a "group" (**YELLOW** folder), if you incorrectly added it as a folder reference it would be a blue folder (just delete the reference, and re-add)
-* A lot of plugins have changed their mapping names in Cordova.plist, you might have to copy and use the new Cordova.plist in your app.
-
-<br />
-
-## Upgraders
-
-1. Please see the [**"Upgrading Cordova iOS"**](http://docs.phonegap.com/en/edge/guide_upgrading_index.md.html) document on [http://docs.phonegap.com](http://docs.phonegap.com)
-2. See the FAQ in the README.pdf as well
-
-<br />
-
-## Xcode 4
-
-1. Launch Xcode 4
-2. Select "New Project..." then under the File menu
-3. Select "Application", under the "iOS" section
-4. Select "Cordova-based Application" then in the right pane
-5. Select the "Next" button
-6. Name your project and bundle identifier
-7. Select the "Next" button
-8. Choose the location where you want the new project to be
-
-<br />
-
-**IMPORTANT:** On first run, it will create a sample "www" folder for you inside your project. After that, you MUST drag and drop the "www" folder into your project in Xcode, to create a **folder reference** for it (**BLUE** folder).
-<br />
-
-**IMPORTANT:** For the "CoreMedia", "UIKit" and "AVFoundation" frameworks, you MUST set the linkage as "Optional", if not iOS 3.x devices will crash. The linkage type could not be set in the template itself (undocumented).
-<br />
-
-**NOTE:** In post-1.0.0 releases, new project templates have these 3 frameworks specified above weak linked through linker flags during compile time, and you will not have to do this manually anymore.
-<br />
-
-That's it! Modify the contents of the "www" directory to add your HTML, CSS and Javascript.
-<br />
-
-## Links
-
-* [http://incubator.apache.org/cordova/](http://incubator.apache.org/cordova/)
-
-
-<br />
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/95b9fa46/FirstRun.md
----------------------------------------------------------------------
diff --git a/FirstRun.md b/FirstRun.md
new file mode 100644
index 0000000..c0ab040
--- /dev/null
+++ b/FirstRun.md
@@ -0,0 +1,70 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+## Thanks for installing Cordova {VERSION}!
+
+## Plugins
+
+* **DO NOT CHECK** the "Automatic Reference Counting" option when creating a new project, if not you will have compile errors.
+* Plugins **MUST** add their plugin mapping to their app's Cordova.plist Plugins key, if not they will not work (see your plugin's README)
+* Plugins **MUST** add any external hosts they connect to to the white-list in Cordova.plist/ExternalHosts (add hostnames **only**, NO protocols nor paths)
+* A plugin's Objective-C code **MUST** be added to the project properly in a "group" (**YELLOW** folder), if you incorrectly added it as a folder reference it would be a blue folder (just delete the reference, and re-add)
+* A lot of plugins have changed their mapping names in Cordova.plist, you might have to copy and use the new Cordova.plist in your app.
+
+<br />
+
+## Upgraders
+
+1. Please see the [**"Upgrading Cordova iOS"**](http://docs.phonegap.com/en/edge/guide_upgrading_index.md.html) document on [http://docs.phonegap.com](http://docs.phonegap.com)
+2. See the FAQ in the README.pdf as well
+
+<br />
+
+## Xcode 4
+
+1. Launch Xcode 4
+2. Select "New Project..." then under the File menu
+3. Select "Application", under the "iOS" section
+4. Select "Cordova-based Application" then in the right pane
+5. Select the "Next" button
+6. Name your project and bundle identifier
+7. Select the "Next" button
+8. Choose the location where you want the new project to be
+
+<br />
+
+**IMPORTANT:** On first run, it will create a sample "www" folder for you inside your project. After that, you MUST drag and drop the "www" folder into your project in Xcode, to create a **folder reference** for it (**BLUE** folder).
+<br />
+
+**IMPORTANT:** For the "CoreMedia", "UIKit" and "AVFoundation" frameworks, you MUST set the linkage as "Optional", if not iOS 3.x devices will crash. The linkage type could not be set in the template itself (undocumented).
+<br />
+
+**NOTE:** In post-1.0.0 releases, new project templates have these 3 frameworks specified above weak linked through linker flags during compile time, and you will not have to do this manually anymore.
+<br />
+
+That's it! Modify the contents of the "www" directory to add your HTML, CSS and Javascript.
+<br />
+
+## Links
+
+* [http://incubator.apache.org/cordova/](http://incubator.apache.org/cordova/)
+
+
+<br />
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/95b9fa46/Makefile
----------------------------------------------------------------------
diff --git a/Makefile b/Makefile
index 882546c..2b1ced6 100644
--- a/Makefile
+++ b/Makefile
@@ -71,6 +71,8 @@ clean-markdown:
clean-installer:
@$(RM_F) CordovaInstaller/docs/*.rtf
+ @$(RM_F) CordovaInstaller/docs/*.html
+ @$(RM_F) CordovaInstaller/docs/*.md
@$(RM_F) CordovaInstaller/docs/*.pdf
@$(RM_F) CordovaInstaller/docs/*.html
@@ -117,24 +119,22 @@ installer: check-utils clean check-wkhtmltopdf md-to-html
$(RM_RF) dist; \
fi
@# backup markdown files for version replace
- @$(MV) -f RELEASENOTES.md RELEASENOTES.md.bak
- @$(MV) -f CordovaInstaller/docs/finishup.md CordovaInstaller/docs/finishup.md.bak
- @$(CAT) CordovaInstaller/docs/finishup.md.bak | sed 's/{VERSION}/${CDV_VER}/' > CordovaInstaller/docs/finishup.md
- @$(CAT) RELEASENOTES.md.bak | sed 's/{VERSION}/${CDV_VER}/' > CordovaInstaller/docs/RELEASENOTES.md
+ @$(CAT) FirstRun.md | sed 's/{VERSION}/${CDV_VER}/' > CordovaInstaller/docs/FirstRun.md
+ @$(CAT) RELEASENOTES.md | sed 's/{VERSION}/${CDV_VER}/' > CordovaInstaller/docs/RELEASENOTES.md
@# generate releasenotes html from markdown
@echo '<html><body style="font-family: Helvetica Neue;">' > CordovaInstaller/docs/releasenotes.html
@$(MARKDOWN) CordovaInstaller/docs/RELEASENOTES.md >> CordovaInstaller/docs/releasenotes.html
@echo '</body></html>' >> CordovaInstaller/docs/releasenotes.html
- @# generate finishup html from markdown
- @echo '<html><body style="font-family: Helvetica Neue;">' > CordovaInstaller/docs/finishup.html
- @$(MARKDOWN) CordovaInstaller/docs/finishup.md >> CordovaInstaller/docs/finishup.html
- @echo '</body></html>' >> CordovaInstaller/docs/finishup.html
+ @# generate firstrun html from markdown
+ @echo '<html><body style="font-family: Helvetica Neue;">' > CordovaInstaller/docs/firstrun.html
+ @$(MARKDOWN) CordovaInstaller/docs/FirstRun.md >> CordovaInstaller/docs/firstrun.html
+ @echo '</body></html>' >> CordovaInstaller/docs/firstrun.html
@# convert all the html files to rtf (for PackageMaker)
@textutil -convert rtf -font 'Helvetica' CordovaInstaller/docs/*.html
@# build the .pkg file
@echo -n "Building Cordova-${CDV_VER}.pkg..."
@$(MKPATH) dist/files/Guides
- @'$(PACKAGEMAKER)' -d CordovaInstaller/CordovaInstaller.pmdoc -o dist/files/Cordova-${CDV_VER}.pkg > /dev/null 2> $(PKG_ERROR_LOG)
+ @'$(PACKAGEMAKER)' -d CordovaInstaller/CordovaInstaller.pmdoc -o dist/files/Cordova-${CDV_VER}.pkg > /dev/null 2> $(PKG_ERROR_LOG)
@# create the applescript uninstaller
@osacompile -o ./dist/files/Uninstall\ Cordova.app Uninstall\ Cordova.applescript > /dev/null 2>> $(PKG_ERROR_LOG)
@# convert the html docs to pdf, concatenate readme and license
@@ -144,12 +144,9 @@ installer: check-utils clean check-wkhtmltopdf md-to-html
@$(WKHTMLTOPDF) --footer-center "Cordova ${CDV_VER} JavaScript Exception Logging" CordovaInstaller/docs/exception_logging.html 'dist/files/Guides/Cordova JavaScript Exception Logging.pdf' > /dev/null 2>> $(PKG_ERROR_LOG)
@$(WKHTMLTOPDF) --footer-center "Cordova ${CDV_VER} Custom URL Scheme Handling" CordovaInstaller/docs/custom_url_scheme.html 'dist/files/Guides/Cordova Custom URL Scheme Handling.pdf' > /dev/null 2>> $(PKG_ERROR_LOG)
@textutil -convert html -font 'Courier New' LICENSE -output CordovaInstaller/docs/LICENSE.html > /dev/null 2>> $(PKG_ERROR_LOG)
- @textutil -cat html CordovaInstaller/docs/finishup.html CordovaInstaller/docs/readme.html CordovaInstaller/docs/LICENSE.html -output dist/files/Readme.html > /dev/null 2>> $(PKG_ERROR_LOG)
+ @textutil -cat html CordovaInstaller/docs/firstrun.html CordovaInstaller/docs/readme.html CordovaInstaller/docs/LICENSE.html -output dist/files/Readme.html > /dev/null 2>> $(PKG_ERROR_LOG)
@$(WKHTMLTOPDF) --footer-center "Cordova ${CDV_VER} Readme" dist/files/Readme.html dist/files/Readme.pdf > /dev/null 2>> $(PKG_ERROR_LOG)
@$(RM_F) dist/files/Readme.html
- @# restore backed-up markdown files
- @$(MV) -f RELEASENOTES.md.bak RELEASENOTES.md
- @$(MV) -f CordovaInstaller/docs/finishup.md.bak CordovaInstaller/docs/finishup.md
@# sign the .pkg : must be run under one line to get return code
@-security find-certificate -c $(CERTIFICATE) > /dev/null 2>> $(PKG_ERROR_LOG); \
if [ $$? -eq 0 ] ; then \
@@ -224,6 +221,7 @@ install-markdown: check-brew
@brew install markdown
md-to-html: check-markdown
+ @mkdir -p CordovaInstaller/docs
@# generate readme html from markdown
@echo '<html><body style="font-family: Helvetica Neue; font-size:10pt;">' > CordovaInstaller/docs/readme.html
@$(MARKDOWN) README.md >> CordovaInstaller/docs/readme.html