question archive Part III: Documentation/Help (8 marks) In this exercise you'll create help for 2 functions
Subject:Computer SciencePrice: Bought3
Part III: Documentation/Help (8 marks) In this exercise you'll create help for 2 functions. The 1st function is simpler and will need less detail than the 2nd. The 2nd function will also require a working online help link but the online help only has to exist and contain a simpler explanation. 1. nd test help documentation for one of the above filter functions that you wrote. (3 marks) If you want to attempt this earlier use one of the following from AllFunctions: nl, head, grep-field, myFunction2, myFunction3, myFunction4, MandatoryDemo, demo-switch, PipelineDemo. Give a Synopis, a longer description of what the function does, 1 or 2 examples (NOT the example given in the PowerPoint presentation or in in class). Include an INPUTS section describing the pipeline input (you can say none if it's a provider) and an OUTPUTS section describing what is output and cover any parameters. (If there are no parameters you should document that as well). Put your name and student# in the Notes section. If you wrote the function include yourself as the author. Test the following help switches: -examples -ShowWindow. Report on the status of your tests and submit the marked up code but not the output. 2. Create and test full documentation for one of the functions in Part II that you wrote in part 2 or a function of similar complexity from AllFunctions that is not currently documented: changefiledate, FrequencyCounterV2, FrequencyCounterV2, myFunction5, CreatePlayer, Create-Person, CombineFields (5 marks) The documentation requirements for #1 apply. a. Test the following switches: -parameters -detailed -online. Report on the status of your tests and submit the marked up code but not the output. (3) b. Link your function to an online help page situated in your public_html directory on munro. The web page does not have to be complicated or cover the help topics. Simply create a web page with a heading "This is help for...." and a short paragraph describing what it does and a sub section using a smaller heading for one of your other sections. (2 marks) i. A reminder that web pages have their permissions set to be readable by others and when you refer to them you leave out the directory public_html ii. To create the sub section I'd suggest redirecting the output of get-help to a file, cut and paste the section into your web page and then add the HTML markup. Or you could just type something in.