diff --git a/_includes/custom/usermap.md b/_includes/custom/usermap.md new file mode 100644 index 0000000..4222ac1 --- /dev/null +++ b/_includes/custom/usermap.md @@ -0,0 +1,22 @@ + +
+ + + + + + + + + + + + + + + + + +
Connect to ADB
→
Download and Build the Starter Kit
→
Take a Tour
→
Load Your Widgets
→
Query for Something
→
Filter for Something
→
Configure this Gizmo
+
+ diff --git a/css/customstyles.css b/css/customstyles.css index 5b3320f..a9553fe 100644 --- a/css/customstyles.css +++ b/css/customstyles.css @@ -1035,3 +1035,43 @@ table thead th code.highlighter-rouge { background-color: transparent; } + +.box1, .box2, .box3, .box4, .box5, .box6, .box7, .box8, .box9, .box10, .box11, .box12 { + padding: 15px; + border: 1px solid #888; + box-shadow: 2px 2px 4px #dedede; + margin: 5px 5px; + width: 100px; + height: 80px; + background-color: #f5f5f5; + font-family: Arial; + font-size: 12px; + hyphens: auto; + +} + +#userMap { + max-width: 900px; + overflow-x: scroll; + overflow-y: hidden; + padding: 20px; +} + +#userMap .active { + background-color: #d6f5d6; + border:1px solid #555; + font-weight: bold; +} + +h2.userMapTitle { + font-family: Arial; +} + +#userMap table td { + vertical-align: middle; + font-size: x-large; +} + +#userMap a:hover { + text-decoration: none; + } diff --git a/images/workflowarrow.png b/images/workflowarrow.png new file mode 100644 index 0000000..91a3e81 Binary files /dev/null and b/images/workflowarrow.png differ diff --git a/index.md b/index.md index cfce5f4..b53924b 100644 --- a/index.md +++ b/index.md @@ -11,11 +11,47 @@ These brief instructions will help you get started quickly with the theme. The o ## Build this theme -If you're used to running Jekyll sites, you can type the normal jekyll command, `jekyll serve`, to run this site. However, if you're a new Jekyll user or if you run into issues, see the following two topics: +If you're used to running Jekyll sites, you can type the normal jekyll command, `jekyll serve`, to build the Jekyll theme. However, if you're a new Jekyll user or if you run into issues, see the following two topics: * {{site.data.urls.mydoc_install_jekyll_on_mac.link}} * {{site.data.urls.mydoc_install_jekyll_on_windows.link}} +## Customize the Gemfile + + + +## +Open the Gemfile (in any text editor) in the Jekyll doc theme project: + +``` +open Gemfile +``` + +The theme's gemfile looks as follows: + +``` +# A sample Gemfile +source "https://rubygems.org" + +# gem "rails" +gem 'github-pages' +gem 'jekyll' +``` + +If you're publishing on Github Pages, leave the `github-pages` gem there. But if not, remove `github-pages` because Github sometimes has dependencies that conflict with the latest versions of the Jekyll gem and Kramdown, which can be frustrating. + +Use Bundler to install all the needed Ruby gems: + +``` +bundle install +``` + +Now run Jekyll serve to build the theme: + +``` +jekyll serve +``` + ## Configure the sidebar There are several products in this theme. Each product uses a different sidebar. This is the essence of what makes this theme unique -- different sidebars for different product documentation. The idea is that when users are reading documentation for a specific product, the sidebar navigation should be specific to that product. (You can read more of my thoughts on why multiple sidebars are important in this [blog post](http://idratherbewriting.com/2016/03/23/release-of-documentation-theme-for-jekyll-50/).) @@ -135,7 +171,7 @@ For more detail on the sidebar, see {{site.data.urls.mydoc_sidebar_navigation.li ## Page frontmatter -When you write pages, include this same frontmatter in each page: +When you write pages, include these same frontmatter keys with each page: ```yaml --- @@ -149,20 +185,21 @@ permalink: /yoururl/ --- ``` -(If you're using [Webstorm]({{site.data.urls.mydoc_webstorm_text_editor.url}}), you can set up a template to auto-populate this code when you create a new file.) +(You will customize the values for each of these keys, of course.) -For titles, surrounding the title in quotes is optional, but if you have a colon in the title, you must surround the title with quotation marks. +If you're using [Webstorm]({{site.data.urls.mydoc_webstorm_text_editor.url}}), you can set up a template to auto-populate this code when you create a new file. -Keywords get populated into the metadata of the page for SEO. +For titles, surrounding the title in quotes is optional, but if you have a colon in the title, you must surround the title with quotation marks. If you have a quotation mark within the title, escape it first with a backlash `\`. -Tags must be defined in your \_data/tags.yml list. You also need a corresponding tag file inside the tags folder that follows the same pattern as the other tag files shown in the tags folder. (Jekyll wont auto-create these tag files.) +Values for `keywords` get populated into the metadata of the page for SEO. + +Values for `tags` must be defined in your \_data/tags.yml list. You also need a corresponding tag file inside the tags folder that follows the same pattern as the other tag files shown in the tags folder. (Jekyll wont auto-create these tag files.) ``` If you don't want the mini-TOC to show on a page (such as for the homepage or landing pages), add `toc: false` in the frontmatter. For more detail, see {{site.data.urls.mydoc_pages.link}}. - ## Where to store your documentation topics Store your files for each product inside subfolders following the pattern shown in the theme. For example, product1, product2, etc. You can store your topics inside sub-subfolders or sub-sub-folders to your heart's content. When Jekyll builds your site, it will pull the topics into the root directory and use the permalink for the URL. @@ -179,7 +216,6 @@ For external URLs, use `external_url` in the item property, as shown in the exam Note that the topnav has two sections: topnav and topnav_dropdowns. The topnav section contains single links, while the topnav_dropdowns section contains dropdown menus. The two sections are independent of each other. - ## Generating PDF If you want to generate PDF, you'll need a license for [Prince XML](http://www.princexml.com/). You will also need to [install Prince](http://www.princexml.com/doc/installing/). You can generate PDFs by product (but not for every product on the site combined together into one massive PDF). Prince will work even without a license, but it will imprint a small Prince image on the first page. @@ -227,7 +263,7 @@ See the topics under "Formatting" in the sidebar for more information. ## Managing links -If you want to use a simple system for managing links, see the "Managed Links" section in {{site.data.urls.mydoc_hyperlinks.link}}. +If you want to use a simple system for managing links, see the "Managed Links" section in {{site.data.urls.mydoc_hyperlinks.link | append: "#managed-links"}}. ## Other instructions diff --git a/mydoc/mydoc_about_ruby_gems_bundler.md b/mydoc/mydoc_about_ruby_gems_bundler.md index 9928870..a79ccfb 100644 --- a/mydoc/mydoc_about_ruby_gems_bundler.md +++ b/mydoc/mydoc_about_ruby_gems_bundler.md @@ -49,6 +49,7 @@ RedCloth = 4.2.9 rouge = 1.10.1 terminal-table ~> 1. ``` + See how Bundler retrieved version 3.0.3 of the jekyll gem, even though (as of this writing) the latest version of the jekyll gem is 3.1.2? That's because github-pages is only compatible up to jekyll 3.0.3. Bundler handles all of this dependency and version compatibility for you. Trying to keep track of which gems and versions are appropriate for your project can be a nightmare. This is the problem Bundler solves. As explained on [Bundler.io](http://bundler.io/): diff --git a/mydoc/mydoc_install_jekyll_on_mac.md b/mydoc/mydoc_install_jekyll_on_mac.md index 38681e9..a5e3e5e 100644 --- a/mydoc/mydoc_install_jekyll_on_mac.md +++ b/mydoc/mydoc_install_jekyll_on_mac.md @@ -74,9 +74,23 @@ Now Ruby and Rubygems are installed under your username, so these directories ar Note that if you don't see these paths, try restarting your computer or try installing rbenv, which is a Ruby version management tool. If you still have issues getting a writeable version of Ruby, you need to resolve them before installing Bundler. -

Install Bundler

+

Install the Jekyll gem

-At this point you should have a writeable version of Ruby on your machine. Now you need to get all the gems (or Ruby plugins) that you need for your Jekyll project. [Bundler](http://bundler.io/) is a package manager for RubyGems. +At this point you should have a writeable version of Ruby and Rubygem on your machine. + +Now use `gem` to install Jekyll: + +``` +gem install jekyll +``` + +You can now use Jekyll to create new Jekyll sites following the quick-start instructions on [Jekyllrb.com](http://jekyllrb.com). + +## Installing dependencies through Bundler + +Some Jekyll themes will require certain Ruby gem dependencies. These dependencies are stored in something called a Gemfile, which is packaged with the Jekyll theme. You can install these dependencies through Bundler. (Although you don't need to install Bundler for this Documentation theme, it's a good idea to do so.) + +[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project. You install Bundler by using the gem command with RubyGems: @@ -86,37 +100,12 @@ gem install bundler If you're prompted to switch to superuser mode (`sudo`) to get the correct permissions to install Bundler in that directory, avoid doing this. All other applications that need to use Bundler will likely not have the needed permissions to run. -## Customize the Gemfile +Bundler goes out and retreives all the gems that are specified in a Jekyll project's Gemfile. If you have a gem that depends on other gems to work, Bundler will go out and retrieve all of the dependencies as well. (To learn more about Bundler, see {{site.data.urls.mydoc_about_ruby_gems_etc.link}}. -Bundler goes out and retreives all the gems that are specified in your project's Gemfile. If you have a gem that depends on other gems to work, Bundler will go out and retrieve all of the dependencies as well. (To learn more about Bundler, see {{site.data.urls.mydoc_about_ruby_gems_etc.link}}. +The vanilla Jekyll site you create through `jekyll new my-awesome-site` doesn't have a Gemfile, but many other themes (including the Documentation theme for Jekyll) do have a Gemfile. -Open the Gemfile (in any text editor) in the Jekyll doc theme project: +## Serve the Jekyll Documentation theme -``` -open Gemfile -``` - -The theme's gemfile looks as follows: - -``` -# A sample Gemfile -source "https://rubygems.org" - -# gem "rails" -gem 'github-pages' -gem 'jekyll' -``` - -If you're publishing on Github Pages, leave the `github-pages` gem there. But if not, remove `github-pages` because Github sometimes has dependencies that conflict with the latest versions of the Jekyll gem and Kramdown, which can be frustrating. - -Use Bundler to install all the needed Ruby gems: - -``` -bundle install -``` - -Now run Jekyll serve to build the theme: - -``` -jekyll serve -``` \ No newline at end of file +1. Browse to the directory where you downloaded the Documentation theme for Jekyll. +2. Type `jekyll serve` +3. Go to the preview address in the browser. (Make sure you include the `/` at the end.) \ No newline at end of file diff --git a/mydoc/mydoc_install_jekyll_on_windows.md b/mydoc/mydoc_install_jekyll_on_windows.md index 5ba8b9c..3a82a3f 100644 --- a/mydoc/mydoc_install_jekyll_on_windows.md +++ b/mydoc/mydoc_install_jekyll_on_windows.md @@ -5,7 +5,7 @@ keywords: jekyll on windows, pc, ruby, ruby dev kit sidebar: mydoc_sidebar --- -{{site.data.alerts.tip}} For a better terminal emulator on Windows, download Console. This terminal allows you to create tabs and gives you more functionality. {{site.data.alerts.end}} +{{site.data.alerts.tip}} For a better terminal emulator on Windows, use [Git Bash](https://git-for-windows.github.io/). Git Bash gives you Linux-like control on Windows. {{site.data.alerts.end}} ## Install Ruby @@ -32,26 +32,39 @@ Some extensions Jekyll uses require you to natively build the code using the Rub If you get stuck, see the [official instructions for installing Ruby Dev Kit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit). +

Install the Jekyll gem

+ +At this point you should have Ruby and Rubygem on your machine. + +Now use `gem` to install Jekyll: + +``` +gem install jekyll +``` + +You can now use Jekyll to create new Jekyll sites following the quick-start instructions on [Jekyllrb.com](http://jekyllrb.com). + +## Installing dependencies through Bundler + +Some Jekyll themes will require certain Ruby gem dependencies. These dependencies are stored in something called a Gemfile, which is packaged with the Jekyll theme. You can install these dependencies through Bundler. (Although you don't need to install Bundler for this Documentation theme, it's a good idea to do so.) + +[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project. + +You install Bundler by using the gem command with RubyGems: + + ## Install Bundler -1. Using the command line, browse to the folder where you downloaded the Jekyll theme. -2. Delete the existing **Gemfile** and **Gemfile.lock** files: - - ``` - del Gemfile - del Gemfile.lock - ``` - 1. Install Bundler: `gem install bundler` -3. Initialize Bundler: `bundle init` +2. Initialize Bundler: `bundle init` This will create a new Gemfile. -4. Open the Gemfile in a text editor. +3. Open the Gemfile in a text editor. Typically you can open files from the Command Prompt by just typing the filename, but because Gemfile doesn't have a file extension, no program will automatically open it. You may need to use your File Explorer and browse to the directory, and then open the Gemfile in a text editor such as Notepad. -5. Remove the existing contents. Then paste in the following: +4. Remove the existing contents. Then paste in the following: ``` source "https://rubygems.org" @@ -61,20 +74,15 @@ If you get stuck, see the [official instructions for installing Ruby Dev Kit](ht ``` The [wdm gem](https://rubygems.org/gems/wdm/versions/0.1.1) allows for the polling of the directory and rebuilding of the Jekyll site when you make changes. This gem is needed for Windows users, not Mac users. - 6. Save and close the file. 7. Type `bundle install`. Bundle retrieves all the needed gems and gem dependencies and downloads them to your computer. At this time, Bundle also takes a snapshot of all the gems used in your project and creates a Gemfile.lock file to store this information. -## Serve the Jekyll site +## Serve the Jekyll Documentation theme -1. Browse to the jekyll theme directory. +1. Browse to the directory where you downloaded the Documentation theme for Jekyll. 2. Type `jekyll serve` 3. Go to the preview address in the browser. (Make sure you include the `/` at the end.) Unfortunately, the Command Prompt doesn't allow you to easily copy and paste the URL, so you'll have to type it manually. - -## Troubleshooting - -Bundler retrieves the latest version of the jekyll gem that is compatible with the github-pages gem. Unfortunately, in my testing, I think that version of the jekyll gem has some issues with the kramdown gem. Later versions of the jekyll gem fix the kramdown compatibility issues. If you run into this issue, let me know (especially if you solved it). diff --git a/product2/p2_sample1.md b/product2/p2_sample1.md index b2e46fc..7200800 100644 --- a/product2/p2_sample1.md +++ b/product2/p2_sample1.md @@ -6,6 +6,14 @@ sidebar: product2_sidebar permalink: /p2_sample1/ --- + + +{% include custom/usermap.md %} + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. diff --git a/product2/p2_sample2.md b/product2/p2_sample2.md index 864f2d0..ce16ef2 100644 --- a/product2/p2_sample2.md +++ b/product2/p2_sample2.md @@ -6,6 +6,14 @@ sidebar: product2_sidebar permalink: /p2_sample2/ --- + + +{% include custom/usermap.md %} + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. diff --git a/product2/p2_sample3.md b/product2/p2_sample3.md index 777c845..d637b57 100644 --- a/product2/p2_sample3.md +++ b/product2/p2_sample3.md @@ -6,6 +6,14 @@ sidebar: product2_sidebar permalink: /p2_sample3/ --- + + +{% include custom/usermap.md %} + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. diff --git a/product2/p2_sample4.md b/product2/p2_sample4.md index abaa782..48ea2dd 100644 --- a/product2/p2_sample4.md +++ b/product2/p2_sample4.md @@ -6,6 +6,14 @@ sidebar: product2_sidebar permalink: /p2_sample4/ --- + + +{% include custom/usermap.md %} + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. diff --git a/product2/p2_sample5.md b/product2/p2_sample5.md index d3d0057..99ca23a 100644 --- a/product2/p2_sample5.md +++ b/product2/p2_sample5.md @@ -6,6 +6,15 @@ sidebar: product2_sidebar permalink: /p2_sample5/ --- + + +{% include custom/usermap.md %} + + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. diff --git a/product2/p2_sample6.md b/product2/p2_sample6.md index a6fc58d..902dbcd 100644 --- a/product2/p2_sample6.md +++ b/product2/p2_sample6.md @@ -6,6 +6,15 @@ sidebar: product2_sidebar permalink: /p2_sample6/ --- + + +{% include custom/usermap.md %} + + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. diff --git a/product2/p2_sample7.md b/product2/p2_sample7.md index 19dc103..b68a01f 100644 --- a/product2/p2_sample7.md +++ b/product2/p2_sample7.md @@ -6,6 +6,15 @@ sidebar: product2_sidebar permalink: /p2_sample7/ --- + + +{% include custom/usermap.md %} + + ## Sample Content Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.