Print Templates. 1.0 Introduction

Transcription

1 Print Templates 1.0 Introduction Often shelters and rescues have their own forms and documents. ishelters allows you to create your own print forms to fit your requirements. Each document can be assigned one of eight categories. Those categories are: 1. Animal Profile Forms 2. Person Profile Forms 3. Adoption Forms 4. Medical Procedure Forms 5. Medical Check-Up Forms 6. Vaccination Forms 7. Donation Forms 8. Movement Forms Each print document can have a set of variables embedded in it. The system will replace the variables you have in the document with the data you have in ishelters whenever you click to merge the document. This means you no longer need to enter the data twice (i.e. into the system and then on a particular form). Plus you can design the form so that the information and fields are in the places you want. You can have as many templates in each category as you want. That means, for instance, that you can create a template for an animal s kennel card, another for a profile that you hand out to potential adopters, and so on. 2.0 Creating a Print Template To create the template itself, first open up Microsoft Word or another word processing program. Create the document you would normally use. Then replace all the variable information (such as the animal s name, age, person s address, etc). To add a variable all you need to do is type in the variable name with brackets ([]) around it. Each category has a list of possible variables. See below for a complete list of all the variable names. If the category you are creating the template for, does not have a variable you need, please let us know and we will be sure to work it in. In addition there are a set of variables called special variables that are surrounded by curly brackets ({}) with a dollar sign ($) in front of the variable name. These variables allow you to loop through sets of data (e.g. Vaccinations, Procedures, etc) instead of just one field. They also allow you to customize the date format to whichever format you'd like as well as specify yes/no type values for other fields (e.g. spayed/neutered date... yes if there is a date and no if there isn't a date). They are a bit more complicated to use than the square bracket variables but offer a lot more flexibility. We would be more than happy to add these variables for you in your print templates. For more information please see the section on Special Variables below. After you have added all the variables to the document, save the document. Be sure to save the document in RTF (Rich Text Format). Saving the document as RTF allows the word document to be read in any word processing software as well as allow ishelters to merge your data with the Word document. Now log into adminshelter. Go to the System Section. Then click on the Print Documents link. This will display a list of all the categories in the system (see above). Choose the category you are interested in. The next page will display a list of all the print document templates you have in the system. You can either update or delete a template by clicking on the corresponding button or add a new one by clicking on the add button in the top left hand corner. On the add and update forms you can click on the browse button to select your template. Then click submit to upload it to the system. Now the template is ready for you to use in ishelters.

2 3.0 Merging Print Documents On certain forms in ishelter there will be a printer icon in the top right hand corner with a link to the relevant print documents. For example, there is a link on the animal profile to all the profile documents. Clicking on this link will display all the forms you have created for the animal profile category. You can select the one you are interested in merging the animal s data with by clicking on the corresponding select button. This will prompt you to either save the document to your computer or open it up. After you either save the document or open it up right away, the system will merge the animal s data with your template. Then you can print the document or send it as an attachment to someone else. 4.0 Special Variables This section can be skipped if you are using only normal variables. Special variables are those variables that are surrounded by curly brackets instead of the normal square brackets. They also have a dollar sign ($) in front of the variable name. All normal variables can be used as special variables (i.e. surrounded by curly brackets instead of square ones with a dollar sign in front of the name). So, for instance, e.g. [dateneutered] would be {$dateneutered} as a special variable. However, certain special variables cannot become normal variables. Those variables are what are called group variables. Group variables are those variables that start with a group name in the plural followed by the group name in the singular surrounded by square brackets followed by a dot an the name of the particular variable in the group. So, for example, a group of vaccination records would look like this: {$vacs[vac].vaccine} for the vaccine name and {$vacs[vac].dategiven} for the date it was given. You can loop through these variables to display all the vaccination records. To loop through group variables requires a little more complexity. A standard loop for vaccinations would look something like this: {section name = "vac" loop = "$vacs"} Vaccine : {$vacs[vac].vaccine} Date Given : {$vacs[vac].dategiven} {/section} Basically any place you would like to display all the records from a group variable all you need to do is put a section statement with the plural and singular name of the group followed by the particular parts of the group variable that you would like to use. To close the loop all you need to add is {/section}. All special variables can be modified to send back yes/no type responses. For instance, you can check if a particular field is blank or not and then display yes or no depending on the answer. A standard yes/no type response might look like this: {if $neutereddate}yes{else}no{/if} Basically all you need to do is put an if at the beginning followed by the field you are interested in. After that you can put what word(s) you would like to see if it is not blank followed by {else} and the word(s) you would like to see if it is blank. Of course, you can use any wording you would like and not just yes or no. Special variables also allow you to format any date field just the way you would like to see it. So if you would like to see the date formated as 10/21/2007 or as 10/2007, special variables can take of it. A standard date format

3 might look like this: {$dateneutered date_format: %m/%d/%y } Basically all you need to do is put date_format: after the name of the date variable followed by the date format. To see a list of all the possible formats please see below (6.0). In short, special variables add a level of complexity but offer a lot more possibilities for your print templates. If you are interested in any of the added benefits of special variables but would prefer not to handle any of the layout, please let us know. We would be more than happy to layout your print templates using special variables for you. 5.0 Variable List Each category has its own set of possible variables. Each category and its variables are listed below with descriptions where needed. In the print template be sure to add brackets [] around each variable name. 1. Animal Profile Forms a. name b. aliases c. code d. cage e. microchipnumber f. microchip Name of the microchip brand g. primaryspecies h. primarybreed i. secondaryspecies j. secondarybreed k. birthdate l. birthyear m. birthmonth n. birthday o. age animal s age in years p. agemonths animal s age in months q. agedays animal s age in days r. timeentered s. timeenteredyear t. timeenteredmonth u. timeenteredday v. comments w. features x. primarycolor y. secondarycolor z. eyecolor aa. neutereddate bb. neuteredyear cc. neuteredmonth dd. neuteredday ee. type ff. status gg. gender hh. updatedbyfirst first name of the person who last updated the animal ii. updatedbylast last name of the person who last updated the animal

4 jj. adoptable Yes or No depending on whether the animal is ready to be adopted kk. picthumb thumbnail profile picture of the animal ll. assignedtoanimalagency the shelter/rescue that the animal is currently assigned to mm.assignedtoperson -- the person that the animal is currently assigned to nn. shortbio short biography oo. longbio long biography pp. diary diary entries qq. diaryauthorinfo diary entries with author and time updated given rr. firstcheckin date of animal s first check-in ss. firstcheckinyear tt. firstcheckinmonth uu. firstcheckinday vv. lastcheckin date of animal s most recent check-in ww.lastcheckinyear xx. lastcheckinmonth yy. lastcheckinday zz. lastcheckintype type of animal's most recent check-in aaa.weight animal s current weight bbb.location animal s current/last location ccc.sublocation animal s current/last location ddd.boardfor animal agency that you are boarding for eee. boardwith animal agency that you are boarding with Group Variables (exclusively special variables) fff. vacs[vac].vaccine vaccination names ggg.vacs[vac].dateneeded dates needed for the vaccination hhh.vacs[vac].dategiven dates given for vaccinations iii. vacs[vac].serialnumber vaccination serial number jjj. vacs[vac].vetclinic vet clinic where vaccination was given kkk.vacs[vac].comments vaccination comments lll. meds[med].medication medication name mmm.meds[med].startdate date medication was started nnn. meds[med].enddate date medication was finished ooo.meds[med].vetclinic vet clinic where medication was given ppp.meds[med].comments medication comments qqq.treats[treat].treatment treatment name rrr. treats[treat].startdate date treatment was started sss. treats[treat].enddate date treatment was finished ttt. treats[treat].vetclinic vet clinic where treatment was given uuu.treats[treat].comments treatment comments vvv. procedures[procedure].procedure procedure name www. procedures[procedure].dateneeded date needed for the procedure xxx. procedures[procedure].dategiven date given for the procedure yyy.procedures[procedure].vetclinic vet clinic where procedure was given zzz.procedures[procedure].comments comments for the procedure aaaa.tests[test].type diagnostic test name bbbb.tests[test].result result for the diagnostic test cccc.tests[test].dateneeded date needed for the diagnostic test dddd. tests[test].dategiven date given for the diagnostic test eeee. tests[test].vetclinic vet clinic where diagnostic test was given ffff. tests[test].comments diagnostic test comments

5 2. Person Profile Forms a. businessname b. firstname c. middlename d. lastname e. nickname f. birthdate g. birthyear h. birthmonth i. birthday j. homephone k. workphone l. cellphone m. address n. city o. postalcode 3. Adoption Forms a. adoptiontime date and time of adoption b. adoptiondate date of adoption c. adoptionyear d. adoptionmonth e. adoptionday f. comments g. businessname -- business name of the adopter h. firstname adopter s first name i. middlename adopter s middle name j. lastname adopter s last name k. nickname adopter s nickname l. additionalnames adopter s additional names m. address n. address2 second address line o. city p. region q. postalcode r. homephone s. workphone t. cellphone u. adopter v. fee adoption fee w. name animal s name x. aliases animal's aliases y. code animal s code z. cage aa. species animal s species bb. breed animal s breed cc. primaryspecies dd. primarybreed ee. secondaryspecies ff. secondarybreed gg. type animal's type

6 hh. primarycolor ii. secondarycolor jj. animalbirthdate animal s birthdate kk. animalbirthyear ll. animalbirthmonth mm.animalbirthday nn. age -- animal s age in years oo. agemonths animal's age in months pp. agedays animal's age in days qq. sex animal s gender rr. microchipnumber ss. weight animal s weight at the last check up tt. neutereddate uu. neuteredyear vv. neuteredmonth ww.neuteredday xx. VName01 through VName25 vaccination names yy. VNeeded01 through VNeeded25 dates needed for the vaccination zz. VGiven01 through VGiven25 dates given for vaccinations aaa.vserialnumber01 through VSerialNumber25 vaccination serial number bbb.approvedfirst first name of person who approved adoption ccc.approvedlast last name of person who approved adoption ddd.pname01 through PName25 procedure names eee.pneeded01 through PNeeded25 dates needed for the procedure fff. PGiven01 through PGiven25 dates given for the procedure ggg.mname01 through MName25 medication name hhh.mstarted01 through MStarted25 date medication was started iii. MEnded01 through MEnded25 date medication was finished jjj. DName01 through DName25 diagnostic test names kkk.dresult01 through DResult25 result for the diagnostic test lll. DNeeded01 through DNeeded25 dates needed for the diagnostic test mmm. DGiven01 through DGiven25 dates given for the diagnostic test nnn.picthumb thumbnail profile picture of the animal Group Variables (exclusively special variables) ooo.vacs[vac].vaccine vaccination names ppp.vacs[vac].dateneeded dates needed for the vaccination qqq.vacs[vac].dategiven dates given for vaccinations rrr. vacs[vac].serialnumber vaccination serial number sss.vacs[vac].vetclinic vet clinic where vaccination was given ttt. vacs[vac].comments vaccination comments uuu.meds[med].medication medication name vvv.meds[med].startdate date medication was started www. meds[med].enddate date medication was finished xxx.meds[med].vetclinic vet clinic where medication was given yyy.meds[med].comments medication comments zzz.treats[treat].treatment treatment name aaaa.treats[treat].startdate date treatment was started bbbb. treats[treat].enddate date treatment was finished cccc.treats[treat].vetclinic vet clinic where treatment was given dddd.treats[treat].comments treatment comments

7 eeee. procedures[procedure].procedure procedure name ffff. procedures[procedure].dateneeded date needed for the procedure gggg. procedures[procedure].dategiven date given for the procedure hhhh.treats[treat].vetclinic vet clinic where procedure was given iiii. procedures[procedure].comments comments for the procedure jjjj. tests[test].type diagnostic test name kkkk.tests[test].result result for the diagnostic test llll. tests[test].dateneeded date needed for the diagnostic test mmmm. tests[test].dategiven date given for the diagnostic test nnnn. tests[test].vetclinic vet clinic where diagnostic test was given oooo. tests[test].comments diagnostic test comments 4. Medical Procedure Forms a. name animal s name b. code animal s code c. dategiven d. givenyear e. givenmonth f. givenday g. dateneeded h. neededyear i. neededmonth j. neededday k. datepaid l. paidyear m. paidmonth n. paidday o. fee p. comments q. procedure 5. Medical Check-Up Forms a. name animal s name b. code animal s code c. dateexamed d. examedyear e. examedmonth f. examedday g. dateneeded h. neededyear i. neededmonth j. neededday k. datepaid l. paidyear m. paidmonth n. paidday o. fee p. comments q. temp r. weight s. height

8 6. Vaccination Forms a. name animal s name b. code animal s code c. dategiven d. givenyear e. givenmonth f. givenday g. dateneeded h. neededyear i. neededmonth j. neededday k. datepaid l. paidyear m. paidmonth n. paidday o. fee p. comments q. serialnumber r. vaccine 7. Donation Forms a. firstname b. middlename c. lastname d. nickname e. birthdate f. birthyear g. birthmonth h. birthday i. homephone j. workphone k. cellphone l. address m. address2 second address line n. city o. postalcode p. additionalnames donor s additional names q. donationtype type of donation r. timedonated date and time of donation s. datedonated date of donation t. donatedyear u. donatedmonth v. donatedday w. amount amount donated 8. Movement Forms a. BusinessName -- Business name of person who is currently with the animal b. firstname First name of person who is currently with the animal c. middlename d. lastname e. nickname

9 6.0 Date Formating f. personbirthdate g. personbirthyear h. personbirthmonth i. personbirthday j. homephone k. workphone l. cellphone m. address n. address2 second address line o. city p. region q. postalcode r. additionalnames additional names s. name t. code u. species primary species v. breed primary breed w. animalbirthdate x. animalbirthyear y. animalbirthmonth z. animalbirthday aa. animalage animal s age in years bb. animalagemonths animal s age in months cc. animalagedays animal s age in days dd. gender animal s gender ee. microchipnumber ff. movementdate gg. movementyear hh. movementmonth ii. movementday jj. location kk. sublocation ll. comments mm.picthumb animal s thumbnail picture If you are using special variables you can format date variables using the following format symbols: %a - abbreviated weekday name according to the current locale %A - full weekday name according to the current locale %b - abbreviated month name according to the current locale %B - full month name according to the current locale %c - preferred date and time representation for the current locale %C - century number (the year divided by 100 and truncated to an integer, range 00 to 99) %d - day of the month as a decimal number (range 01 to 31)

10 %D - same as %m/%d/%y %e - day of the month as a decimal number, a single digit is preceded by a space (range 1 to 31) %g - Week-based year within century [00,99] %G - Week-based year, including the century [0000,9999] %h - same as %b %H - hour as a decimal number using a 24-hour clock (range 00 to 23) %I - hour as a decimal number using a 12-hour clock (range 01 to 12) %j - day of the year as a decimal number (range 001 to 366) %k - Hour (24-hour clock) single digits are preceded by a blank. (range 0 to 23) %l - hour as a decimal number using a 12-hour clock, single digits preceeded by a space (range 1 to 12) %m - month as a decimal number (range 01 to 12) %M - minute as a decimal number %n - newline character %p - either `am' or `pm' according to the given time value, or the corresponding strings for the current locale %r - time in a.m. and p.m. notation %R - time in 24 hour notation %S - second as a decimal number %t - tab character %T - current time, equal to %H:%M:%S %u - weekday as a decimal number [1,7], with 1 representing Monday %U - week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week %V - The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week. %w - day of the week as a decimal, Sunday being 0 %W - week number of the current year as a decimal number, starting with the first Monday as the first day of the first week

11 %x - preferred date representation for the current locale without the time %X - preferred time representation for the current locale without the date %y - year as a decimal number without a century (range 00 to 99) %Y - year as a decimal number including the century %Z - time zone or name or abbreviation %% - a literal `%' character