{"id":6703,"date":"2016-04-01T09:04:58","date_gmt":"2016-04-01T13:04:58","guid":{"rendered":"https:\/\/blogs.mathworks.com\/pick\/?p=6703"},"modified":"2022-05-28T16:34:44","modified_gmt":"2022-05-28T20:34:44","slug":"matlab-documentation-for-bros","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/pick\/2016\/04\/01\/matlab-documentation-for-bros\/","title":{"rendered":"MATLAB Documentation for Bros"},"content":{"rendered":"<div xmlns:mwsh=\"https:\/\/www.mathworks.com\/namespace\/mcode\/v1\/syntaxhighlight.dtd\" class=\"content\">\r\n   <introduction>\r\n      <p><a href=\"https:\/\/www.mathworks.com\/matlabcentral\/profile\/authors\/3208495\">Sean<\/a>'s pick this week is the <a href=\"https:\/\/www.mathworks.com\/matlabcentral\/fileexchange\/56222-brocumentation-toolbrox\">Brocumentation Toolbox<\/a> by <a href=\"https:\/\/www.mathworks.com\/matlabcentral\/profile\/authors\/3261410\">Dan Seal<\/a>.\r\n      <\/p>\r\n      <p>Most <a href=\"https:\/\/en.wikipedia.org\/wiki\/Bro_(subculture)\">bros<\/a> don&#8217;t know too much about MATLAB since they&#8217;re usually busy working out, surfing, or just plain chillaxing with other bros.\r\n         But MathWorks is looking for ways to reach out to new groups of users, and we feel that bros need some love too. That&#8217;s why\r\n         our product team has just released the Brocumentation Toolbrox, and we&#8217;re highlighting it as this week&#8217;s pick.\r\n      <\/p>\r\n   <\/introduction>\r\n\r\n   <h3>Background<a name=\"1\"><\/a><\/h3>\r\n   <p>We know that technical engineering terms like &#8220;plot&#8221; and &#8220;function&#8221; can be too complex for many bros to understand, causing\r\n      their eyes to glaze over as they daydream about the upcoming intramural lacrosse championships. So we&#8217;ve created a simplified\r\n      version of the documentation that contains a vocabulary (or &#8220;brocabulary&#8221;) that bros are more comfortable with. Based on a\r\n      careful analysis of bro diction, this toolbrox offers help text on a brolific range of bro topics including broptimizaiton,\r\n      brobotics, and simbrolation. It&#8217;s also filled with many detailed exambroles.\r\n   <\/p>\r\n  \r\n<h3>Sample Usage<a name=\"3\"><\/a><\/h3>\r\n   <p>For an example of how the Brocumentation Toolbrox improves the clarity of the MATLAB help, let&#8217;s look at the function &#8220;fminsearch.&#8221;\r\n      The original help text contains this elaborate definition for the three-input syntax:\r\n   <\/p><pre style=\"background: #F9F7F3; padding: 10px; border: 1px solid rgb(200,200,200)\">help <span style=\"color: #A020F0\">fminsearch<\/span><\/pre><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/pick\/files\/brocumentation_fminsearch.png\"> <\/p>\r\n   <p>But with the Brocumentation Toolbrox, bros get this simplified description:<\/p><pre style=\"background: #F9F7F3; padding: 10px; border: 1px solid rgb(200,200,200)\">bro <span style=\"color: #A020F0\">fminsearch<\/span><\/pre><p><img decoding=\"async\" vspace=\"5\" hspace=\"5\" src=\"https:\/\/blogs.mathworks.com\/pick\/files\/brocumentation_brofminsearch.png\"> <\/p>\r\n   <h3>Comments<a name=\"5\"><\/a><\/h3>\r\n   <p>Give it a try and let us know what you think <a href=\"https:\/\/blogs.mathworks.com\/pick\/?p=6703#respond\">here<\/a> or leave a <a href=\"https:\/\/www.mathworks.com\/matlabcentral\/fileexchange\/56222-brocumentation-toolbrox#comments\">comment<\/a> for Dan.\r\n   <\/p><script language=\"JavaScript\">\r\n<!--\r\n\r\n    function grabCode_b00598a9a69749ff9c93fa21547dd715() {\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='b00598a9a69749ff9c93fa21547dd715 ' + '##### ' + 'SOURCE BEGIN' + ' #####';\r\n        t2='##### ' + 'SOURCE END' + ' #####' + ' b00598a9a69749ff9c93fa21547dd715';\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        author = 'Sean de Wolski';\r\n        copyright = 'Copyright 2016 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 author and copyright lines at the bottom if specified.\r\n        if ((author.length > 0) || (copyright.length > 0)) {\r\n            d.writeln('');\r\n            d.writeln('%%');\r\n            if (author.length > 0) {\r\n                d.writeln('% _' + author + '_');\r\n            }\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      \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_b00598a9a69749ff9c93fa21547dd715()\"><span style=\"font-size: x-small;        font-style: italic;\">Get \r\n            the MATLAB code \r\n            <noscript>(requires JavaScript)<\/noscript><\/span><\/a><br><br>\r\n      Published with MATLAB&reg; R2016a<br><\/p>\r\n<\/div>\r\n<!--\r\nb00598a9a69749ff9c93fa21547dd715 ##### SOURCE BEGIN #####\r\n%% MATLAB Documentation for Bros\r\n%\r\n% <https:\/\/www.mathworks.com\/matlabcentral\/profile\/authors\/3208495 Sean>'s\r\n% pick this week is the \r\n% <https:\/\/www.mathworks.com\/matlabcentral\/fileexchange\/56222-brocumentation-toolbrox Brocumentation Toolbox> by\r\n% <https:\/\/www.mathworks.com\/matlabcentral\/profile\/authors\/3261410 Dan Seal>.\r\n%\r\n% Most <https:\/\/en.wikipedia.org\/wiki\/Bro_(subculture) bros> don\u00e2\u20ac&#x2122;t know too\r\n% much about MATLAB since they\u00e2\u20ac&#x2122;re usually busy working out, surfing, or\r\n% just plain chillaxing with other bros. But MathWorks is looking for ways\r\n% to reach out to new groups of users, and we feel that bros need some love\r\n% too. That\u00e2\u20ac&#x2122;s why our product team has just released the Brocumentation\r\n% Toolbrox, and we\u00e2\u20ac&#x2122;re highlighting it as this week\u00e2\u20ac&#x2122;s pick.\r\n%  \r\n%% Background\r\n% We know that technical engineering terms like \u00e2\u20ac\u0153plot\u00e2\u20ac\ufffd and \u00e2\u20ac\u0153function\u00e2\u20ac\ufffd can\r\n% be too complex for many bros to understand, causing their eyes to glaze\r\n% over as they daydream about the upcoming intramural lacrosse\r\n% championships. So we\u00e2\u20ac&#x2122;ve created a simplified version of the documentation\r\n% that contains a vocabulary (or \u00e2\u20ac\u0153brocabulary\u00e2\u20ac\ufffd) that bros are more\r\n% comfortable with. Based on a careful analysis of bro diction, this\r\n% toolbrox offers help text on a brolific range of bro topics including\r\n% broptimizaiton, brobotics, and simbrolation. It\u00e2\u20ac&#x2122;s also filled with many\r\n% detailed exambroles.\r\n%  \r\n%% Product Video\r\n% Check out this product video, then go download the\r\n% <https:\/\/www.mathworks.com\/matlabcentral\/fileexchange\/56222-brocumentation-toolbrox toolbrox> and\r\n% try it for yourself.\r\n\r\n\r\n% <embedded YouTube video>\r\n\r\n%% Sample Usage\r\n% For an example of how the Brocumentation Toolbrox improves the clarity of\r\n% the MATLAB help, let\u00e2\u20ac&#x2122;s look at the function \u00e2\u20ac\u0153fminsearch.\u00e2\u20ac\ufffd The original\r\n% help text contains this elaborate definition for the three-input syntax:\r\n% \r\n%   help fminsearch\r\n%\r\n% <<fminsearch.png>>\r\n \r\n%%\r\n% But with the Brocumentation Toolbrox, bros get this simplified\r\n% description:\r\n%\r\n%   bro fminsearch\r\n%\r\n% <<brofminsearch.png>>\r\n\r\n%% Comments\r\n% \r\n% Give it a try and let us know what you think\r\n% <https:\/\/blogs.mathworks.com\/pick\/?p=6703#respond here> or leave a\r\n% <https:\/\/www.mathworks.com\/matlabcentral\/fileexchange\/56222-brocumentation-toolbrox#comments\r\n% comment> for Dan.\r\n%\r\n \r\n\r\n##### SOURCE END ##### b00598a9a69749ff9c93fa21547dd715\r\n-->","protected":false},"excerpt":{"rendered":"<div class=\"overview-image\"><img decoding=\"async\"  class=\"img-responsive\" src=\"https:\/\/blogs.mathworks.com\/pick\/files\/brocumentation_fminsearch.png\" onError=\"this.style.display ='none';\" \/><\/div><p>\r\n   \r\n      Sean's pick this week is the Brocumentation Toolbox by Dan Seal.\r\n      \r\n      Most bros don&#8217;t know too much about MATLAB since they&#8217;re usually busy working out, surfing, or... <a class=\"read-more\" href=\"https:\/\/blogs.mathworks.com\/pick\/2016\/04\/01\/matlab-documentation-for-bros\/\">read more >><\/a><\/p>","protected":false},"author":87,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[16],"tags":[],"_links":{"self":[{"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/posts\/6703"}],"collection":[{"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/users\/87"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/comments?post=6703"}],"version-history":[{"count":10,"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/posts\/6703\/revisions"}],"predecessor-version":[{"id":15959,"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/posts\/6703\/revisions\/15959"}],"wp:attachment":[{"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/media?parent=6703"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/categories?post=6703"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/pick\/wp-json\/wp\/v2\/tags?post=6703"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}