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