Changes between Version 3 and Version 4 of TracGoogleSearchPlugin


Ignore:
Timestamp:
Apr 14, 2018, 8:29:48 AM (3 years ago)
Author:
figaro
Comment:

Added links to plugin code

Legend:

Unmodified
Added
Removed
Modified
  • TracGoogleSearchPlugin

    v3 v4  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Trac Google Search
     3= Trac Google Adsense and Search
    44
    55== Description
    66
    7 This plugin enables your Trac environment to use Google's Adsense for Search on the mini search box displayed on top.
     7This plugin enables your Trac environment to use [https://www.google.com/adsense/start/#/?modal_active=none Google's Adsense] for Search on the mini search box displayed on top. Google AdSense is a program run by Google that allows publishers in the Google Network of content sites to serve automatic text, image, video, or interactive media advertisements, that are targeted to site content and audience. AdSense for search allows publisher to display ads relating to search terms on their site and receive part of of the revenue generated from those ads.
    88
    99**Note:** Regular Trac search won't be disabled, the users must click the Search button to access it, and will only show up and work if user has `SEARCH_VIEW` permissions, unlike this plugin, which does not require any special permissions since it's querying Google not Trac.
     
    2121== Download
    2222
    23 This plugin is available on [pypi:TracGoogleSearch PyPi].
     23Download the zipped source from [export:tracgooglesearchplugin here].
     24
     25This plugin is also available on [pypi:TracGoogleSearch PyPi].
    2426
    2527== Source
    2628
    27 Check out TracGoogleSearchPlugin from [pypi:TracGoogleSearch PyPi].
     29Check out TracGoogleSearchPlugin from [/svn/tracgooglesearchplugin here] using Subversion, or [source:tracgooglesearchplugin browse the source] with Trac.
    2830
    2931== Installation
     
    3335== Configuration
    3436
    35 In order to use this plugin you must first create a custom search engine on your Adsense_ account, configure it like you want it and choose to display the results on a page on your own website.
     37In order to use this plugin you must first create a custom search engine on your Adsense account, configure it like you want it and choose to display the results on a page on your own website.
    3638
    37 If you wish Google_ to show results relative to the domain of your trac_ environment, on your Adsense_ account, edit your search engine settings, choose *"view more advanced features"*, select *"Search the entire web but emphasise included sites"* and then under *"Sites"* add your trac_ environment domain.
     39If you wish Google to show results relative to the domain of your Trac environment, on your Adsense account, edit your search engine settings, choose "view more advanced features", select "Search the entire web but emphasise included sites" and then under "Sites" add your Trac environment domain.
    3840
    39 From the resulting code that Google_ provides we'll need the values from the hidden fields named, **cx** and **cof**, ie, your client id and search id strings.
     41From the resulting code that Google provides we'll need the values from the hidden fields named, **cx** and **cof**, ie your client id and search id strings.
    4042
    4143Consider the following example code:
     
    5658The values you'll need to remember would be **partner-pub-0000000000000000:0aaaa0aaa00a** and **FORID:1**, the rest of the code will be provided by the plugin.
    5759
    58 The plugin can then be configured on trac_'s administration panel, under the section **Google** and then **Search**.
     60The plugin can then be configured on Trac's administration panel, under the section **Google** and then **Search**.
    5961
    6062== Recent Changes
    6163
    62 See [pypi:TracGoogleSearch PyPi].
     64[[ChangeLog(tracgooglesearchplugin, 3)]]
    6365
    6466== Author/Contributors