001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.config;
018
019import org.apache.juneau.html.annotation.*;
020
021/**
022 * Predefined REST configuration that defines common default values for HTML Doc serializers.
023 */
024@HtmlDocConfig(
025
026   // Default page header contents.
027   header={
028      "<h1>$RS{title}</h1>",  // Use @Rest(title)
029      "<h2>$RS{operationSummary,description}</h2>", // Use either @RestOp(summary) or @Rest(description)
030      "$C{REST/header}"  // Extra header HTML defined in external config file.
031   },
032
033   // Basic page navigation links.
034   navlinks={
035      "up: request:/.."
036   },
037
038   // Default stylesheet to use for the page.
039   // Can be overridden from external config file.
040   // Default is DevOps look-and-feel (aka Depression look-and-feel).
041   stylesheet="$C{REST/theme,servlet:/htdocs/themes/devops.css}",
042
043   // Default contents to add to the <head> section of the HTML page.
044   // Use it to add a favicon link to the page.
045   head="$C{REST/head}",
046
047   // No default page footer contents.
048   // Can be overridden from external config file.
049   footer="$C{REST/footer}",
050
051   // By default, table cell contents should not wrap.
052   nowrap="true"
053)
054public interface DefaultHtmlConfig {}