projects / pub / USBasp.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 15fb635)
Add more information on the integrated Help package to the Atmel Studio Getting Start...
authorDean Camera <dean@fourwalledcubicle.com>
Sun, 28 Apr 2013 12:14:37 +0000 (12:14 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Sun, 28 Apr 2013 12:14:37 +0000 (12:14 +0000)
LUFA/StudioIntegration/VSIX/GettingStarted.htm patch | blob | blame | history
LUFA/StudioIntegration/VSIX/LUFAHelpMenu.png [new file with mode: 0644] patch | blob
LUFA/StudioIntegration/makefile patch | blob | blame | history

diff --git a/LUFA/StudioIntegration/VSIX/GettingStarted.htm b/LUFA/StudioIntegration/VSIX/GettingStarted.htm
index 181aac0..28d7c06 100644 (file)
--- a/LUFA/StudioIntegration/VSIX/GettingStarted.htm
+++ b/LUFA/StudioIntegration/VSIX/GettingStarted.htm
@@ -1,7 +1,7 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml">\r
        <head>\r
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml">\r
        <head>\r
-               <title>LUFA</title>\r
+               <title>Getting Started with LUFA</title>\r
 \r
                <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
 \r
 \r
                <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
 \r
@@ -20,7 +20,7 @@
 \r
                        body\r
                        {\r
 \r
                        body\r
                        {\r
-                               background-color: #353530;\r
+                               background-color: #353535;\r
                        }\r
 \r
                        #container\r
                        }\r
 \r
                        #container\r
@@ -49,7 +49,7 @@
                        #footer\r
                        {\r
                                text-align: center;\r
                        #footer\r
                        {\r
                                text-align: center;\r
-                               font: normal 1em Georgia, sans-serif;\r
+                               font: normal 1em "Georgia", sans-serif;\r
                                color: #CCB;\r
                                padding: 20px;\r
                        }\r
                                color: #CCB;\r
                                padding: 20px;\r
                        }\r
@@ -64,12 +64,17 @@
                        {\r
                                line-height: 1.4em;\r
                                padding: 0.2em 0 1.2em;\r
                        {\r
                                line-height: 1.4em;\r
                                padding: 0.2em 0 1.2em;\r
-                               font: normal 1em Georgia, sans-serif;\r
+                               font: normal 1em "Georgia", sans-serif;\r
+                       }\r
+\r
+                       #content tt\r
+                       {\r
+                               font: normal 1em "Consolas", sans-serif;\r
                        }\r
 \r
                        #content h1\r
                        {\r
                        }\r
 \r
                        #content h1\r
                        {\r
-                               font: bold 1.3em Georgia, sans-serif;\r
+                               font: bold 1.3em "Georgia", sans-serif;\r
                                color: #3D3229;\r
                                margin-top: 2em;\r
                                margin-bottom: 0.2em;\r
                                color: #3D3229;\r
                                margin-top: 2em;\r
                                margin-bottom: 0.2em;\r
@@ -85,8 +90,15 @@
                                display: block;\r
                                margin-left: auto;\r
                                margin-right: auto;\r
                                display: block;\r
                                margin-left: auto;\r
                                margin-right: auto;\r
+                               margin-top: .5em;\r
+                               margin-bottom: 1em;\r
                        }\r
 \r
                        }\r
 \r
+                       #installedinfo\r
+                       {\r
+                               text-align: center;\r
+                               font: italic 1.1em "Georgia", sans-serif !important;\r
+                       }\r
                </style>\r
        </head>\r
        <body>\r
                </style>\r
        </head>\r
        <body>\r
@@ -96,39 +108,51 @@
                        </div>\r
 \r
                        <div id="content">\r
                        </div>\r
 \r
                        <div id="content">\r
-                               <p>The LUFA extension is now installed into Atmel Studio, and\r
-                                  is ready for use. To get started, read the information below.</p>\r
+                               <p id="installedinfo">The LUFA extension is now installed into Atmel Studio, and\r
+                                  is ready for use.\r
+                               </p>\r
 \r
                                <h1>Create an Example Project</h1>\r
                                <p>LUFA comes with a variety of example projects, showing off several of the library features. Also included is a number of\r
                                   bootloaders, full LUFA powered projects, and several user-contributed projects. To see these, open the <em>New Example Project</em>\r
 \r
                                <h1>Create an Example Project</h1>\r
                                <p>LUFA comes with a variety of example projects, showing off several of the library features. Also included is a number of\r
                                   bootloaders, full LUFA powered projects, and several user-contributed projects. To see these, open the <em>New Example Project</em>\r
-                                  wizard from the <tt>File->New</tt> menu. Expand out the <em>FourWalledCubicle</em> node, then the <em>Dean Camera - LUFA</em> node to see a list\r
-                                  of LUFA projects.</p>\r
+                                  wizard from the <tt>File&rarr;New</tt> menu. Expand out the <em>FourWalledCubicle</em> node, then the <em>Dean Camera - LUFA</em> node to see a list\r
+                                  of LUFA projects.\r
+                               </p>\r
 \r
                                   <img width="700px" src="NewExampleWizard.png" alt="Atmel Studio New Example Wizard" />\r
 \r
                                <h1>Configure LUFA</h1>\r
                                <p>The LUFA Atmel Studio extension is fully integrated into the Atmel Studio IDE, including the LUFA sub-modules. Open the\r
 \r
                                   <img width="700px" src="NewExampleWizard.png" alt="Atmel Studio New Example Wizard" />\r
 \r
                                <h1>Configure LUFA</h1>\r
                                <p>The LUFA Atmel Studio extension is fully integrated into the Atmel Studio IDE, including the LUFA sub-modules. Open the\r
-                                       <em>ASF Wizard</em> from the <tt>ASF->ASF Wizard</tt> menu, choose your project from your current solution, then choose\r
+                                       <em>ASF Wizard</em> from the <tt>ASF&rarr;ASF Wizard</tt> menu, choose your project from your current solution, then choose\r
                                        the LUFA library as the extension to configure from the <em>Available Modules</em> portion of the wizard. Here you can\r
                                        the LUFA library as the extension to configure from the <em>Available Modules</em> portion of the wizard. Here you can\r
-                                       add and remove LUFA modules to and from your project as you need them.</p>\r
+                                       add and remove LUFA modules to and from your project as you need them.\r
+                               </p>\r
 \r
                                   <img width="700px" src="ASFWizard.png" alt="Atmel ASF Module Wizard" />\r
 \r
                                <h1>Find the Module APIs</h1>\r
                                <p>You can view your project's included LUFA modules any time you need to from the <em>ASF Explorer</em> window, accessible from\r
 \r
                                   <img width="700px" src="ASFWizard.png" alt="Atmel ASF Module Wizard" />\r
 \r
                                <h1>Find the Module APIs</h1>\r
                                <p>You can view your project's included LUFA modules any time you need to from the <em>ASF Explorer</em> window, accessible from\r
-                                       the <tt>ASF->ASF Explorer</tt> menu. Here you can find a link to the module's corresponding API documentation in the LUFA\r
-                                       manual, as well as a direct link to the module's API header.</p>\r
+                                       the <tt>ASF&rarr;ASF Explorer</tt> menu. Here you can find a link to the module's corresponding API documentation in the LUFA\r
+                                       manual, as well as a direct link to the module's API header.\r
+                               </p>\r
 \r
                                   <img src="ASFExplorer.png" alt="Atmel ASF Explorer Tool Window" />\r
 \r
                                <h1>Get Help</h1>\r
 \r
                                   <img src="ASFExplorer.png" alt="Atmel ASF Explorer Tool Window" />\r
 \r
                                <h1>Get Help</h1>\r
-                               <p>First and foremost, remember to consult the <a href="http://www.lufa-lib.org/documentation">LUFA documentation</a>\r
-                                  if you want to learn how to use LUFA in your project.\r
+                               <p>If you installed the integrated help package, you can view the LUFA manual from the <tt>Help&rarr;View Help</tt> menu, or just\r
+                                  jump directly to the relevant documentation for a function, variable, type or other LUFA symbol in your code by first selecting\r
+                                  it and pressing the <tt>F1</tt> key. If the integrated Help package fails to instal, you can re-try from the\r
+                                  <tt>Help&rarr;LUFA Help&rarr;Reinstall LUFA Help</tt> menu entry.\r
+                               </p>\r
+\r
+                                  <img width="700px" src="LUFAHelpMenu.png" alt="Atmel ASF Module Wizard" />\r
+\r
+                               <p>The latest LUFA manual is also available for viewing <a href="http://www.lufa-lib.org/documentation">online</a>, if you\r
+                                  do not wish to use the integrated help.\r
                                </p>\r
                                <p>\r
                                </p>\r
                                <p>\r
-                                       If you are still stuck and need help, please sign up and post on the <a href="http://www.lufa-lib.org/support">LUFA Mailing List</a>\r
-                                       - or just search the archives to see if your question has already been answered.\r
+                                       If you are still stuck and need help, please post on the <a href="http://www.lufa-lib.org/support">LUFA Mailing List</a>\r
+                                       - or just search the mailing list archives to see if your question has already been answered.\r
                                </p>\r
 \r
                                <h1>Read About the Latest Developments</h1>\r
                                </p>\r
 \r
                                <h1>Read About the Latest Developments</h1>\r
diff --git a/LUFA/StudioIntegration/VSIX/LUFAHelpMenu.png b/LUFA/StudioIntegration/VSIX/LUFAHelpMenu.png
new file mode 100644 (file)
index 0000000..92416f0
Binary files /dev/null and b/LUFA/StudioIntegration/VSIX/LUFAHelpMenu.png differ
diff --git a/LUFA/StudioIntegration/makefile b/LUFA/StudioIntegration/makefile
index 471ab6d..c05a89d 100644 (file)
--- a/LUFA/StudioIntegration/makefile
+++ b/LUFA/StudioIntegration/makefile
@@ -35,12 +35,12 @@ VSIX_ASSETS          := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png \
                         VSIX/"[Content_Types].xml"                      \
                         VSIX/ASFExplorer.png                            \
                         VSIX/ASFWizard.png                              \
                         VSIX/"[Content_Types].xml"                      \
                         VSIX/ASFExplorer.png                            \
                         VSIX/ASFWizard.png                              \
+                        VSIX/LUFAHelpMenu.png                           \
                         VSIX/NewExampleWizard.png                       \
                         VSIX/GettingStarted.htm                         \
                         Blob/Atmel.Studio.Services.Interfaces.dll       \
                         Blob/LUFA.dll                                   \
                         VSIX/NewExampleWizard.png                       \
                         VSIX/GettingStarted.htm                         \
                         Blob/Atmel.Studio.Services.Interfaces.dll       \
                         Blob/LUFA.dll                                   \
-                        Blob/LUFA.pkgdef                                \
-
+                        Blob/LUFA.pkgdef
 MSHELP_GEN_PARAMS   := --stringparam generate.toc "book toc"            \
                        --stringparam chunk.quietly "1"                  \
                        --stringparam chunk.section.depth "3"            \
 MSHELP_GEN_PARAMS   := --stringparam generate.toc "book toc"            \
                        --stringparam chunk.quietly "1"                  \
                        --stringparam chunk.section.depth "3"            \
USB isp AVR programmer