cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nikhi...@apache.org
Subject docs commit: Changing the XML reference formatting for required and platforms attributes. This closes #473
Date Sat, 30 Jan 2016 02:26:16 GMT
Repository: cordova-docs
Updated Branches:
  refs/heads/master e7bfcca11 -> 6dbb5ddd8


Changing the XML reference formatting for required and platforms attributes. This closes #473


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6dbb5ddd
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6dbb5ddd
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6dbb5ddd

Branch: refs/heads/master
Commit: 6dbb5ddd8079b2af234e1236ba65b8e4ee70c62d
Parents: e7bfcca
Author: Raghav Katyal <rakatyal@microsoft.com>
Authored: Fri Jan 29 15:20:39 2016 -0800
Committer: Nikhil Khandelwal <nikhilkh@microsoft.com>
Committed: Fri Jan 29 18:14:35 2016 -0800

----------------------------------------------------------------------
 _config.yml                   |  1 +
 doc/docs-STYLEGUIDE.md        | 13 ++++++-------
 www/static/css-src/_docs.scss |  6 ++++++
 3 files changed, 13 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6dbb5ddd/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index c0abd29..b85f9f2 100644
--- a/_config.yml
+++ b/_config.yml
@@ -73,6 +73,7 @@ redcarpet:
         - lax_spacing
 
         - tables
+        - highlight
         
         # enables anchor links
         - with_toc_data

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6dbb5ddd/doc/docs-STYLEGUIDE.md
----------------------------------------------------------------------
diff --git a/doc/docs-STYLEGUIDE.md b/doc/docs-STYLEGUIDE.md
index 1b0a5b5..e9cac3c 100644
--- a/doc/docs-STYLEGUIDE.md
+++ b/doc/docs-STYLEGUIDE.md
@@ -414,7 +414,7 @@ help identify them in Markdown.
 
   * Default: Use *italics* formatting to provide default value of the attribute
   * Required: Use *italics* formatting to provide if the attribute value is required
-  * Platforms supported: Use **bold** to specify platforms supported. Default is supported
in all platforms.
+  * Platforms supported: Use ==platform-name== to specify different platforms. This gets
custom highlighted on the website. Default is supported in all platforms.
   * Textual Description.
 
 * Below is an example documentation for 'platform' element for plugin.xml. 'source-file'
is a sub-element of the 'platform' element.
@@ -424,7 +424,7 @@ help identify them in Markdown.
 
     Attributes(type) | Description
     ---------------- | ------------
-    name(string) | *Required: true* <br/> Allowed values: ios, android, blackberry10,
amazon-fireos, wp8, windows <br/> Identifies a platform as supported, associating the
element's children with that platform.
+    name(string) | *Required* <br/> Allowed values: ios, android, blackberry10, amazon-fireos,
wp8, windows <br/> Identifies a platform as supported, associating the element's children
with that platform.
 
     Example:
     ```
@@ -438,16 +438,15 @@ help identify them in Markdown.
 
     Attributes (type) | Description
     ----------------- | ------------
-    src(string) | *Required: true* <br/> Location of the file relative to plugin.xml.
If the src file can't be found, plugman stops and reverses the installation, issues a notification
about the problem, and exits with a non-zero code.
+    src(string) | *Required* <br/> Location of the file relative to plugin.xml. If
the src file can't be found, plugman stops and reverses the installation, issues a notification
about the problem, and exits with a non-zero code.
     target-dir(string) | A directory into which the files should be copied, relative to the
root of the Cordova project. In practice, this is most important for Java-based platforms,
where a file in the com.alunny.foo package must be located within the com/alunny/foo directory.
For platforms where the source directory is not important, this attribute should be omitted.
-    framework(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/>
If set to true, also adds the specified file as a framework to the project.
-    compiler-flags(string) | **Platforms supported: iOS** <br/> If set, assigns the
specified compiler flags for the particular source file.
+    framework(boolean) | *Default: false* <br/> ==iOS== <br/> If set to true,
also adds the specified file as a framework to the project.
+    compiler-flags(string) | ==iOS== <br/> If set, assigns the specified compiler flags
for the particular source file.
 
     Examples:
     ```
     <!-- android -->
-    <source-file src="src/android/Foo.java"
-                  target-dir="src/com/alunny/foo" />
+    <source-file src="src/android/Foo.java" target-dir="src/com/alunny/foo" />
     <!-- ios -->
     <source-file src="src/ios/CDVFoo.m" />
     <source-file src="src/ios/someLib.a" framework="true" />

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6dbb5ddd/www/static/css-src/_docs.scss
----------------------------------------------------------------------
diff --git a/www/static/css-src/_docs.scss b/www/static/css-src/_docs.scss
index a34fe45..2b0c3b5 100644
--- a/www/static/css-src/_docs.scss
+++ b/www/static/css-src/_docs.scss
@@ -22,6 +22,12 @@
         }
     }
 
+    mark {
+        background-color: lightblue;
+        padding: 0.1px 0.2px 0.1px 0.2px;
+        margin-right: 7px;
+    }
+
     .site-toc-title {
         font-weight: 300;
         font-size: 22px;


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message