001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar 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 * Sonar 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
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.api.web;
021
022import org.sonar.api.ServerExtension;
023
024/**
025 * Adds content to HTML pages. A PageDecoration is a Rails template (html.erb file) that executes content_for blocks on predefined locations :
026 * <ul>
027 *   <li><code>script</code> : javascript header</li>
028 *   <li><code>style</code> : CSS header</li>
029 *   <li><code>header</code> : area over the black top navigation bar</li>
030 *   <li><code>footer</code> : area below the main page</li>
031 *   <li><code>sidebar</code> : area in the sidebar between the menu and the sonar logo</li>
032 * </ul>
033 *
034 * <p>Example of template: </p>
035<pre>
036 <% content_for :script do %>
037   <script>alert('page loaded')</script>
038 <% end %>
039
040 <% content_for :footer do %>
041  <div>this is <b>my footer</b></div>
042<% end %>
043</pre>
044 *
045 * @since 3.3
046 */
047public abstract class PageDecoration extends AbstractRubyTemplate implements ServerExtension {
048
049}