Discource-C
/
discourse-adplugin
mirror of https://github.com/discourse/discourse-adplugin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added licence and modified content

This commit is contained in:
ladydanger 2015-09-07 11:51:39 +10:00
parent c83b1c8336
commit c68a5a4f1b
1 changed files with 55 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
README.md
View File

@ -2,6 +2,9 @@
This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum.
**Authors**: [cyber_koi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger)
**Contributors**: See Credits section below
**Copyright**: 2015 **License**: MIT License
**Supported Discourse Version**: 1.4</p>
**Supported Ad Platforms**:
@ -9,6 +12,7 @@ This is the official Discourse advertising plugin. It allows advertisements to
* [Google Double Click for Publishers](https://www.google.com/dfp)
## Quick Start in 3 Steps
This quick start shows you how to install this plugin and use it. Recommended if you have:
@ -47,7 +51,6 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti
#### Step 2(a) - Choose Your Advertisement Platform
* Navigate to the Admin section in your Discourse forum.
* Click on Settings and a left vertical navigation bar should appear.
* Choose your advertisement platform by clicking on "Adsense Plugin" if using Adsense as your advertisement platform and/or click "DFP Plugin" if using the DoubleClick for Publishers advertisement platform.
@ -58,7 +61,7 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti
1. Add in your publisher ID - your publisher ID can be obtained from your ad platform and can also be found in your ad tag (see picture below).
2. Choose your trust level from the dropdown box. This will only display ads to users with a certain level of trust. For more details about trust levels go to the **Plugin Features** heading.
3. Get the Advertisement Tag from your Ad Platform - see the images below to see what a tag looks like.
4. Add parts of your ad code to Discourse's site settings as per the color coding in the images below. Only use the image for your ad platform.
4. Add parts of your ad code to Discourse's site settings for the locations you wish your ad to appear. Refer to image for your ad platform to where parts of your ad tag should go. For more detail about where the ad will appear
5. Choose Your Ad Size - this is the same size that you've put into your ad provider to create your ad. Go to the **Plugin Features** heading to see a list of supported Ad sizes.
6. To disable your ad (and not have it display), click on the disable button.
@ -76,6 +79,54 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti
Once you've configured your settings and your advertising platform has ads that are ready to serve, navigate to the page where you've inputted for the location and you should see ads.
## Plugin Features
In this section, we go into more detail on:
* Available Locations for Ad Display
* Ad Sizes Supported
* Trust Levels
### Available Locations for Ad Display
Location Name | Description | Image of Location
--- | --- | ---
Topic List Top | Ad will appear at the header of Discourse homepage | [Topic list top](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1)
Topic Above Post Stream | Ad will appear in the header of all Discourse forum topics | [Topic above post stream](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1)
Topic Above Suggested | Ad will appear in the footer above suggested topics of all Discourse forum topics | [Topic above suggested](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1)
Post Bottom & Nth Post | Ad will appear on the stipulated nth post within a topic. So if you have 5 posts in a topic and you want the ad to display after on the 2nd post, put 2 in ```ad_platform_nth_post_code```. | [Post bottom](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1)
### Advertisement Sizes Supported
This plugin supports the following ad sizes for the following locations.
All locations except post bottom | Post bottom location | Mobile
--- | --- | ---
728 x 90 | 728 x 90 | 320 x 50
336 x 280 | 336 x 280 |
300 x 250 | 300 x 250 |
970 x 90 | 970 x 90 |
468 x 60 | 468 x 60 |
234 x 60 | 234 x 60 |
125 x 125 | |
180 x 150 | |
200 x 200 | |
250 x 250 | |
### Trust Levels
You can use the ```ad_platform_through_trust_level``` dropdown to disable ads for users above a certain trust levels. As a guide, choosing:
* 0 shows ads to users that are not logged in.
* 1 shows ads to users that are not logged in, and to new and basic users.
* 2 shows ads to regular users as well, but not to leaders and elders.
* 3 shows ads to everyone but elders.
* 4 shows ads to everyone including elders.
To find more about trust levels in Discourse, refer to [Discourse's posts on trust levels](https://meta.discourse.org/t/what-do-user-trust-levels-do/4924/7)
## Other Installation
There are two sets of installation instructions:
@ -110,53 +161,6 @@ For example: ln -s ~/discourse-plugin-test .
* You can now make changes in your locally held Discourse Adplugin folder and see the effect of your changes when your run ```rails s``` in your locally held Discourse Forum files.
## Plugin Features
* Available Locations for Ad Display
* Ad Sizes Supported
* Trust Levels
### Available Locations for Ad Display
Location Name | Description | Image of Location
--- | --- | ---
Topic List Top | Ad will appear at the header of Discourse homepage | [Topic list top](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1)
Topic Above Post Stream | Ad will appear in the header of all Discourse forum topics | [Topic above post stream](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1)
Topic Above Suggested | Ad will appear in the footer above suggested topics of all Discourse forum topics | [Topic above suggested](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1)
Post Bottom & Nth Post | Ad will appear on the stipulated nth post within a topic. So if you have 5 posts in a topic and you want the ad to display after on the 2nd post, put 2 in ```ad_platform_nth_post_code```. | [Post bottom](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1)
### Advertisement Sizes Supported
This plugin supports the following ad sizes for the following locations.
All locations except post bottom | Post bottom location | Mobile
--- | --- | ---
728 x 90 | 728 x 90 | 320 x 50
336 x 280 | 336 x 280 |
300 x 250 | 300 x 250 |
970 x 90 | 970 x 90 |
468 x 60 | 468 x 60 |
234 x 60 | 234 x 60 |
125 x 125 | |
180 x 150 | |
200 x 200 | |
250 x 250 | |
TBC:
Add GIFS, Images
✘ this is a cross
✓ this is a tick
After installation users likely want to:
- Choose platform - DONE
- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this.
- Display ad.
## Questions or Want to Contribute?
Open an Issue on this repository to start a chat.
@ -166,11 +170,6 @@ Issues and Pull Requests are greatly appreciated. Bear in mind that when submit
## Credits
Discourse.org - Thanks to our mentor @eviltrout and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE
Rails Girls - Thanks @sareg0 and the Rails Girls Team.
Discourse.org - Thanks to our mentor [eviltrout](https://github.com/eviltrout) and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE
Rails Girls - Thanks [sareg0](https://github.com/...) and the Rails Girls Team.
Our Coaches - @LIST_OUT_THEIR_GITHUB_HANDLE
## License
TBC: GPL v2 or MIT