bsoetaer / CMPUT391Project

0 stars 0 forks source link

All User Manuals #27

Open bsoetaer opened 9 years ago

bsoetaer commented 9 years ago

User Manuals are generated by editing docs/manual.texinfo. I have created major headings for all modules and filled in data for the login module.

To add text content to your page add text between the lines @node Change Personal Info @chapter Change Personal Info @ifnottex @uref{../../login/home.jsp,,Home Page} @end ifnottex

and @cindex where Change Personal Info is the page name.

To add subsections to your section add the lines @menu

where the entries are : "* Subsection Page Name:: Page Description that will show in menu"

Then create the relevant subsections by copying the @node Change Personal Info @chapter Change Personal Info @ifnottex @uref{../../login/home.jsp,,Home Page} @end ifnottex

@cindex

code and changing the names as well as changing @chapter to @section.

bsoetaer commented 9 years ago

above the "@cindex Bob" makes an index entry for Bob that will link to the node you put the cindex under. You should try to put at least one cindex index entry for each page you create.

The @ifnottex just makes it so the home page links don't show up in the pdf document. You need the menu to link the pages up correctly and if the menu does not contain all your subsections or contains subsections you have not made yet an error will occur. Need @node and @chapter/@section/@page together all the time so that it can easily be turned into both a pdf or an html file

bsoetaer commented 9 years ago

Once you have the file modified you can download the tar file from http://www.gnu.org/software/texinfo/ extract it and follow the instructions for installing it in INSTALL.generic This ends in errors on the lab computers but it still works so maybe it was installed before lol Then in the docs directory run "makeinfo --html manual.texinfo" to make the html in the user-manual directory. Run "texi2dvi --pdf manual.texinfo" to make the pdf. This creates alot of manual.something files. only the manual.pdf and manual.texinfo files are relevant in this directory so only commit those.