{"id":1249,"date":"2015-10-21T10:28:49","date_gmt":"2015-10-21T15:28:49","guid":{"rendered":"https:\/\/blogs.mathworks.com\/loren\/?p=1249"},"modified":"2015-09-25T10:34:17","modified_gmt":"2015-09-25T15:34:17","slug":"whats-up-doc","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/loren\/2015\/10\/21\/whats-up-doc\/","title":{"rendered":"What&#8217;s Up, Doc?"},"content":{"rendered":"\r\n<div class=\"content\"><!--introduction--><p>Today&#8217;s guest blogger is Leslie McBrayer, who is in the Documentation group at MathWorks. Her team's goal is to make it easier for you to learn how to use our products. She is writing today about some features of the R2015b documentation: a few that are new, and a few that have been around for some time.<\/p><!--\/introduction--><h3>Contents<\/h3><div><ul><li><a href=\"#b8fbca3d-1e0e-4f11-82dc-73c8c15cfe1e\">Function and Block Pages<\/a><\/li><li><a href=\"#91e75347-de3c-4c39-a435-f89ffabe2e6a\">Archived Versions<\/a><\/li><li><a href=\"#237a9726-22a3-45c3-94c9-63beb756745f\">Online Content<\/a><\/li><li><a href=\"#2d155a77-f936-45ec-8910-7a0799f41f5c\">Font Size<\/a><\/li><li><a href=\"#da6ddf82-5866-48ae-82a0-fe5761eacd5f\">Product Information<\/a><\/li><li><a href=\"#23f60e34-f4dd-45b8-a356-89e7a9ae1e44\">Your Feedback Welcomed<\/a><\/li><\/ul><\/div><h4>Function and Block Pages<a name=\"b8fbca3d-1e0e-4f11-82dc-73c8c15cfe1e\"><\/a><\/h4><p>If you're like most folks who use our documentation, you have probably viewed reference pages that provide detailed information about how to use specific functions or blocks. To get a sense of what has changed for R2015b, let's look at the page for a brand new function, <a href=\"https:\/\/www.mathworks.com\/help\/matlab\/ref\/rad2deg.html\"><tt>rad2deg<\/tt><\/a>.<\/p><pre class=\"codeinput\">doc <span class=\"string\">rad2deg<\/span>\r\n<\/pre><p>In general, the pages look very much as they did before, though we've made some cosmetic improvements to some elements, like the search bar. In previous releases, the search bar was lurking near the top, but was in the middle of the page, close to similar-looking elements. Now, we hope you don't have to think about where to find it.<\/p><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/search-bar.png\" alt=\"\"> <\/p><p>Although this isn't one of our longer pages, it undoubtedly scrolls off the bottom of your browser window. However, you can use the new \"On This Page\" links on the left to quickly navigate to sections of the page, like \"Examples\" or \"Input Arguments.\"<\/p><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/on-this-page.png\" alt=\"\"> <\/p><p>Ideally, the examples on the page help you see how our functionality works. Did you know that you can run example code directly from the installed Help browser, without copying and pasting into the Command Window? Select the code to run, right-click, and select <b>Evaluate Section<\/b>. (This is one of those features that's been around a while, but that not everyone has discovered.)<\/p><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/evaluate-selection.png\" alt=\"\"> <\/p><p>Many functions and blocks, especially those recently introduced, indicate at the bottom of their page when they made their debut. If you scroll to the bottom of this page, you can verify that <tt>rad2deg<\/tt> is, in fact, new for R2015b.<\/p><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/introduced-in.png\" alt=\"\"> <\/p><h4>Archived Versions<a name=\"91e75347-de3c-4c39-a435-f89ffabe2e6a\"><\/a><\/h4><p>By default, the documentation that you see in the Help browser is installed on your machine along with the software. Naturally, the installed content is specific to your release.<\/p><p>We realize, though, that sometimes it's helpful to see documentation for another release. We archive previous releases of the documentation on our Web site, so you can access it there (assuming you have a MathWorks Account and license). The help landing page is at <a href=\"https:\/\/www.mathworks.com\/help\/\">www.mathworks.com\/help<\/a>.<\/p><p>From the landing page, you can select \"Other Releases\" from the list on the left side of the page. Then, you can choose the release from <a href=\"https:\/\/www.mathworks.com\/help\/doc-archives.html\">the list<\/a>.<\/p><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/other-releases.png\" alt=\"\"> <\/p><h4>Online Content<a name=\"237a9726-22a3-45c3-94c9-63beb756745f\"><\/a><\/h4><p>Of course, the online documentation isn't just for archived versions: it is also where we maintain the most up-to-date content for our products. You can view this content in MATLAB by setting a Help preference. Specifically, on the <b>Home<\/b> tab, in the <b>Environment<\/b> section, click <b>Preferences<\/b>. Select <b>MATLAB &gt; Help<\/b>, and then set the <b>Documentation Location<\/b>.<\/p><h4>Font Size<a name=\"2d155a77-f936-45ec-8910-7a0799f41f5c\"><\/a><\/h4><p>If the text seems too large or small, you can quickly zoom into the page using <b>Ctrl + Mouse Scroll<\/b>. This setting is remembered across sessions, and applies to all subsequent Help browser tabs--which, by the way, you can now manage using standard keyboard shortcuts, like <b>Ctrl + T<\/b> to open a new tab.<\/p><h4>Product Information<a name=\"da6ddf82-5866-48ae-82a0-fe5761eacd5f\"><\/a><\/h4><p>For details about these and other new features, check out the MATLAB Release Notes. As of R2015b, you can quickly navigate to Release Notes and to other product-level information, like Getting Started, from any page in the documentation. Click the information icon (the \"i\") next to the product name on the left side of the page.<\/p><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/product-info.png\" alt=\"\"> <\/p><h4>Your Feedback Welcomed<a name=\"23f60e34-f4dd-45b8-a356-89e7a9ae1e44\"><\/a><\/h4><p>Reading about documentation is a very \"meta\" activity; thanks for your kind attention. If you have any general feedback on the overall documentation, we welcome it <a href=\"https:\/\/blogs.mathworks.com\/loren\/?p=1249#respond\">here<\/a>.<\/p><script language=\"JavaScript\"> <!-- \r\n    function grabCode_27b798257466412284a88456bc84b641() {\r\n        \/\/ Remember the title so we can use it in the new page\r\n        title = document.title;\r\n\r\n        \/\/ Break up these strings so that their presence\r\n        \/\/ in the Javascript doesn't mess up the search for\r\n        \/\/ the MATLAB code.\r\n        t1='27b798257466412284a88456bc84b641 ' + '##### ' + 'SOURCE BEGIN' + ' #####';\r\n        t2='##### ' + 'SOURCE END' + ' #####' + ' 27b798257466412284a88456bc84b641';\r\n    \r\n        b=document.getElementsByTagName('body')[0];\r\n        i1=b.innerHTML.indexOf(t1)+t1.length;\r\n        i2=b.innerHTML.indexOf(t2);\r\n \r\n        code_string = b.innerHTML.substring(i1, i2);\r\n        code_string = code_string.replace(\/REPLACE_WITH_DASH_DASH\/g,'--');\r\n\r\n        \/\/ Use \/x3C\/g instead of the less-than character to avoid errors \r\n        \/\/ in the XML parser.\r\n        \/\/ Use '\\x26#60;' instead of '<' so that the XML parser\r\n        \/\/ doesn't go ahead and substitute the less-than character. \r\n        code_string = code_string.replace(\/\\x3C\/g, '\\x26#60;');\r\n\r\n        copyright = 'Copyright 2015 The MathWorks, Inc.';\r\n\r\n        w = window.open();\r\n        d = w.document;\r\n        d.write('<pre>\\n');\r\n        d.write(code_string);\r\n\r\n        \/\/ Add copyright line at the bottom if specified.\r\n        if (copyright.length > 0) {\r\n            d.writeln('');\r\n            d.writeln('%%');\r\n            if (copyright.length > 0) {\r\n                d.writeln('% _' + copyright + '_');\r\n            }\r\n        }\r\n\r\n        d.write('<\/pre>\\n');\r\n\r\n        d.title = title + ' (MATLAB code)';\r\n        d.close();\r\n    }   \r\n     --> <\/script><p style=\"text-align: right; font-size: xx-small; font-weight:lighter;   font-style: italic; color: gray\"><br><a href=\"javascript:grabCode_27b798257466412284a88456bc84b641()\"><span style=\"font-size: x-small;        font-style: italic;\">Get \r\n      the MATLAB code <noscript>(requires JavaScript)<\/noscript><\/span><\/a><br><br>\r\n      Published with MATLAB&reg; R2015b<br><\/p><\/div><!--\r\n27b798257466412284a88456bc84b641 ##### SOURCE BEGIN #####\r\n%% What's Up, Doc?\r\n% Today\u00e2\u20ac\u2122s guest blogger is Leslie McBrayer, who is in the Documentation\r\n% group at MathWorks. Her team's goal is to make it easier for you to learn\r\n% how to use our products. She is writing today about some features of the\r\n% R2015b documentation: a few that are new, and a few that have been around\r\n% for some time.\r\n%\r\n%% Function and Block Pages\r\n% If you're like most folks who use our documentation, you have probably\r\n% viewed reference pages that provide detailed information about how to use\r\n% specific functions or blocks. To get a sense of what has changed for\r\n% R2015b, let's look at the page for a brand new function,\r\n% <https:\/\/www.mathworks.com\/help\/matlab\/ref\/rad2deg.html |rad2deg|>.\r\ndoc rad2deg\r\n%%\r\n% In general, the pages look very much as they did before, though we've\r\n% made some cosmetic improvements to some elements, like the search bar. In\r\n% previous releases, the search bar was lurking near the top, but was in\r\n% the middle of the page, close to similar-looking elements. Now, we hope\r\n% you don't have to think about where to find it.\r\n%%\r\n% \r\n% <<..\/search-bar.png>>\r\n% \r\n\r\n%%\r\n% Although this isn't one of our longer pages, it undoubtedly scrolls\r\n% off the bottom of your browser window. However, you can use the new \"On\r\n% This Page\" links on the left to quickly navigate to sections of the page,\r\n% like \"Examples\" or \"Input Arguments.\"\r\n%%\r\n% \r\n% <<..\/on-this-page.png>>\r\n% \r\n%% \r\n% Ideally, the examples on the page help you see how our functionality\r\n% works. Did you know that you can run example code directly from the\r\n% installed Help browser, without copying and pasting into the Command\r\n% Window? Select the code to run, right-click, and select *Evaluate\r\n% Section*. (This is one of those features that's been around a while, but\r\n% that not everyone has discovered.)\r\n%%\r\n% \r\n% <<..\/evaluate-selection.png>>\r\n% \r\n\r\n%%\r\n% Many functions and blocks, especially those recently introduced, indicate\r\n% at the bottom of their page when they made their debut. If you scroll to\r\n% the bottom of this page, you can verify that |rad2deg| is, in fact, new\r\n% for R2015b.\r\n%%\r\n% \r\n% <<..\/introduced-in.png>>\r\n% \r\n\r\n%% Archived Versions\r\n% By default, the documentation that you see in the Help browser is\r\n% installed on your machine along with the software. Naturally, the\r\n% installed content is specific to your release.\r\n% \r\n% We realize, though, that sometimes it's helpful to see documentation for\r\n% another release. We archive previous releases of the documentation on our\r\n% Web site, so you can access it there (assuming you have a MathWorks\r\n% Account and license). The help landing page is at <https:\/\/www.mathworks.com\/help\/\r\n% www.mathworks.com\/help>.\r\n% \r\n% From the landing page, you can select \"Other Releases\" from the list on\r\n% the left side of the page. Then, you can choose the release from\r\n% <https:\/\/www.mathworks.com\/help\/doc-archives.html the list>.\r\n%%\r\n% \r\n% <<..\/other-releases.png>>\r\n% \r\n%% Online Content\r\n% Of course, the online documentation isn't just for archived versions: it\r\n% is also where we maintain the most up-to-date content for our products.\r\n% You can view this content in MATLAB by setting a Help preference.\r\n% Specifically, on the *Home* tab, in the *Environment* section, click\r\n% *Preferences*. Select *MATLAB > Help*, and then set the *Documentation\r\n% Location*.\r\n%% Font Size\r\n% If the text seems too large or small, you can quickly zoom into the page\r\n% using *Ctrl + Mouse Scroll*. This setting is remembered across sessions,\r\n% and applies to all subsequent Help browser tabsREPLACE_WITH_DASH_DASHwhich, by the way, you\r\n% can now manage using standard keyboard shortcuts, like *Ctrl + T* to open\r\n% a new tab.\r\n%% Product Information\r\n% For details about these and other new features, check out the MATLAB\r\n% Release Notes. As of R2015b, you can quickly navigate to Release Notes\r\n% and to other product-level information, like Getting Started, from any\r\n% page in the documentation. Click the information icon (the \"i\") next to\r\n% the product name on the left side of the page.\r\n% \r\n% <<..\/product-info.png>>\r\n% \r\n%% Your Feedback Welcomed\r\n% Reading about documentation is a very \"meta\" activity; thanks for your\r\n% kind attention. If you have any general feedback on the overall\r\n% documentation, we welcome it\r\n% <https:\/\/blogs.mathworks.com\/loren\/?p=1249#respond here>.\r\n\r\n\r\n\r\n##### SOURCE END ##### 27b798257466412284a88456bc84b641\r\n-->","protected":false},"excerpt":{"rendered":"<div class=\"overview-image\"><img decoding=\"async\"  class=\"img-responsive\" src=\"https:\/\/blogs.mathworks.com\/images\/loren\/2015\/..\/search-bar.png\" onError=\"this.style.display ='none';\" \/><\/div><!--introduction--><p>Today&#8217;s guest blogger is Leslie McBrayer, who is in the Documentation group at MathWorks. Her team's goal is to make it easier for you to learn how to use our products. She is writing today about some features of the R2015b documentation: a few that are new, and a few that have been around for some time.... <a class=\"read-more\" href=\"https:\/\/blogs.mathworks.com\/loren\/2015\/10\/21\/whats-up-doc\/\">read more >><\/a><\/p>","protected":false},"author":39,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[6,1],"tags":[],"_links":{"self":[{"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/posts\/1249"}],"collection":[{"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/users\/39"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/comments?post=1249"}],"version-history":[{"count":2,"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/posts\/1249\/revisions"}],"predecessor-version":[{"id":1251,"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/posts\/1249\/revisions\/1251"}],"wp:attachment":[{"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/media?parent=1249"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/categories?post=1249"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/loren\/wp-json\/wp\/v2\/tags?post=1249"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}