CSE-1402 Practical Session #7 - A Software Product User Manual in
Contents
1. CSE 1402 Practical Session 7 A Software Product User Manual in BTRX Computer Science amp Software Engineering Monash University Clayton 3800 Australia Abstract Prac Session Objectives The student will further consolidate experience gained with using a BTEX template learn several new commands and will produce a user manual for a software tool developed for viewing ATEX format files 1 Reading Material No Marks If you did not do so for the previous three pracs download a copy of Tobias Oetiker s excellent EXTRX tutorial which is posted at http www tug org begin html tutorials Please revise Chapter 1 through to Chapter 2 as you will find this useful for this practical session and also helpful for coming lectures Please read through the skeleton file template tex and look up the TfX markup commands used in this file within the ATX tutorial document and your lecture notes especially list environments 2 Preparation Tasks 1 Mark This practical session will involve further use of 4 TX but also incorporates some further practice in the use of vi and RCS Assume the software tool you wrote a specification for last week has been altered to view BTFX instead You will now prepare a user manual for TFX format file viewer Assume the tool has all of the relevant features which you defined in the specification you prepared in the preceding Prac This practical session demonstrates the importance of carefully writing specificat2. are encouraged to attempt a compile under WinShell 3 Lab Work Tasks 1 The Lab Work Tasks for Prac 7 will rely on the practice and notes you produce working through the Preparation Tasks Therefore the more effort you put into the preparation the better the grade you can produce in the Lab Work Tasks 2 Details of the Lab Work Tasks will be made available before the Prac in electronic form 3 Please show your tutor the work you did to complete the Preparation Tasks
3. ions in practice you will need to use them in the production of other documents A feature you will incorporate into the viewer is the ability to view the formatted compiled ATEX as well as the TRX source The viewer should include the ability to highlight ATX commands in different colours The viewer will support the following highlight colours e All generalised markup commands in shades of red e All layout markup commands in shades of green e All font change markup commands in shades of light green e All document content in black e Background in white 3 LAB WORK TASKS 2 e All begin and end statements in yellow You can assume the readers of the manual are novices and may not understand what TeX format files are used for and do not understand ETRX syntax This needs to be explained briefly Make sure that the descriptions are simple and concise and do not confuse the reader assume the reader is a Year 11 student 1 Using gvim or vi produce a 1 400 word user manual for a viewer which can display XTX format files 2 The body of the manual will describe the operating modes and features of the viewing tool The skeleton file for this document does not reflect the required structure of the document but contains some hints 3 This document will be the basis of your assessed work in the Lab Work therefore it is essential that you do this work thoroughly 4 Students with TFX installed on their home systems
Download Pdf Manuals
Related Search