PGVWiki - User contributions [en]

Category:Developers Guide

2010-01-15T19:18:47Z

RobertShaw: add to Category:Developer resources

This category is intended for articles containing information relavent to PhpGedVeiw developers

{{-}}
{{catindex}}

[[Category:PhpGedView|Developers Guide]]
[[Category:Developer resources]]

Contribute

2010-01-05T01:07:36Z

RobertShaw: reformat section headers so visible headers distinguished

The existence and growth of an [[w:open source|open source]] project is dependant upon the freely contributed time, talents and energies of the developers and the user community. If the developers OR the community stop contributing the project would die.

==Help Us and We'll Help You==

Those who contributing to the project will be given higher priority for help and support. They will also have a stronger voice in determining the future of PhpGedView and their feature requests will receive a higher priority from the developers.

The best way to contribute to the project is to become involved in the community. You can get involved in several ways depending on your skills and commitment.

==Helping out on the PGVWiki==
See [[PGVWiki:Community_Portal]] for a list of tasks to be undertaken.

Documentation is something that is often overlooked in open source software as most time is spent of developing and enhancing the software. Using the PGVWiki you can contribute easily to help increase documentation coverage. Currently, documentation and all things PhpGedView are spread across different websites. We are attempting to consolidate all this information into the wiki such that it becomes the main source of all PhpGedView related matter.

===Requirements===
* No programming skills are required
* Some familiarity with editing wiki pages is helpful, but by no means necessary

The main thing is to get things moved over to the wiki and enhance and update already existing pages. Don't be afraid of doing things "wrong", there is no such thing with a wiki. There are people on hand that can move and organise pages as well as adding more advanced wiki elements to pages - com'on just start editing!

==Forums==
Help other users and increase your understanding of PhpGedView by reading and answering questions in the help forums or on the mailing list.

==Help with translation==
Translation is a difficult task and most translators are happy to have any extra help you are willing to provide.

===Requirements===
* Be able to translate from English to another language

==Provide Bug Reports==
If you use PhpGedView or are the administrator of a PhpGedView website, you can help by [http://wiki.phpgedview.net/en/index.php?title=Bugs providing bug reports] for all (hopefully not too many) those annoying things you find along the way. This will help us to improve the software and help improve the PhpGedView experience for everyone.

==Beta Testing==
New features are being added to the developmental code in CVS all the time. We need people willing to help test new features in beta or CVS code. The more input we have for this, the better the final product will be. As a beta tester you will get to preview the new and exciting features coming in the next release.

===Disclaimer===
Beta testing by nature is to try to identify bugs in those new features in order to expel them before general release into onto the public. Therefore, you should not beta test PhpGedView with your important data!

===Basic Bug Reporting Requirements===
* No programming skills are required

If you notice something that doesn't work correctly, please report it! You just need to be able to take a little time to explain what you were doing when you found the bug - If we can't reproduce it, we probably can't fix it.

===Bug Fixing Requirements===
* [[w:CVS|CVS]]
* [[w:PHP|PHP]]
* [[w:JavaScript|JavaScript]]
* [[w:CSS|CSS]]
* [[w:SQL|SQL]]
* [[w:GEDCOM|GEDCOM]]

If you have knowledge about some of the above you should be able to start helping out with locating known bugs and fixing them.

==Helping out Financially==
As with all open source software, PhpGedView development relies on the hard work of developers who contribute their own time, free of charge. In addition, supplying the web space and tools for developers to collaborate costs money - if you use PhpGedView and find it useful, please find it in your heart to make a [https://sourceforge.net/project/project_donations.php?group_id==55456 donation], no matter how small.

[[Category:PhpGedView]]
[[Category:PGVWiki]]

Manage Media

2009-12-06T05:26:42Z

RobertShaw: /* Filter */ add a hint

==Manage Media==
To organize your images log in as an administrator and select 'MyGedview Portal'->'Manage MultiMedia'.

This is step two in managing uploaded media files if you have directory levels configured below the default media directory.

As an admin user you can create the directory structure you require to keep your media files organized. Creating directories from this page ensures that the thumbnail directories are created as well as creating a suitable index.php in each directory.

You can move files up and down the directory structure using the Move To --> link. The thumbnail is also moved, thus keeping the file structure consistent.

If you did not upload thumbnail files or forgot to check the Create thumbnail checkbox during the upload you have the option to generate thumbnails from here. Check the Show thumbnails box; if a thumbnail is not found you can click the Create thumbnail link to create one.
===Filter===
[[image:4_manage_media_1.jpg|left]]
 
The filter limits which media files will be displayed. The filter option has three components.
*Data Entry:- It is this area where data is entered for the filter to work upon. The filter is NOT case dependant.
*Filter Button:- This puts the filter into action
*Restet Button:- This will remove any filters that are currently inplace

===Show Thumbnails===
[[image:4_manage_media_2.jpg|left]]
 
Thumbnails will be shown if you check this box. The two images below show the different ways the media item will be displayed
 
[[image:4_manage_media_5.jpg|center|Thumbnails On]]
 
[[image:4_manage_media_6.jpg|center|Thumbnails Off]]
The examples also show a number of other menu items/links that can be followed:-
::*Move To
::*Edit
::*Delete File
::*Set Link
::*Image Link
::*View Person

These will be dealt with later on this page

===Upload Media Files===
[[image:4_manage_media_3.jpg|left]]
 
This option allows you to upload multiple files (maximum of five) at one time. These files will be uploaded with a minmum amount of information in relation to them and links to individuals, families and other locations will have to be made after the upload process is completed.
 
[[image:4_manage_media_7.jpg|left|thumb|450px|Click to show full size image]]
 
Note: The selection window indicates the maximum file size that can be uploaded . In this case it indicates 100M - most times it will be much smaller.

The use of folder names will depend upon your settings in the Multimedia section for your GEDCOM file. If this depth is set to 0 then folder names should not be used. The folder names you specify will be appended to media/. For example, media/myfamily. These folders should exist before attempting to upload files to them.

If a thumbnail has been created for the file you can also indicate the location of that file. This file will be placed in the appropriate thumbnail directory. The system can also create thumbnails on uploading if your computer system has had appropriate software installed to do this.

Clicking on Browse will open a window where the file you which to upload can be identified.

[[image:4_manage_media_9.jpg|left|thumb|250px|Click to show full size image]]
 

Once the files have been selected clicking on the UPLOAD button will commence the proceedings.
[[image:4_manage_media_8.jpg|left]]
 

An update of the upload process will be shown on the left of the screen. An example is shown below.
 
[[image:4_manage_media_10.jpg|left|Frame]]
 

===Add a new Media item===
[[image:4_manage_media_4.jpg|centre]]
Adding multimedia files (MM) to the GEDCOM is a very nice feature. Although this program already has a great look without media, if you add pictures or other MM to your relatives, it will only get better.

===What you should understand about Multimedia Files===
There are many formats of Multimedia. Although PhpGedView can handle most of them, there some things to consider.

====Formats====
Pictures can be edited and saved in many formats. For example, .jpg, .png, .bmp, .gif, etc. If the same original picture was used to create each of the formats, the viewed image will appear to be the same size no matter which format is used. However, the image files stored in the database will vary considerably in size. Generally, .jpg images are considered to be the most efficient in terms of storage space.

====Image Size====
The larger the original image, the larger will be the resultant file's size. The picture should fit on the screen without scrolling; the maximum width or height should not be more than the width or height of the screen. PhpGedView is designed for screens of 1024x768 pixels but not all of this space is available for viewing pictures; the picture's size should be set accordingly. To reduce file sizes, smaller pictures are more desirable.

====Resolution====
The resolution of a picture is usually measured in "dpi" (dots/inch), but this is valid only for printed pictures. When considering pictures shown on screen, the only correct way is to use total dots or pixels. When printed, the picture could have a resolution of 150 - 300 dpi or more depending on the printer. Screen resolutions are rarely better than 50 pixels per inch. If your picture will never be printed, you can safely lower its resolution (and consequently its file size) without affecting picture quality. If a low-resolution picture is printed with too great a magnification, its quality will suffer; it will have a grainy appearance.

====Color Depth====
Another way to keep a file small is to decrease the number of colors that you use. The number of colors can differ from pure black and white (two colors) to true colors (millions of colors) and anything in between. You can see that the more colors are used, the bigger the size of the files.

===Why is it important to keep the file size small?===
*First of all, usually your webspace is limited. The more large files there are, the more web space you need on the server. The more space you need, the higher your costs.

*Bandwidth. The more data your server has to send to the remote location, the more you may have to pay to you ISP. Data throughput is a key area where ISPs and cost is normally apportioned according to the amount of data your server sends and receives.

* Download time. If you have large files, the user (also you) will have to wait for a long time for the page to download from the server.

===How to upload your MM===
There are two ways to upload media to the site. If you have a lot of media items to upload you should contact the site administrator to discuss the best ways. If it has been enabled by your site administrator, you can use the Upload Media form under your MyGedView menu. You can also use the Upload option on the Multimedia form to upload media items.

'''Generate Thumbnails'''

We have detected that your system has the ability to automatically generate thumbnails for certain types of images. There may be support for JPG, GIF, and PNG files. The types that your system supports are listed beside the checkbox.

By clicking this checkbox, you signal the system that you are uploading images of this type and that you want it to try to generate thumbnails for them. Leave the box unchecked if you want to provide your own thumbnails.


[[Category:Administrators Guide]]
[[Category:phpGedView]]



[[fr:Gestion des objets multimedia]]

[[Category:PhpGedView]]
[[Category:Administrators Guide]]

User:3oskwuowmp5wcta

2009-11-10T02:38:11Z

RobertShaw: remove spam flag

Configuration - Display and Layout - Surnames

2009-11-10T00:07:39Z

RobertShaw: add ''Part of:''

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
==Display and Layout - Common Surnames==
====Min. No. of Occurrences to be a "Common Surname"====
[[Image:4_surnames_1.jpg|left]]
 
This is the number of times that a surname must occur before it shows up in the Common Surname list on the Welcome page.

====Names to Add to Common Surnames (Comma Separated)====
[[Image:4_surnames_2.jpg|left]]
 
If the number of times that a certain surname occurs is lower than the threshold, it will not appear in the list. It can be added here manually. If more than one surname is entered, they must be separated by a comma. Surnames are case-sensitive.

====Names to Remove from Common Surnames (Comma Separated)====
[[Image:4_surnames_3.jpg|left]]
 
If you want to remove a surname from the Common Surname list without increasing the threshold value, you can do that by entering the surname here. If more than one surname is entered, they must be separated by a comma. Surnames are case-sensitive. Surnames entered here will also be removed from the Top-10 list on the Welcome page.

[[Category:Administrators Guide]]
[[Category:phpGedView]]

Configuration - Access and Privacy

2009-11-10T00:05:57Z

RobertShaw: add ''Part of:''

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
==Access and Privacy==
===Enable Privacy===
This option will enable all privacy settings and hide the details of living people.

Living people are defined to be those who do not have an event more recent than the number of years specified in variable [[Age at Which to Assume a Person is Dead]] (internally known as MAX_ALIVE_AGE and defaulted to 120 years). For this purpose, births of children are considered to be such events as well.

To ensure privacy, people in your GEDCOM are '''''automatically assumed to be alive'''''. Here are the rules that are used to determine if a person is dead:

* A '''Death''' event is marked ''Yes''. (1 DEAT Y )
* A '''Birth''' date is more than MAX_ALIVE_AGE ago.
* Any date in the record that would make the prson older than MAX_ALIVE_AGE
* A date in the parents record that makes the parents older than MAX_ALIVE_AGE + 40
* A '''Marriage''' record with a date more than MAX_ALIVE_AGE - 10 ago.
* A date in the spouse record greater more than MAX_ALIVE_AGE ago.
* A date in the children's record more than MAX_ALIVE_AGE - 10 ago.
* A date in the grandchildren's record that is more than MAX_ALIVE_AGE - 30 ago.

===Require Visitor Authentication===
[[Image:4_access_privacy_2.jpg|left]]
 
Enabling this option will force all visitors to login before they can view any data on the site.

===Welcome text on Login page in Authentication mode===
[[Image:4_access_privacy_3.jpg|left]]
 
Here you can choose text to appear on the login screen when authentication mode is set to Yes. You must determine which predefined text is most appropriate.

The options available are:
[[Image:4_access_privacy_7.jpg|left]]
 

The predefined texts are:
* Predefined text that states all users can request a user account:
::Welcome to this Genealogy website. Access to this site is permitted to every visitor who has a user account. If you have a user account, you can login on this page. If you don't have a user account, you can apply for one by clicking on the appropriate link below. After verifying your application, the site administrator will activate your account. You will receive an email when your application has been approved.
* Predefined text that states admin will decide on each request for a user account:
::Welcome to this Genealogy website. Access to this site is permitted to authorized users only. If you have a user account you can login on this page. If you don't have a user account, you can apply for one by clicking on the appropriate link below. After verifying your information, the administrator will either approve or decline your account application. You will receive an email message when your application has been approved.

* Predefined text that states only family members can request a user account:
::Welcome to this Genealogy website. Access to this site is permitted to family members only. If you have a user account you can login on this page. If you don't have a user account, you can apply for one by clicking on the appropriate link below. After verifying the information you provide, the administrator will either approve or decline your request for an account. You will receive an email when your request is approved.

* Choose user defined text typed below
::''You can also choose to enter your own custom Welcome text, but the text you enter '''will not be translated''' when your users change language.''

===Standard Header For Custom Welcome Text===
[[Image:4_access_privacy_4.jpg|left]]
 
Choose to display a standard header for your custom Welcome text. When your users change language, this header will appear in the new language.

If set to Yes, the header will look look this:
Welcome to this Genealogy website
Access is permitted to users who have an account and a password for this website.

===Custom Welcome Text For Authentication Mode===

If you have opted for custom Welcome text, you can type that text here. The text will NOT be translated into the language of the visitor, but will be shown exactly as you typed it.

If you wish, you can use HTML tags in the text.

If you have opted for custom Welcome text, you can type that text here. The text will NOT be translated into the language of the visitor, but will be shown exactly as you typed it. However, if your custom text contains references to language variables that you can define in the various languages/extra.xx.php files, your site can show translated text. You can insert HTML tags into your custom Welcome text. You can insert references to entries in the language files or to values of global variables. Examples: <ul><li>#pgv_lang[add_to_cart]#   is a reference to the language variable $pgv_lang["add_to_cart"], and if it were to appear in this field, would show as Add to Clippings Cart when the FAQ list is viewed in the current language.</li><li>#factarray[AFN]#   is a reference to the Fact name $factarray["AFN"], and if it were to appear in this field, would show as Ancestral File Number (AFN) when the FAQ list is viewed in the current language. </li><li>#GLOBALS[VERSION]# #GLOBALS[VERSION_RELEASE]#;   is a reference to the global variable $VERSION, a space, and a reference to the global variable $VERSION_RELEASE, and if they were to appear in this field, would show as for example 4.1.4 when the FAQ list is viewed in the current language.</li><li>#GLOBALS[GEDCOM]#   is a reference to the global variable $GEDCOM, which is the name of the current GEDCOM file. If it were to appear in this field, it would show as e.g.MyFamily.ged.</li><li>#GLOBALS[GEDCOM_TITLE]#   is a reference to the global variable $GEDCOM_TITLE, which is the title of the current GEDCOM file. If it were to appear in this field, it would show as My Family.</li></ul> 

===Check Child Dates===
[[Image:4_access_privacy_6.jpg|left]]
 
Check children's dates when determining whether a person is dead. On older systems and large GEDCOMs this can slow down the response time of your site.

[[Category:Administrators Guide]]
[[Category:phpGedView]]

[[fr: Configuration - Accès et vie privée]]

Configuration File

2009-11-09T23:42:30Z

RobertShaw: add ''Also known as:'' and ''Reached via:''

''Also known as:'' '''GEDCOM Configuration'''

''Reached via:'' [[Manage Gedcoms]]
<table cellspacing=5 width=";75%"; border=";0";>
<tr>
<td width=40% valign=top>
*'''Menu Items'''
**[[Configuration - GEDCOM Basics|GEDCOM Basics]]
**[[Configuration - Multimedia|Multimedia]]
**[[Configuration - Access and Privacy|Access and Privacy]]
**Display and Layout
***[[Configuration - Display and Layout - Names|Display and Layout - Names]]
***[[Configuration - Display and Layout - Surnames|Display and Layout - Common Surnames]]
***[[Configuration - Display and Layout - Layout|Display and Layout - Layout]]
***[[Configuration - Display and Layout - Hide and Show|Display and Layout - Hide and Show]]
**[[Configuration - Edit Options|Edit Options]]
**[[Configuration - User Options|User Options]]
**[[Configuration - Contact Information|Contact Information]]
**[[Configuration - Web Site and META Tag Settings|Web Site and META Tag Settings]]
</td>
<td width=40% valign=top>
[[image:4_gedcom_config_2.jpg|center]]
</td>
</tr>
</table>


[[Category:Administrators Guide]]
[[Category:phpGedView]]

Configuration - User Options

2009-11-09T23:33:17Z

RobertShaw: add ''Part of:''

''Part of:'' [[Configuration File|GEDCOM Configuration]]
__TOC__
==User Options==
====Allow User To Change Language====
[[Image:4_user_1.jpg|left]]
 
Set to Yes to allow users to override the site's default language. They can do this through their browser's preferred language configuration, configuration options on their Account page, or through links or buttons on most PhpGedView pages.

====Show Contextual ? Help Links====
[[Image:4_user_2.jpg|left]]
 
This option will enable links, identified by question marks, next to items on many pages. These links allow users to get information or help about those items.

===Theme Directory===
[[Image:4_user_3.jpg|left]]
 

====Display Theme Dropdown Selector for Theme Changes====
[[Image:4_user_4.jpg|left]]
 
Gives users the option of selecting their own theme from a menu.

Even with this option set, the theme currently in effect may not provide for such a menu. To be effective, this option requires the Allow users to select their own theme option to be set as well.

This sets $ALLOW_THEME_DROPDOWN in xxx.GED_conf.php.

[[Category:Administrators Guide]]
[[Category:phpGedView]]