Styleguide: Difference between revisions

From Donate
Jump to navigation Jump to search
Browse history interactively
← Older editNewer edit →
Content deleted Content added
VisualWikitext
Cbarr (talk | contribs)
inactive
13,762 edits
Cbarr (talk | contribs)
inactive
13,762 edits
Line 174: Line 174:
To customize the donation forms for each country changes need to be made to the corresponding "Form-countryspecific-*" template.
To customize the donation forms for each country changes need to be made to the corresponding "Form-countryspecific-*" template.


===How do I add payment methods?===
===How do I add new payment methods?===
To add new payment methods 1 template needs to be edited and 1 new template must be created.
To add new payment methods 1 template needs to be edited and 1 new template must be created.

The template that must be edited is [[Template:2012FR/Form-section/Processing/Default]] and a new "Form-section/Paymentmethod/*" template must be made.


===How do I enable or disable payment methods?===
===How do I enable or disable payment methods?===

Revision as of 15:59, 2 February 2012

Introduction

In order to get an better picture of how the templates on donate.wiki relate to one another review the images below. The Landing Page is chopped up into many templates so that we can change and test individual pieces of the page without changing core functional pieces of the page. This provides us with more stability for a broader range of users.

  • Superficial changes to the various payment options can be done with editing the "Form-countryspecific-*" template for the country you wish to change.
  • Superficial changes to the layout and the appeal are done by changing the banner.
Landing Page example with template areas highlighted.
Fig. 1: An example of a Landing Page with boxed areas added in order to highlight the different templates that set the look and functionality of various areas.

Information flow

The flow of information from template to template is laid out in Fig. 2 on the right.

Flow cart showing how information goes from banner to template to template generating a Landing Page.
Fig. 2: A flow cart showing how information goes from banner to template to template generating a Landing Page. Black boxes are the templates being used to generate the LP. The blue boxes are the perimeters that are required by the templates that they are below. Orange boxes are the perimeters set in order to make superficial changes.

Banner settings completely determine which landing page is displayed, in which language, and where the page runs. All banners call the Lp-layout-default template and pass it the names of 4 templates. The default values follow:

For specifics of the donate.wiki versions of the banner code visit Styleguide/Banner.

Appeal Templates

The "2011FR/Appeal-default" is used by Template:2011FR/Appeal-template-default to call the following 2 templates:

Donation Form Templates

The template that ties together the payment form on the right of the page is Template:2011FR/Form-template-default. The country specific details are set by the template Template:2011FR/Form-countryspecific-control.

Form-countryspecific-control example

This is example code from Template:2011FR/Form-countryspecific-control/AU. 

<html>
</html>
{{2012FR/Form-section/Processing/Default
| language = {{{language}}}
| country = {{{country}}}
| appeal = {{{appeal}}}
| currency = {{2012FR/Switch/Currency/Code|{{{country}}}}}
| handler = GC
| GC-CC-ffname =  cc-vmaj
}}
{{2012FR/Form-section/Radiobuttons/Default
| country = {{{country}}}
| language = {{{language}}}
| currency = {{2012FR/Switch/Currency/Code|{{{country}}}}}
| donate-amount-0 = 5
| donate-amount-1 = 10
| donate-amount-2 = 20
| donate-amount-3 = 25
| donate-amount-4 = 50
| donate-amount-5 = 100
| donate-amount-6 = 250
}}
{{2012FR/Form-section/Paymentmethods/Creditcard}}
{{2012FR/Form-section/Paymentmethods/EWallet/PayPal}}
{{2012FR/Form-section/Paymentmethods/OnlineBT/BPay}}
{{2012FR/Form-section/Paymentmethods/Banktransfer}}
<html>
</html>

Payment Processing

Template:2012FR/Form-section/Processing/Default This template pulls in the payment processing. Currently, there are the following credit card combinations available:

  • cc-vm - Visa, Master Card
  • cc-vma - Visa, Master Card, JCB
  • cc-vmj - Visa, Master Card, American Express
  • cc-vmaj - Visa, Master Card, American Express, JCB

Donation Amounts

Template:2012FR/Form-section/Radiobuttons/Default This template pulls in the display method for the donation options and sets the values to be displayed. The "donate-amount-*" perimeters set the values that will be used in the country. These values are in the currency that has been set as the local currency.

Payment Methods

Template:2012FR/Form-section/Paymentmethods These templates enable the various payment buttons that will be shown for the LPs for this country. Currently, the available buttons are:

With a few that are waiting to be enabled:

Helper Templates

Currency templates

The following 2 templates contain the information needed to get currency details.

Switch templates

The following is a list of templates templates that are used to change page content based on language, country, etc.

Payment method templates

The following template is used to turn on and off payment methods by toggling the "display" value stored inside the template between "block"(on) and "none"(off).

This is a list of all the payment methods that can be added to a country:

Misc. Templates

F.A.Q.

How do I add currencies?

There are 4 templates that need to be changed to add a currency to be usable.

These three templates add all the needed details for each currency.

This template enables the currencies by linking them to countries

How do I add countries?

To add a country a minimum of 4 templates must be created. First, make sure the currency the new country uses is enabled. See How do I add currencies?

Second, the "Form-countryspecific-*" templates must be created At least the following country specific templates must be created

To do A/B/C/etc testing for this new country the "variable" page need to be created

How do I customize Landing Pages for a country?

To customize the donation forms for each country changes need to be made to the corresponding "Form-countryspecific-*" template.

How do I add new payment methods?

To add new payment methods 1 template needs to be edited and 1 new template must be created.

The template that must be edited is Template:2012FR/Form-section/Processing/Default and a new "Form-section/Paymentmethod/*" template must be made.

How do I enable or disable payment methods?

Each payment method has a master switch that can disable all processing of that type. The switch is located in the template Template:2012FR/Form-section/Paymentmethods/Status. By going to this template and changing the CSS property "display" to either "block" or "none", one can enable or disable payment methods respectively.

Enabling and disabling payment methods for individual countries can be done by adding and removing the payment method templates listed above from the "Form-countryspecific-*" template.

Tools

Scripts

Styleguide/Scripts

Retrieved from "https://donate.wikimedia.org/w/index.php?title=Styleguide&oldid=22267"