Home

Manual

1.
2. If your site admin only provided you with FTP access you may have to do the last step manually Also depending on the server account setup you now may need to invoke the import php script on the phpDiveLog website to get your data to the web dirs ask your site admin whether you have to do so or not 15 If you re organized some dive data especially renumbering the dives and or sites you may need to clean the images directory which contains the dive profile images before you run the conduit script to make sure they are re created with the correct names Of course in this case you will also have to check your photos and text files and rename them accordingly see AdditionalInfo for details on those files Placing additional Information You may include additional information like pictures or external plain text files into your dive site and personal information which can be done in two different ways e placing files with specific names in the right locations e using special macros in your ADL dive site notes Dive and Site photos You can advise phpDiveLog to automatically display fotos connected to your dives and or divesites PDL searches two special directories for these images the diver lt nickname gt fotos dive directory for pictures related to dives and diver lt nickname gt fotos site for divesite related images It recognizes the Jpg Gif and Png image types as valid Descriptions are to be placed in txt
3. Izzy Soft proudly presents the Application Manual Table of Contents Administration MANUAL ss icccccieccecciissecetiscebsliacetetaveovsasecevelelesentecesdbetetetieeTecvecedecvueteassuetesscucccessuecessevucsecesececssvecs 1 EOKA ELATI PAEA vitesse vdec a O OCN coc NESS 1 Requirements e ne Aid ees 1 Sta AA E AAA SNA A A a lit 1 Help Calentar ls td 2 Und ie ositos AEA EO delete sia 2 CONT SUTA A O OS 2 How to best configure phpDiveLog eeeecccesscesssecseceeeeeeceeeeaeeeeaaecseaecseaeeceaeecsaeeeeaueceaaeceeaeeeneees 2 SEIN GS SX PLAINS irena ae o dee da sci ddua sia dese a e vedascbecdededasteenta ov A a Aaa a 3 DINA AC COUMES 5535s A A ei Ri EEE BOONE BRI 8 Directory SUCESO A e o a EE ET EAN ERAS 8 SEUA Newdive kneri e o E ee E EE 8 Directory Permission S earen ee oe e E E EEEE E EEEE E EEE E N eke 8 Multi UW Ser ERI E E E ET EE E E T ET EE EE E 9 Configura is 9 Data Trastero 9 Customization Maniial acc A en NA R 10 LOCA ais AEA 10 The Translation EM td A a ove cage asada eee 10 Editing Translations tc ita a ea Ei eves a E A E A E lis 10 Adding a New Language must pir papilas 10 TEMAS A a 11 Diver Main all vissseucisaisseisaicsteasicetitssases tices cudasascscasasvsceesavetesigescclavescvedesooveieseveteiaovetssesaseusesdscsdasevccdaesevscetessoeesseove 12 Chen Side Installation A eka LEE eC ae 12 Install the Conduities A EE RRR REE EE EES 12 CONT SUT O auc cece lets Cece ede NON 12 Condit Conf UTA in A A TENE EE EE AE
4. In the early years IzzySoft mainly served web development and configuration installation issues for computers and small networks The focus changed in 2002 2003 when the last normal employment ended and the founder decided to start freelancing for 100 Since then IzzySoft concentrates on Oracle support This includes the service on site installation configuration tuning etc as well as some pieces of software provided to the public under GPL like this project you are watching right now More information e IzzySoft Homepage e IzzySoft Oracle stuff e IzzySoft Software page e IzzySoft deb rpm repositories phpDiveLog What is phpDiveLog phpDiveLog displays the information of your Palms AguaDiveLog logbook based on CSV files you generate with the Java Conduit shipped with AquaDiveLog Providing some magics it allows you to combine these data with additional information such as pictures or other external data sources As for now phpDiveLog offers you no features to edit these data But it provides you with facilities to display e the Dive Logbook Here you browse through the list of your dives in the config file you may specify how many entries should be displayed per page For detailed information a click on the dive brings you directly to the log books entry e the Dive Statistics which show you some basic stats about your dives such as max avg depth and divetime etc e the Dive Sites Information
5. for is missing completely While this may sound hard it is not difficult to solve The Translation System Translations are read from plain text files in CSV format which you find in the lang directory of your PDL installation To also serve incomplete missing translations phpdiveLog always falls back to English if it cannot find a term Which means two things e the English translation file must be the most complete one e if a term in your language is the same as it is in English it can be omitted in your translation file Editing Translations If your language is completely missing you best start with a copy of the lang trans en file As you may already have noticed the file extension represents the ISO language code so name the copy appropriately For example if you want to start on an Italian translation file name it trans it Remove all translations which will be equivalent to the English ones and replace the remaining translations with the Italian ones If your language is already presented by an incomplete translation file simply copy the missing lines from the English file new terms are usually simply added to the end so it should not be that hard to tell and continue as in above example Important Never ever remove the first line which specifies the column names or your translations won t work The same applies to the values of the first column since this is how phpDiveLog identifies the terms Adding a new
6. A A AANE A AE di Administration Manual This part of the documentation is dedicated to the site administrator and deals with things to be done on the server The following issues will be covered e Installation How to install phpDiveLog e Configuration Configuration Issues e Setting up a diver How to setup a diver e Directories Directories and their permissions e MultiUser Multi User Issues More issues for the site admin you will find in the CustomizationManual Installation Requirements There are a few dependencies to consider in order to use phpDiveLog e a Web server supporting PHP tested only with Apache e PHP5 recommended PHP 5 2 as loadable module for Apache which again is the only tested variant e optional for PDE support with PDL v0 3 5 TCPDF PHP PDE Api e optional for language negotiated help pages php5 curl Most if not all Linux distribution ship the requirements along with their package manager so it should be easy to install On Windows it might be a bit more tricky To test whether you meet these requirements simply create a test PHP file containing a single line lt php phpinfo gt put it into your document root and call it with your browser The resulting page will list your PHP configuration and tell you about available capabilities Concerning the optional TCPDF you can grab the full distribution from their site for manual installation which will be the onl
7. files having the same name as the image they describe see examples in the diver demo fotos directory The naming conventions are taken from the ADL specifications all dive images have the name diveXXXXx YYY while the site images are to be named sit eXXXX YYY txt where the XXXXX stand for the 5 digit dive site number zero padded from the left e g 00025 for dive site number 25 and YYY for a 3 digit consecutive number of all images for the related dive site With the first phpDiveLog is able to connect the images with the according data records using the latter you can define the order the images are displayed Things to consider e recommended size for these thumbnails is 192x144 pixel e make the file extensions lower case i e j pglpnelgifltxt e when re numbering your dives your fotos need to be renumbered accordingly e if you want PDL to link the thumbnail to the original larger image give the latter the same file name and place it into the large subdirectory of the directory the thumbnail was placed into Additional descriptions for your Dives and Sites The external notes feature is mainly intended to save you from editing larger stuff on your PDA so you store only the core information in ADL but expatiate upon them here especially as the fields in the PDA are rather limited in size as well To create an external notes field simply place a plain text file named diveXXXXX txt for dive notes or
8. for the web server Multi User Issues Hosting more than one divers data rises some security related questions Probably not all of them shall have write access to your web servers directories Moreover you might think about adjusting some configuration parameters Configuration With only one diver you probably will set the default_page user and Sdefault_user lt your_nick_here gt so every visitor comes directly to your log even without parameters in the URL string With multiple users this may be different Possible variants include e leave it the same since you are the most important user e change the default page Sdefault_page index so visitors coming without URL parameters will see a list of public nicks e change the default page Sdefault_page error to hide all of the divers and only grant access to those who know the right parameters The most likely solution will be one of the first two I guess Data Transfer Here we can again think of multiple solutions e all users have direct access to their directories either 4 they have access to the full web tree 4 you set up FTP users for each and chrooted them to their directories e all users have access to their own FTP account elsewhere on the server e all users have access to a common single OS FTP account The first case is easy Everybody simply transfers the data directly to the divers directory No additional actions required The other
9. plain text html files stored on the machine serving your PDL files Embedded links are enclosed by the url and ur1 tags Embedded images are enclosed by the img and img left aligned or imgr and imgr right aligned tags External text html files can be included by using the file and file tags nesting of tags i e using the tags in a file included by the file tag and using images as anchors for URLs is possible Everything from the opening to the closing tag including the tags themselves has to be on the same line i e the string must NOT contain any line breaks The syntax of the part between the tags is as follows where square brackets mark optional and angle brackets mandatory parts ALAS RSU LOS 008 Le 4740913 Part between the opening and closing Tag ename gt Bledda8 2 A tDir prot L E filename gt description Website url A special case is the rootDir specification which has the syntax dir lt buddy gt and dirisa single letter representing ed fotos dive es fotos site ep fotos person et diver lt buddy gt text 17 So giving a more complex example at the end ur1 http some divesites homepage img s demo site01234 001 jpg Great Site img ur1 should result in the given picture linked to the given url and with the given text attached PDF Export Issues Since with long descriptions not all of your texts
10. see below 2300 this site well up to some degree and chose the language you prefer the information in HED ED THiS brings you to a form which lets you export all your dives sites and stats to PDF for 19 Global Mode If the admin of this site decided to enable the global mode you can switch here by clicking on the first single icon in the navigation bar see above Then the navigation bar will contain the following items Description lies Tod Hy pens a list of all divers registered with this site who decided to open their dive logbooks Your site preferences as described above Context Navigation On the details pages for dives and sites you find the Context Navigation Bar once below the main navigation and a second time at the end of the page Here you not only have the possibility to switch to the previous next record but depending on available data and on configuration settings one or more of the following icons offer you context related links e If PDE Support is available and enabled by the admin you will find a PDE icon in the context navigation bar This can be used to generate and download this dives sites information in PDF format e If the dive record contains a buddy the buddy icon brings you to a list of dives with this buddy e In case a location is part of the data on that page two icons bring you to a list of sites resp dives at that location e Similarly the place icon br
11. siteXXXXX txt for site notes in the notes subdirectory of your diver home directory replacing the XXXXX by the ID of the dive site filled up with zeros from the left to 5 digits e g a note for dive 57 would be dive00057 txt This file may contain HTML formatings e g for lt B gt old or lt U gt nderlining as well as all available tags see below All double newlines will be replaced by line breaks lt BR gt to form paragraphs Make sure that all text files are using the UTF 8 character set For Windows e g the standard editor notepad can save files in UTF 8 if you select Save as and then in the dialog you find some encodings box where you can select UTF 8 With nix if your editor does not support this you can use the recode command for this task for details see the man page with man recode 16 If you like to create localized versions of your notes you can do so for all languages that are directly supported by phpDiveLog see the Setup page For these name the files as described above plus add the language code to the end of the filename so it would be txt de for a German or txt ru fora Russian text In these cases you should ensure that the default file without the language code also exists since the localized versions would only be displayed if the visitor has the given language selected on the Setup page To ensure this you can make use of symbolic links If you e g have a German and an
12. two options require some special action Either all their home directories are located directly in the same base directory i e the Stransfer_dir defined in the inc config inc see wiki AdminManual Configuration Configuration or you achieve this using symlinks After the users uploaded their data they need to call the import php with their nicks used where they need to enter the corresponding password to run the import So if the import module is to be used passwords need to be setup in the pwdfile you specified in the config inc file A sample password file is provided as install etc pdlpwad so you can see its structure For each user requiring a password just add the appropriate line where the pwd is a md5 hash of the real password This md5 hash can me calculated using the md5 executable on Linux Unix machines or using the PHP md5 command in a simple script like echo md5 plain_text_password Customization Manual Like the AdminManual this again addresses the site admin It shows how to customize phpDiveLog beyond the configuration file and covers the following areas e Localization Let phpDiveLog speak your language e Templates Affect the general Look and Feel Localization phpDiveLog already ships with translations for several languages but except for German and English which are maintained by the developer himself they may either be not up to date or the language you are looking
13. we start here The conduit is installed and you have the phpDiveLog sources unpacked on your disk All you need from the latter is the content of the insta11 adl directory e copy the contents of the install adl template dir to ADLs template dir e copy the contents of the install ad1 dir to ADLs directory Configuration Conduit Configuration Consult the documentation of ADL concerning the basic configuration of the divelog ini file For phpDiveLog we only assume you changed the following parameters here e TablePDBFile points to your AquaPalm TableDB pdb file e DivePDBFile points to your AquaPalm DiveDB pdb file For the other parameters please refer to the conduits documentation Wrapper Configuration To convert and optionally transfer the data from ADL phpDiveLog provides the divelog_conduit sh file which is configured with the file named config residing in the same directory These files are intended to be used with the Bash shell available on Linux Unix machines and also with Cygwin on Windows hosts Since phpDiveLog exists there has never been a request for a Windows script so if you need it you may want to open a feature request ticket and be willing to test the result since I don t have Windows running and thus cannot test As usual with Shell scripts the configuration parameters follow the syntax name value and please take care to not introduce any spaces directly nex
14. your convenience Most of them will be quite clear like the or lt operators when working with numbers You may always specify complete or incomplete values depending on the desired results Keep in mind that with an incomplete value and the operator your result set will certainly be empty With the LIKE operator you will certainly use an incomplete value however you must not use any wildcards anywhere also not the percent sign with the LIKE operator since they will not be recognized as such but interpreted literally Preferences On the preferences page you may set up how PDL will present you the data This setup includes the selection of a template set Skin and your favorite language The latter one is used for the item names the divers information will not be translated Except if s he provided special information for the selected language which is possible for the dive and dive site notes 24 Appendix This is the Appendix to the manual containing additional information not fitting into one of the other sections The following topics are covered here e IzzySoft who stands behind the application e phpDiveLog Short information about the application e DynamicGraphs the feature of dynamically created graphs e Emoticons using emoticons smileys and the like IzzySoft IzzySoft was founded in 1995 as a sideline to the owners study of computer sience and of course to fund it somehow
15. EAEan 12 Wrapper Config urati oa 12 Site Account Configuration ni ad iia 14 Data Conversion and Transtery iscccsascsccssccaccrscsccvasecccseasscasassseccossaes csessesdssessseassoesseeo savas vabadseavabacsaueatana 15 Placing additional Informations lt 3 cece eseues Aasaedaceteteccensacdenteececcenctsensseseccceececguabavonchdutessueniedeceavacenes 16 Diveiand Site photos cial ei a 16 Additional descriptions for your Dives and SitOS ooooocnnnccnoccccnonanionannnnnononoccnncnonononnnnccnnn conc cc rancnninos 16 Personal Information ti a A A E dia 17 Makros in Textfiles and ADL DOt8S ooccccccncncncncocinanananananananana nano non nono nonononcn nono nono non no nononononoconanonenesos 17 PDE Export issues ivi iii flies cansa 18 PA OA 19 Page Navi Satin ti n a A AA iii 19 Main Navigate ideados 19 Context Navigation it a de Gs 20 Navigating A NT 20 Dive LOS BOOK esearon Tene a bikie cob e E ETE R CE DS ASA db iaa 20 DiVES Id E E EEEE da cis rai s 20 Dive Details ci A td Renn ba a Cea gh ae ata he ea a a BC 21 Divo Ste uni iii sacdese EEEE 21 A A A E TITO 21 Site Detalla A UTERO 21 SAUS ES eE 22 Table of Contents User Manual OO OPEREER EEEE EEEE EEE EEEE AA EE EEE IZZVS i E A A E aa Mofe IN OMAN o a Dynamically SEnerated STapOS meiosis riera REE a a cesi n Dive PROMOS ss a a dd iodo poca oe heehee Dive Schedule dd o ad a A e e a Ita Statistic Graphs e tent eet ie aie ae ie A Hn Ra aa aa lees EMOUCONS td A a
16. English description you could either place the English one as t xt and the German one as txt de or name the English one t xt en and create an additional symbolic link using the 1n s lt name of the English file gt lt name of the English file without the en gt command These files will automatically be appended to the corresponding notes fields if they exist as if their content would have been entered in the ADL comments fields Additionally it should be said that you shouldn t use HTML formating to extensive e g by changing background colors etc to not mess up the general design of the site Personal Information Additional textual information for the personal page can be created similarly but here we consider just the diver txt lt lang gt file s in the divers home directory i e the directory where the divers system conf and diver conf reside Image files here must reside in the diver lt nickname gt fotos person directory and be named diverYYY where YYY is a consecutive number of their order left padded by zeros e g diver002 jpg Makros in Textfiles and ADL notes You may include additional information like pictures or external plain text files into your notes by using special tags which are then replaced when phpDiveLog parses your DiveLog information for display This way you can include images and point to additional information on local and remote sites or even include other
17. Exporting data to PDF e Statistics e Global information e Filter Search e User Preferences Page Navigation These pages will show you how to navigate through all the information provided with you PDL installation e Main Navigation The main navigation bar e Context Navigation The context navigation bar e List Navigation Navigating in lists Main Navigation Using the navigation tabs you can navigate through the sections of the application The navigation bar has different elements depending on the mode of the application which you can switch with the first icon PDL has two modes of operation the Logbook mode and the Global mode If you don t find a single icon without description as the first element in the navigation bar the website administrator may have disabled the Global mode or none of the divers has opened his data for public access Otherwise you can use that single first icon to switch between the modi Logbook Mode In the Logbook mode following tabs are available to the visitor Tab A A Description cel1 0x81 2250 This tab brings you to the dive index which is most probably the page you see first when Dives coming to this site The dive index list up all dives of the given buddy and provides you with li the details which is why we call this page dive list too as 3740 Bifgs you to a list of all sites listed in this dive logbook As with the Dives this list provides links to more details
18. Language For this just follow the description above starting with the creation of a new language file When all translation work is done and the new file is saved to the lang directory the new language with its translations is immediately available However it may not have a flag associated on the preferences page For this generate the matching flag or download it from somewhere Make sure the image size is about 30x20 pixels itis a jpg file and its name is lang_XX jpg where XX represents the corresponding language code for the above example this would result in lang_it jpg Place it into the templates images directory and you are done Please don t forget to send your language file to the project so we can include it into the next version to be used by other people as well 10 pipiivel ay Template Sets phpDiveLog is template driven so if you don t like the design of the created pages you can easily adjust it to something more suitable either by modifying an existing template set or by creating your own All relevant files are to be found below the templates directory where each directory represents a template set Template files are HTML files with some additional information like place holders for the content and block markers so all you need is some HTML knowledge and keeping the place holders and block markers intact To create you own template set you could start with a copy of an existing
19. bdirectory of the phpDiveLog installation The syntax of this file is easy one parameter per line in the form var value Empty lines and lines beginning with a are ignored Which system options are allowed to be overridden is defined by the site admin so please ask the admin what you can use and refer to the admins configuration for the syntax One additional parameter in the system conf is personal It defines whether the diver wants to display his her personal data see diver conf below or not If this parameter is missing or commented out noone will be able to browse them via the person php page even if a complete diver conf exists The same applies if it is set to 0 Set personal 1 if you want the page to be displayed Furthermore the system conf contains a few parameters which only can be set on a per diver basis Namely the user defined fields from Aqua DiveLog There are two fields which you can set manually in its preferences and they are exported via the conduit So if you want them displayed along with your dive data you should set the variables userdef1 resp userdef2 to the title these fields should have If then for 14 a dive there are data available for this field s they will be shown in the equipment section of the dive The divers conf This file if available must reside in the same directory as the system conf file see above It is intended to provide data for the divers personal pa
20. conf you can define which ones to use Dive Schedules These are not provided by the conduit but with PDL you can integrate them into the profile graph or display a separate schedule graph If you use this graph you can even decide to disable the schedule table since the graph gives the same information in a more decent way Statistic Graphs These are what you may be used to by ADLs statistics plugin but they are not handled by the conduit So PDL offers you to create them to spice up its statistics page You can even decide to have transparent backgrounds be used with them Beside beefing up the statistic page they give you statistic information at a glance so you do not need to compare numbers visual information is easier to catch Emoticons To spice up your descriptions phpDiveLog offers you the possibility to use emoticons smileys and the like For this you need to set the emoticon definitions file in your configuration see configuration An example definition file is shipped and configured with the default configuration You are free to use your own replacement by pointing to a different file with the same structure which is easy to create it is a simple CSV file with two columns For the emoticons in your descriptions to be recognized make sure they are surrounded by white spaces i e spaces tabs line breaks They need to stand alone to make sure no other text parts are mistaken as emoticons 26
21. erridden by the divers system conf settings implicit means the behaviour as it has been until v0 4 0 all configuration variables except for those specified by cell 0x8176e38 1 0 cell 0x8176ed8 1 1 sallow_override have been protected i e the Soverride_protection explicit divers could not override them In a less restrictive environment the allow_override list could get quite long hence the new default is explicit all configuration variables can be overridden by the divers system conf except for those explicitly mentioned here we define which configuration variables may be overridden by the diver system conf file see cell 0x8178b 0 2 01 cell 0x8178c88 2 1 divers configuration when allow_override a Soverride_protection is set to implicit The value of this parameter is a space separated list of options and is completely ignored when Soyerrids protection is set to explicit which configuration variables may not be overridden when Soverride_protection is set to explicit otherwise this setting is completely ignored As Sallow_override this is a space separated list cell 0x8179fa0 3 0 protected_options a Settings dee ILLA Is 40 0 gre Default Explanation What information shall be logged This can be a combination of events chose the bold letter Errors Warnings Notices All By default errors and warnings should Whether debug info should be displayed in the browser wind
22. file lists all available divers KMZ files as network links one link per diver which works fine with Google Maps Google Earth however seems o Riqu stl ll listed network links simultaneously which the server may interprete as DoS attack and reject some of the requests the user can however reload missing files manually then in most cases So if you are affected by this you may turn the global KML processing off here ifyou vant pictues from the corresponding dive site to be eae displayed together with the pictures from the dive e dive page set this to 1 page if there are no dive pictures available Other than with sitepix_ on _divepage this would not include site Though the ea DiveLog Conduit creates graph images for the dive profiles these images vary much in their dimensions To keep the design more clear you may want to generate these ce11 0x815a Brofiles dynamically by setting this option to 1 see also DynamicGraphs Note that this requires GD support in your PHP installation plus a directory named profiles in each divers home writable for the web server process The image then will be generated in two cases If it does not already exist e profile CSV file is newer integrated These graphs are not provided by the conduit so phpDiveLog will have to generate them if you want them which means use_dyn_profile_png must be enabled for this see also DynamicGraphs With the schedule_graph configurati
23. g These are the default sort settings if one enters the logbook resp sitelist first time on the visit and did not yet apply a custom sort i e did not yet click one of the up down arrows next to the column names The _order can be either asc or desc For the _sort are the following values valid e logbook date time location place rating depth buddy e sitelist location place depth As with some of the General Settings you can override these with URL parameters Onisang the site list PDF Settings If these settings shall have any effect you need to have TCPDE installed on your server You can download and install the full distribution from their site gt 10MB zipped size or decide to install the stripped variant from the IzzySoft APT YUM repository minimal install 1MB including the API plus the font definitions recommended install 4MB including the API and the basic fonts if your system supports deb or rpm packages c UxBbocii n 6 6 eeii 0x8i6d7i0 107d 081697209 Setting Default i Explanation cell 0x816d860 1 0 cell 0x816d8f0 1 Stepdf_path lusr share tepdf Where he TCPDF files are installed If you installed TCPDF from our repository you don t need to touch this Page size to use for PDE Valid settings are everything between AO to AS and BO to BS The default AS should be a cell 0x816e000 2 0 pdf page format AS Spdf_page_orientation Portrait since you can easily prin
24. gbook owner will have limited the count of dives displayed on one 20 page In this case the table header provides you with links to the first last and previous next page Each data row in the table represents one dive record and provides you with the following links e First column with the dive number links to the dive details In the last column a camera icon indicates that there are images linked with the details e The dive location links to a list of all dive sites for this location that are recorded in any of the public logbooks of this installation e The dive site itself links to details about the dive site from the currently displayed logbook e The footer of the page contains a link to the phpDiveLog homepage Furthermore up down arrows in the table header allow you to change the sorting of the list Dive Details As the name suggests this page gives you the details on the selected dive Depending on the information the diver not recorded some of the following items may be missing e Conditions wheather currents etc e Equipment used e Graphic of the dive profile e Divers notes on this dive e Foto collection The fotos may be thumbnails which are linked to images with a higher resolution and the description itself may contain links to further information Both will normally open in a new browser window unless the logbook owner explicitly defined it otherwise Dive Sites This chapter deals with the sites t
25. ge files If you want to use phpDiveLogs import facilities useful only with multiple divers you don t want to give access to the web tree the web server requires read and write permission to all of these directories see the MultiUser and Directory Permissions articles Setting up a new diver To setup a new diver you can use the shipped demo account as template Just copy the diver demo directory to diver john cleanup the data from the diver john directory i e all files from the data fotos and images subdirectories as well as from the profiles and you ve created a new account for john For the divers configuration please see the Divers Configuration article since this is the divers task Directory Permissions Generally the web server process requires read permission on all directories and files of the phpDiveLog installation otherwise it cannot serve the web pages Depending on your configuration and intended use it additionally will require write permission on certain directories ediver profiles for dynamically created graph images e full diver including all subdirectories and files in order to use the data transfer with a single OS user see MultiUser for those users you want to give this facility to e cache for the help system to work which caches the information retrieved from this wiki there For all directories not explicitly mentioned to require write permission you better leave them read only
26. ge i e name and place of living as well as certifications The diver conf is divided into several blocks block names are encloses in square brackets If you do not want to provide data for a specific block at all you may just completely remove it or comment it out at all The person block as the name suggests contains the personal data Available options in this block are name firstname country state city and status where status means your highest certification e g AOWD DM or Instructor You can include a photo of yours using the foto option also available in this block The image used here must be stored in the diver fotos person subdirectory If you don t specify one a dummy will be used instead If you want to omit something just delete or comment out that line With the buddy1ist option you define whether these personal data may be included in the buddy list if enabled by the admin by setting it to 1 or not by either setting it to 0 commenting it out or removing that line completely With the certification block there are stronger rules to observe Data for a certification must include the course i e the certification makes no sense without and may include the date and place where it was gained Thus we have three items that belong together and we may have multiple of this groups So we group them together by arrays The consequence is you have to keep the three items together if they belong together and
27. he currently selected diver was diving at and covers the following details e Site Index e Site Details Site Index Here are all dive sites from the current logbook listed Navigation is the same as with the Dive Index and the icon in the last column is the indicator of associated images here as well The only link provided here is the site ID in the first column which brings you to the details page for the selected site Site Details Here you find the details for the selected divesite This may include some general geographic information additional notes and a photo collection if the the logbook owner provided these details For the images and links applies the same as described with the dive details If the diver provided the GPS data for this site which is indicated by a rotating globe instead of a static one a click on the globe next to the sites name will open a new browser window In that window you will then find a map with the dive sites position marked which may be useful to plan your own dives here 21 phpinvel on Statistics On this page you find the statistics for the selected logbook This includes some statistic values at the top of the page as well as some statistic graphs if the PHP installation of the site contains support for the graphics library The graphs are pretty self explaining so there s not much to describe at this place The administrator and probably the logbook owner as well if permitted b
28. ings you to a list of dives at the given place Navigating in Lists Lists usually are split into multiple pages to save you from scrolling really long lists with several hundreds or even thousands of rows so you need a way to navigate within the lists Where the detail pages have the Context Navigation in lists you will find the page navigation element It is pretty self explaining There are icons left right arrows to bring you to the previous or next as well as to the first resp last page of the list Some of them may be grayed out and have no link which means there is no corresponding page e g there is no previous page to the first and no next page to the last Between the arrows pointing to the left first and previous page and those pointing to the right next and last page you will find a row of numbers You may already have guessed so Number 5 brings you to page number 5 etc If there are more pages than would fit into the bar some of them will be missing in this row which is indicated by dots Usually you should see all page numbers close to the one you are currently on so you can quickly navigate there Dive Logbook This chapter deals with the dives of the displayed logbook and covers the following items e List of Dives e Details for a selected Dive Dives Index The dive index lists up a summary of all dives recorded in the current logbook To make this page more handy the site andministrator and or the lo
29. ion of phpDiveLog can be done in different ways e Using your package manager apt get update phpdivelog yum update phpdivelog e using the Makefile make install e manually copying the files from the Tar archive Configuration How to best configure phpDiveLog Configuration of the web application mostly takes place in text files and for the system wide configuration the relevant file is inc config inc To provide you with an easy way for updates to later versions where this file could be replaced there is a special feature If found inc config_local inc will be included right after inc config inc and overwrite its settings So if you want to change some settings the best way is 1 copy inc config inc to inc config_local inc 2 remove all settings you do not intend to change from config_local inc Feel free to remove all comments as well 3 now in config_local inc adjust the remaining settings to the preferred values Big advantage of this If there comes an update and introduces new settings they will take effect via the new inc config inc while your customized settings in inc config_local inc remain untouched Settings explained General Settings Some of the General Settings can be overridden by URL parameters which is especially useful if you plan to access the dive log s in two different ways directly stand alone where you have the full browser window available for PDL and integrated in a frame of yo
30. l UNITS bothunits yore P or bothunits Creation of the dive profile PNG graphics slows down the conversion process a lot it takes about 2 3 of the time Luckily starting with cohduit version 0 99_7 there is a new parameter to skip this step if the PNG already exists noprofileupdate In case you are using an older conduit version just comment out that line in your config or better g get the Jatest conduit the divers directory of your local phpDiveLog installation 1 e where A Tar the subdirectories data and images reside Will certainly look web divelog diver demo like lt PDL root dir gt diver lt nickname gt see Diver Setup in the admin manual for details USESCP 0 i you want to copy the files to a remote webserver via scp set the value to 1 if you have rsync installed on both the client and the server you will prefer 2 for a faster and b complete sync including all your additional texts and fotos For 13 Q any remote server set this to 0 the diver directory of the remote phpDiveLog installation i e where the subdirectories data and images on the remote server reside Will certainly look like cel1 0x81b3200lc62 10Px81b3290 2 1 lt login gt www domain com lt PDL root user machine path_to_PDL diver demo dir gt diver lt nickname gt where lt PDL root dir gt is the base directory of the PDL webtree or if the single OS user transfer is used the home director
31. may fit on one PDF page you can define the block which should go here by using HTML comments lt PDF_START gt means to ignore everything before that line for PDF export and lt PDF_END gt means to ignore everything after it As for now you may use each of this comments only once per record You can place them into your ADL notes field or to the external notes and you can even have the starting tag in ADL and the end tag in the external notes However the word record here spans both i e both notes fields together form a single one Resulting text will be checked against the pdf_max_notechars and pdf_chars_per_ pix settings and truncated accordingly One more thing to keep in mind is the TCPDF engine used to generate the PDEs is very picky when it comes to HTML So take care to e use either plain text or XHTML if you need tags PDL however tries to keep track to fix up your code to a certain degree e when using images always specify HEIGHT and WIDTH or it may be screwed up in the PDF text length calculation may also fail then e humm some more things may be added here when we find them 18 User Manual This part of the documentation is intended to assist the user visiting the PDL website to deal with the sites information Navigating through the pages finding the required information and so on It covers the following chapters e Page navigation e Dive logbook e Divesite information e
32. mply click on the corresponding nick name Global Diver Buddy List This page lists up all publically available Dive logbooks for this installation A click on the divers nick name brings you to the Dive Index of his her logbook If you find an icon in the last column this indicates that there s a personal picture available on his her personal page PDF Export Introducing PDE Export to PDL meant to give you the possibility to print your logbook However you can of course also use a PDE export to carry with you or to present it somewhere where there s no internet connection And while from the corresponding detail pages you only can export data from the current page the PDE Export page allows you to export all or selected pages together We tried to consider a lot of requirements when designing this functionality Export for presentation or for printing Printing on duplex capable and non capable printers Different ways to prepare duplex printing for non capable printers Quite a lot of thoughts and work went here as you can imagine 22 Moreover we tried to put more context sensitive help directly into the page while still keeping it simple and clear This was achieved using the HTML TITLE attribute So before you go nuts on what to select Calm down move your mouse over the questionable option and keep it there You will see a small pop up giving you some background information And all that without any Javascript involved The de
33. on option you can tell phpDiveLog how you want your schedule graph to be drawn integrated into the profile graph if possible falls back to next ADO as a separate graph in the Schedule section of the page or none if you cell 0x815e5c0 7 0 ce11 0x6150 Sing the graph says more than thousand table rows you may hide_schedule_table TRUE not want to waste space on the page for the raw data Here you e ether to hide TRUE or display FALSE them On the statistics page for each diver you also find some graphs e g for dives per year They can have the values printed within the bars but if you are to list up statistics for more than 20 years or have several hundreds or even more dives per year cell 0x815 260 8 0 this may not look as nice as you would expect so you have values_in_statgraphs the choice to always have the values displayed in the bars yes never have them there no or let the app decide auto The latter should be fine for the average diver Note The values are always displayed when hovering the mouse over the corresponding bar so don t be afraid they could be cell 0x8161998 9 0 cell 0x816lq graph_bg_transparent If you did not enter any water temperature in ADL the conduit would export this as 0 C so phpDiveLog cannot decide ee LAOA Between no temperature entered and real 0 C Though this ignore_zero_degrees temperature is really unlikely to be dived in we want to leave
34. ow itself 1 a very bad ide for production systems since internal private information would be presented to each visitor This is pe simply to ease debugging you should debug_log l Whether to store error messages to the web servers error 1og file 1 or not 0 It is always a good idea to have this turned on so you can verify if a certain error already exists for a while and since when Miscellaneous Settings b 0 x R b ON 0 Setting Default ere Explanation cel1 0x81762 8 dd D30x8170390 11 Emoticon definition file see Emoticons Comment out if you don t emoticon_file inc emoticons csv i want to have emoticons to be used Diver Accounts All things needed for a diver account can be found in the diver directory Each subdirectory here represents a diver account the name of that subdirectory represents the divers nick Directory Structure Each divers directory contains a number of subdirectories with the following structure t 0x 810k E4030 10 0 data holding the csv data files tO OS dive fotos of the dives images dive profiles generated by ADL are placed here profiles dynamically generated dive profile graphs site fotos of the dive sites All the directories require at least read permission for the web server process the optional profiles directory additionally requires it to have write permission as well to store dynamically created graph ima
35. pt get remove phpdivelog yum remove phpdivelog make uninstall Using deb rpm packages with the repository moreover will allow you easy updates Manual Installation If you prefer to do a manual installation you first need to make sure all requirements are met Then 1 Unpack the TAR archive to the directory of your choice This must either be inside your web servers document root or linked there and the web server configured to allow that FollowSymLinks in the Apache options or set up in your web servers configuration as an Alias 2 Re Move the instal1 subdirectory from that installation since it is not needed on the server but rather on the clients Details on this can be found in the DiverManual 3 If you are concerned about disk space you may want to remove language files for languages which you don t need lang trans This will free some hundred kilobyte at maximum And you must not delete the English language file 1ang trans en since this is the only one really required Help Cache Depending on the installation path chosen you may have to check for the cache directory which needs to be read and writeable by the web server process When installing from a package the deb rpm stuff should have taken care for this but it cannot hurt to make sure If you forget this step don t worry The help system will let you know Updating Depending on how you performed the installation updating from a previous vers
36. t to the equal sign 12 Conduit al Explanation Don t mess this up with your PCs locale settings we don t touch them But if they differ from your Palms locale which will certainly be the case if you run a current distribution with UTF 8 locale special cell 0x81a8328 loem oxslas3b8 Jeharacters may get messed up or in the worst case the Java Conduit hangs if this is not set correctly In most cases the setting of de_DE euro Latin 1 plus Euro sign will be the correct choice For non Western charsets on your Palm you may have to experiment a bit until all special chars are drawn correctly This setting is required by the PalmOS devices use different character sets If you encounter display problems on your divelog web pages such as messed up characters German Umlauts and the like you may want to play with this option If cell 0x81aa548 hydll 0x8iaa5as got set to an empty string the script will use the recode command to convert the character set to UTF8 you just need to figure out which character set your PalmOS device is using see also install charsets txt Usually a good starting point is lat 1 for newer devices PalmOS 5 and up or cp1252 for older ones cell 0x81ac738 byll 0x8iac7cs lh you dida not change this in the divelog ini you can leave this as is otherwise place the same value here as you did there for the Dele ore lad35s Aeon 4ujtlich kind an ou prefer can be set either to metric imperia
37. t two pages on one A4 page then letting the printer driver print 2 pages on one with pee pages exported it cell 0x816f910 3 0 pdf_page_orientation cell 0x81706d0 4 0 pdf_page_gutter cell 0x81717d8 6 0 pdf_no_profile available dummy places a dummy profile blank just leaves the space blank Would you like to have some photos included with your A AN col1 0x8172198 7b ebook pages if there are dive photos connected Setting spat wiih tots oe this to TRUE will include the first three dive photos if eer cr ee ae O available or All dive photos if there are less than three pdf_enable TRUE Whether PDF functions should be available if the API is found then You can use this option to disable PDE support when you feel too many users on the public servers play and the server load increases too much for example cell 0x81742b0 9 0 pdf_max_notechars cell 0x8174a38 10 0 pdf_chars_per_pix Missing profile graphs can be created on the fly when generating the PDE so this setting can be overridden on the page for mass export If set to 1 missing and outaged profiles will be re created If set to 0 the static graph will be substituted if found or the setting of Spdf_no_profile will be applied aie Overrides by Divers system conf cell 0x8175408 11 0 cell 0x81754a8 1 pdf_create_missing_graph 1 0x8 LI 10 0 soll 0xe176ces14 6 Explanation How to tell which settings may be ov
38. tails integrated there are quite short so all browsers can handle it some cannot cope with too long titles Hence you shall find some more detailed information here Explanation This Apron is intended for presentation PDEs as well as for printers capable to handle duplex printing themselves All records will be arranged in their numerical order No empty pages shifted in no numbers shuffled All other duplex options are intended for printing with non duplex printers only or if you don t trust or don t want to use your cell 0x821b420 2 0 Duplex handling None Duplex handling while the pages are in DIN A5 and you only need to cut the paper in the middle to get the correct pages This applies to the following duplex options as well The special here is the gutter i e the wider part of the page border where you usually make the holes to file it into y our folder will always point to the middle of the paper Duplex handle Like the previous item just the other way round concerning the gutter here the smaller Quter QU os border points to the middle of the paper Jcel1 0x821 688 5 1 ee cue same but the gutter will always point to the same side of the paper Include Fotos PDL aon dynamically created graphs This means they are created on demand other than those the conduit already provides So if they have not yet been created they cell 0x8220b20 17 olan either be substituted by the static ones from
39. template set This ensures that you do not miss any place holders and or block markers If those are missing your template will not work Then simply edit the HTML in your copy with your favorite HTML editor adjust the css file if necessary replace some images in the images subdirectory and add the files to a new sub directory below the templates directory If it s just the colors and background images you don t like you may want to modify the css files of the template set in question or replace the images in its images subdirectory 11 Diver Manual Opposite to the AdminManual the following pages are describing issues relevant for the diver representing his her logbook with phpDiveLog The following issues are covered e Installation Client side installation issues e Configuration How to configure your phpDiveLog account e Data Conversion Data Conversion and Transfer e Additional Information Placing photos and additional descriptions Client Side Installation While the installation of phpDiveLog itself is the duty of the admin the diver also has to perform some installation tasks We need to export the data from ADL to a format usable by phpDiveLog and thus we have to setup the conduit Install the Conduit The conduit itself is not shipped with phpDiveLog so you have to download it from the ADL website Further this article assumes you already did so and also installed the conduit So this is where
40. the conduit or a dummy graph empty Missing Graphs image if this is also missing or you can let them be created on the fly When exporting an entire large logbook this may lead to a browser timeout in which case you just need to reload the page as often until the last graph was created So if you are in a hurry you can just say No here Finally there are three buttons Not necessary to say that depending which one you press the corresponding information will be exported Either Dives Sites or Statistics Since the latter is just a single page all above options are irrelevant for this one Filter Search This page offers you the facility to filter the records displayed in lists which is pretty much the same as searching for records with the only difference that the filters remain active until you explicitly reset them To clear the filters away just click the filter tab a second time while the filter page is displayed The Filter Search page is divided into two blocks In the first one you can search for dives the second one searches for sites You just must enter values in those fields you want to restrict by leaving the others empty All your specifications will be connected with a logical AND which means all of the specified conditions must be met for a record to be displayed Hovering your mouse pointer over a field gives you closer 23 BAnINVEL OF information There are different comparison operators offered for
41. ur website where space is a bit limited So in the latter case you don t care about additional URL parameters to limit e g the rows per page in lists while in the first case you want to use the additional space and have longer lists The column URL Override tells you the parameter name if available 0x814acd8 11 0 8142410 10 2 cell 0x814adf0 Oe 11 0x814ae80 ro URL cell 0x814aff0 0 3 Setting Default Explanation Override formats available such as UDDF for the Universal Dive Data Format again a file or even real databases such as with pages containing lists as e g the sitelist this value will advise PDL how many entries i e table data rows to display per page This saves you from scrolling through long pages but of course you can set this to e g 999999999 and e will fit on one page but not necessarily one cell 0x814c1f0 display_limit to s which template set PDL should default Right now the cell 0x814d6 0 Els values aqua and default are available The visitor can template_set l overwrite this value for his her browser session only of course by selecting a different template set on the the denal ue to use if no other language was specified via the users preferences This is a 2 character ISO code like en for English or de for German You can set this fo ahy language you like if no translations are found PDL will fall back to English You can tell available languages b
42. which provides you with a list of your dive sites Again a click on the site brings you to the details page e all Dive Sites in Google Maps or Google Earth with a single click e the Divers Information where you can define some about me items Additionally you also can export your dive and site information to PDE in order to maintain a paper version of your logbook 25 What are the requirements to use phpDiveLog For data conversion from AquaDiveLog you need to have a Java interpreter installed refer to the AquaDiveLog documentation for details phpDiveLog itself only requires a running web server with PHP version 4 or higher support Where can find more information e in the Demo e within the downloaded files e on the AquaDiveLog Homepage e at Freshmeat you also find a project page for phpDiveLog Dynamically generated graphs phpDiveLog optionally can generate dynamical graphs if you configured it accordingly see Configuration In some cases this is to replace graphs which are provided by the conduit of ADL in other cases these are providing additional information Dive Profiles These are usually provided by the conduit but the images created that way differ in size and sometimes don t fit the layout and or design of the pages So we left it to the site admin and or diver which ones are preferred With the Suse_dyn_profile_png parameter of the Configuration and optionally also the divers system
43. y investigation of the Lang directory See the CustomizationManual for details on how to add missing cell 0x814e6e8 lang for nc now the site name to be displayed in the browsers title bar Lace id ee At the end of this some page information will be added if title you e g set the title to MyDiveLog by browsing the dive 5 the browsers title probably looks like iia Dive gt where Dive could be localized even cell 0x81517d8 z LIH whether visitors should be allowed to browse the buddylist enable_index Needs to be set to TRUE if you want to use page index oe poten 3248 cell 0x8155 9k Graph pl Q cell 0x8157700 1 0 sitepix_on_divepage cell 0x81581c8 2 0 sitepix_first cell 0x8158b40 3 0 sitepix_separate cell 0x8159508 4 0 sitepix_if_no_divepix cell 0x815a748 5 0 use_dyn_profile_png schedule_ graph ll thus PDL does not know where to look for the data normally this has to be done on the URL with the diver nickname parameter Available options are user Sdefault_user must be set to a valid user then index display the index page with available nicks needs Senable_index TRUE see above and error display an error message to the visitor only evaluated 1f default_page user which is the default logbook we should route the request to Must be a valid account otherwise results in default_page error Aaplanation The doba KML
44. y of that OS user see Diver Setup i in the admin manual for details and or ask this defines which source directory should be used with rsync If you have no local PDL installation on your machine and or use USELOCAL 0 set this to 2 which advises the script to use the ADL log dir as source In this case also make sure that all needed subdirectories i e for the fotos notes and texts exist at that place Otherwise with a local installation of PDL you probably don t want to keep all fotos duplicate so set this to 1 and place all your additional foto and text files where they belong in your local PDL diver dir in which case you will need to set USELOCAL 1 You can use local USELOCAL 1 and remote USESCP 1 or USESCP 2 transfers independantly if you need both you can enable both at the same time which would even be required for RSYNCBASE 1 cell 0x81b4f80 cE3 16 Px81b5010 3 1 Site Account Configuration The site account configuration takes place in two files located directly in your PDL home directory i e diver your_nickname e system conf contains your preferences concerning site appearance edivers conf contains personal information about you you want to attach to your online divelog The system conf Optionally each diver can override some of the systems default settings by putting a file named system conf in his her home directory home directory refers to the diver lt nick gt su
45. y the administrator may have defined different settings e g for the intervals so don t wonder if it does not look the same in different logbooks One thing you may wonder could be the different sum of dives in the temperature graph Due to the fact that ADL sets the temperature value to 0 C if no temperature was given PDL can be configured to ignore this value It also offers to place a note for this but since this is optional the note may be missing Global Mode If the Admin enabled the Global Mode and multiple divers share this installation plus permitted public access for their log books this allows you to find information from multiple log books e Diver Buddy List e Global Site Index Global Site Index When you select this tab it will bring you to a list of locations gathered from all public logbooks on this installation The header of the table provides you with links to navigate between the pages if there are multiple pages available A click on the locations name brings you to the list of all sites at that location how many sites you can expect on that page is told by the column next to the location Once you selected the location to browse the next table lists you all sites found with this installation together with the information in which divers logbook we found the sites In order to view the site description details just click the ID displayed in the first column To view information of the diver him herself si
46. y way with Windows or use our repository see below for deb rpm packages The minimal case here includes the packages t cpdf api plus tcpdf fonts minimal but we recommend to replace the latter with tcpdf fonts basic for better UTF8 support with the available fonts Still the recommended variant is just 4MB packed size opposite to gt 10MB of the original distribution archive Installation Recommended Installation Path The best and most recommended way to install phpDiveLog is to use your Linux distributions package manager There are deb and rpm packages available in the IzzySoft APT repository and you can even include this repository in your APT or YUM configuration this is described on the webpages there Doing so all dependencies will be resolved automatically and installation is done by a single command apt get install phpdivelogoryum install phpdivelog will perform all necessary steps for the TCPDF Api add apt get install tcpdf api tcpdf fonts basic resp yum install tcpdf api tcpdf fonts basic If you can neither use deb nor rpm packages you should download the TAR archive Having these unpacked change to the directories created and run make install after making sure that all dependencies are met All these mentioned methods have at least two advantages over the manual installation e all files will automatically be put to the right places e everything can be easily cleanly uninstalled a
47. you must not miss the square brackets at the end of the options name Plus you have to include either none or all three options if you don t want to publish e g the date just leave the parameter blank Otherwise if you specify it for the next course the parser will count it to the previous Available options in this block are course date andplace To add more descriptive context you can make use of other external sources such as a text file in your diver home directory See Additional Sources for details on this The public file If you want your data to be accessible and findable by visitors i e used in the buddylist and global site index place an additional file next to the bot configuration files and name it public It s content is completely ignored so it may be empty but its presence will be checked at the corresponding places Data Conversion and Transfer Once you ve setup the conduit scripts accordingly you simply have to change to the directory containing the divelog_conduit sh script and run it without any parameters after you got the up to date ADL database files from your Palm Provided your configuration was correct the script will do all necessary steps e run the conduit to convert the ADL database files to csv files e adjust the text encoding in those csv files if necessary e optionally transfer all data optionally including your images etc depending on your configuration to the web server
48. you the questionable fun of doing so by setting this variable to O T10 dards Zz ro_ degrees was set to TRUE shall we Signore_zero_degrees_ place a note below the temperature graph to indicate this 11 0x8163d10 12 0 cell 0x81 Qed a _stat_interval 10 either 5 or 10 me a o ee i g2 Time interval in minutes for the Dives by Duration graph Set ee i ither 10 or 20 30 should also work 11 0x8164c38 14 0 11 0x81 ao f depth stat interval itek Gn meters for the Dives by Depth graph Valid settings are 5 10 and 20 Explanation If you want to T your buddies to transfer their divelog data using a single OS account see MultiUser Issues you need to set up a password im5038165780 1 1 lfile so only the diver him herself can import their transfered data into etc pdlpwd the PDL installation This file should NOT reside inside your web tree but it must be readable by the web server A good idea is to let this file be owned by the web servers users group and apply read permission for the O erver should not have write permission to the file The base directory for the transfered logbook data when using the single OS user transfer see MultiUser Issues This should be the directory containing the diver directories directly below it i e the counterpart to the PDL diver directory cell 0x81679 8e11050481679e0 2 1 transfer_dir home pdl transfer Sorting and Orderin

Manual

Contents

Download Pdf Manuals

Related Search

Related Contents