Skip to content

Commit

Permalink
Merge pull request #162 from sharan8/exportcert-userguide
Browse files Browse the repository at this point in the history
Update `exportcert` feature details in UserGuide.adoc and README.adoc
  • Loading branch information
afiqlattif committed Oct 30, 2018
2 parents 1106ccb + 7a8e4cc commit 647d5ec
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 17 deletions.
8 changes: 4 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ image::images/Ui.png[width="600"]
endif::[]

* SocialCare is a social welfare event and volunteer management system. It is a desktop application and has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC) than what students usually write in beginner-level SE modules.
* This application is intended for social welfare organisations that want to better manage their volunteers & events, and gain further statistical insights from the data.
* SocialCare allow users to:
* It is *written in OOP fashion*, and is morphed from the https://se-edu.github.io/docs/Team.html[se-edu] team's https://github.com/nus-cs2103-AY1819S1/addressbook-level4[Address Book - Level 4], which provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC) than what students usually write in beginner-level SE modules.
* This application is intended for social welfare organisations that want to better manage their volunteers & events, and export volunteer certificates.
* SocialCare allows users to:
** Manage contacts and events faster than a typical mouse/GUI driven app.
** Use tags to categorize events and volunteers.
** Manage additional volunteer data, such as number of service hours per volunteer.
** View volunteer and event statistics and derive insights from them.
** Export volunteer certificates detailing each volunteer's involvement in the organisation's events.
== Site Map
Expand Down
6 changes: 3 additions & 3 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -486,11 +486,11 @@ The `exportcert` command enables the volunteer manager to export a PDF document
* List of events involved in
* Hours of service contributed

This is a sample of the exported PDF certificate:
This is what the exported PDF certificate currently looks like:

.Sample exported volunteer certificate
.Current form of exported volunteer certificate
[.thumb]
image::VolunteerCert.png[width="600"]
image::CurrentVolunteerCert.png[width="600"]


===== Intended Implementation
Expand Down
28 changes: 18 additions & 10 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -356,30 +356,38 @@ image::command_volunteer_delete_after.png[After delete, 300]


[[command-volunteer-exportcert]]
==== Exporting volunteer certificate : `exportcert [coming in v1.3]`
==== Exporting volunteer certificate : `exportcert`

Exports a PDF document to the user's Desktop, detailing the volunteer's involvement with the organisation. This document includes:
Exports a PDF document to a folder in the user's current working directory or directly to the desktop, detailing the volunteer's involvement with the organisation. This document includes:

* Volunteer Name & NRIC
* List of events involved in
* Hours of service contributed
* Organisation's logo
* Title: 'Certificate of Recognition'
* Date of export
* Volunteer name
* Volunteer ID
* List of events involved in - Event name, hours contributed, event start and end dates

Format: `exportcert VOLUNTEER_INDEX`

* Exports PDF certificate for the volunteer at specified `VOLUNTEER INDEX`
* `VOLUNTEER INDEX` **must be a positive integer** 1, 2, 3, ...
* If the index given exceeds the number of volunteers in the displayed volunteer list, the message 'The volunteer index provided is invalid.' will be shown.

Example(s):

* `exportcert 2` +
Exports PDF certificate of volunteer at specified index 2 to local folder 'certs'
Exports PDF certificate of volunteer at specified index 2 to folder 'Volunteer Certs' in the current working directory, or directly to the Desktop.

Here is a sample exported certificate:
Here is what the exported certificate currently looks like:

.Sample exported volunteer certificate
.Current sample exported volunteer certificate
[.thumb]
image::VolunteerCert.png[width="600"]
image::CurrentVolunteerCert.png[width="600"]

Here is the intended final form of the exported certificate:

.Intended sample exported volunteer certificate
[.thumb]
image::FinalVolunteerCert.png[width="600"]

=== Event Management

Expand Down
Binary file added docs/images/CurrentVolunteerCert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/FinalVolunteerCert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/VolunteerCert.png
Binary file not shown.

0 comments on commit 647d5ec

Please sign in to comment.