docet.DocetDocumentResourcesAccessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docet-core Show documentation

There is a newer version: 1.20.0

/*
 * Licensed to Diennea S.r.l. under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. Diennea S.r.l. licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package docet;

public interface DocetDocumentResourcesAccessor {

    /**
     * Allows to customize docet documents by providing customized text for
     * several placeholders to be placed in docet document templates, for
     * instance in Docet-generated pdf docs. For a list of supported placeholder
     * {@link DocetDocumentPlaceholder}
     *
     * @param placehoder
     * @param lang language required for translating the placeholder
     * @return the custom value for the specified placeholder
     */
    default String getPlaceholderForDocument(final DocetDocumentPlaceholder placehoder, final DocetLanguage lang) {
        return null;
    }
}