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// @formatter:off
025@HtmlDocConfig(
026
027   // Default page header contents.
028   header={
029      "<h1>$RS{title}</h1>",  // Use @Rest(title)
030      "<h2>$RS{operationSummary,description}</h2>", // Use either @RestOp(summary) or @Rest(description)
031      "$C{REST/header}"  // Extra header HTML defined in external config file.
032   },
033
034   // Basic page navigation links.
035   navlinks={
036      "up: request:/.."
037   },
038
039   // Default stylesheet to use for the page.
040   // Can be overridden from external config file.
041   // Default is DevOps look-and-feel (aka Depression look-and-feel).
042   stylesheet="$C{REST/theme,servlet:/htdocs/themes/devops.css}",
043
044   // Default contents to add to the <head> section of the HTML page.
045   // Use it to add a favicon link to the page.
046   head="$C{REST/head}",
047
048   // No default page footer contents.
049   // Can be overridden from external config file.
050   footer="$C{REST/footer}",
051
052   // By default, table cell contents should not wrap.
053   nowrap="true"
054)
055public interface DefaultHtmlConfig {}