001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.web;
021
022import org.sonar.api.ExtensionPoint;
023import org.sonar.api.server.ServerSide;
024
025/**
026 * Adds content to HTML pages. A PageDecoration is a Rails template (html.erb file) that executes content_for blocks on predefined locations :
027 * <ul>
028 *   <li><code>script</code> : javascript header</li>
029 *   <li><code>style</code> : CSS header</li>
030 *   <li><code>header</code> : area over the black top navigation bar</li>
031 *   <li><code>footer</code> : area below the main page</li>
032 *   <li><code>sidebar</code> : area in the sidebar between the menu and the sonar logo</li>
033 * </ul>
034 *
035 * <p>Example of template: 
036<pre>
037 &lt;% content_for :script do %&gt;
038   &lt;script&gt;alert('page loaded')&lt;/script&gt;
039 &lt;% end %&gt;
040
041 &lt;% content_for :footer do %&gt;
042  &lt;div&gt;this is &lt;b&gt;my footer&lt;/b&gt;&lt;/div&gt;
043&lt;% end %&gt;
044</pre>
045 *
046 * @since 3.3
047 */
048@ServerSide
049@ExtensionPoint
050public abstract class PageDecoration extends AbstractRubyTemplate {
051
052}