Project

General

Profile

Task #2359

Add Google Custom Search to documentation website

Added by Olivier Hallot about 1 year ago. Updated about 2 months ago.

Status:
New
Priority:
Normal
Assignee:
Category:
-
Target version:
Team - Pool
Start date:
Due date:
% Done:

0%

Estimated time:
Tags:
URL:

Description

The code snippet below should be avaliable in each page of the documentation website (https://documentation.libreoffice.org) so visitors can search the web site.

The code is tuned to the doc website. Other websites get other code.

I suggest it be displayed on the top of the page, below the header (menus) and on the right of the breadcrumb div.

---------------8<---------------------
<script>
(function() {
var cx = '010161382024564278136:rdr0n2xcnpe';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
<gcse:search></gcse:search>
---------------8<---------------------

The code is marked non-profit, that is, without ads, but I have not tested.
Thank you

History

#1 Updated by Florian Effenberger about 1 year ago

Is that something you could do, Olivier? Do you need credentials to proceed, or is more missing to roll this out?

#2 Updated by Olivier Hallot about 1 year ago

Yes I need the abilty to edit the templates.

At least in the newdesign.libreofice.org, so I can make my mistakes there.

#3 Updated by Florian Effenberger about 1 year ago

Yes I need the abilty to edit the templates.

At least in the newdesign.libreofice.org, so I can make my mistakes there.

Can you ask Cloph if he can give you access to newdesign in time?
That way you can try out first and Guilhem then can deplyo the final variant

If Cloph cannot give you access in due time (i.e. by Friday), Guilhem
can have a look. I'd just like to share the work a bit.

#4 Updated by Florian Effenberger about 1 year ago

Florian Effenberger wrote:

Yes I need the abilty to edit the templates.

At least in the newdesign.libreofice.org, so I can make my mistakes there.

Can you ask Cloph if he can give you access to newdesign in time?
That way you can try out first and Guilhem then can deplyo the final variant

If Cloph cannot give you access in due time (i.e. by Friday), Guilhem
can have a look. I'd just like to share the work a bit.

Ping?

#5 Updated by Florian Effenberger about 1 year ago

Ping?

Olivier, ping?

#6 Updated by Christian Lohmaier about 1 year ago

Olivier already had access to the newdesign site, even before Mike had. Discussed that on irc on Sep 13th..

#7 Updated by Florian Effenberger 12 months ago

Florian Effenberger wrote:

Ping?

Olivier, ping?

Ping? Is this still an issue?

#8 Updated by Olivier Hallot 12 months ago

A Google custom search in libreoffice.org realm pages is a must user-wise (much more effective that having FB, twitter and other social media icons as it is, IMHO).
I have no access to templates that I know or can remember, so I am tied here. If not please advise.
You may also lower the priority to the lowest, if resources are short.

#9 Updated by Florian Effenberger 12 months ago

  • Target version set to Pool

#10 Updated by Florian Effenberger 7 months ago

  • Assignee changed from Guilhem Moulin to Mike Saunders

Reassigning to Mike, who has been doing a lot with our web premises recently
Something you can have a look at?

#11 Updated by Mike Saunders 7 months ago

Florian Effenberger wrote:

Reassigning to Mike, who has been doing a lot with our web premises recently
Something you can have a look at?

OK, I've spent some time looking into this and reading about SilverStripe but I'm afraid it's beyond my knowledge... documentation.libreoffice.org and www.libreoffice.org appear to be hosted on the same VM, so they are using the same .ss template files in /var/www/sites/newdesign.libreoffice.org/themes/libreofficenew/templates/Layout. I can try adding the specified code to one of those, but I think it will affect all *.libreoffice.org sites.

According to https://userhelp.silverstripe.org/en/3.0/optional_features/working_with_multiple_sites/ it's possible to set up separate templates per subsites, but those appear to be templates for page content, rather than the whole design. So I can try to go further, but I'll need to spend some time studying the inner workings of SilverStripe...

#12 Updated by Olivier Hallot 7 months ago

Food for thought: consider adding a Google custom search in all websites, not only for documentation.libreoffice.org. It will have theses advantages :

  • Search will be on all libreoffice websites, we can exclude "*.microsoft.com" and "*.office.com" to prevent displaying Excel+Word pages.
  • Will force / tell Google that people are searching *.libreoffice.org, and trigger more crawling there
  • User will appreciate to have a quick access to search for a topic in the page,
  • done in the SS template easily.

I don't see any disadvantages except that I know some members of the community rants when it comes to Google.

Example of interesting deployment: Look at the magnifier icon in this W3C page :
https://www.w3schools.com/xml/xsl_elementref.asp

#13 Updated by Florian Effenberger 7 months ago

There's the ticket about search for the help online (#2555) and this
one. I wonder if two tickets can be combined?

#14 Updated by Florian Effenberger 5 months ago

Is this still of relevance?

#15 Updated by Mike Saunders 5 months ago

Florian Effenberger wrote:

Is this still of relevance?

The ticket is assigned to me (although I'm afraid I don't know enough about the internals of SilverStripe to implement it). Olivier, what do you think? Do we know anyone else familiar with SilverStripe?

#16 Updated by Olivier Hallot 5 months ago

My observations in comment#12 stands.

#17 Updated by Florian Effenberger 5 months ago

What about the advertising thing we had in the past? Is this still an
issue with that search form?

#18 Updated by Olivier Hallot 5 months ago

Florian Effenberger wrote:

There's the ticket about search for the help online (#2555) and this
one. I wonder if two tickets can be combined?

Both tickets adresses searching inside our LibreOffice.org domains. This one brings Google mighty power search inside our websites, the other no because it is a local solution.

On the POV of web visibility, I expect Google to bring traffic to our domains.

#19 Updated by Florian Effenberger about 2 months ago

Florian Effenberger wrote:

What about the advertising thing we had in the past? Is this still an
issue with that search form?

Olivier, that question seems pending

#20 Updated by Olivier Hallot about 2 months ago

Florian Effenberger wrote:

Florian Effenberger wrote:

What about the advertising thing we had in the past? Is this still an
issue with that search form?

Olivier, that question seems pending

We don't have issues on advertising, because I managed to make Google Custom Search free from non-profit status of TDF.

#21 Updated by Florian Effenberger about 2 months ago

Ok, then we can proceed unless there's a better solution available at hand

Also available in: Atom PDF