01: /*
02: * This file is part of "SnipSnap Radeox Rendering Engine".
03: *
04: * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
05: * All Rights Reserved.
06: *
07: * Please visit http://radeox.org/ for updates and contact.
08: *
09: * --LICENSE NOTICE--
10: * Licensed under the Apache License, Version 2.0 (the "License");
11: * you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software
17: * distributed under the License is distributed on an "AS IS" BASIS,
18: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19: * See the License for the specific language governing permissions and
20: * limitations under the License.
21: * --LICENSE NOTICE--
22: */
23:
24: package org.radeox.api.engine;
25:
26: import org.radeox.api.engine.context.RenderContext;
27:
28: /**
29: * Interface for RenderEngines that allow to include content like wiki pages or
30: * snips, e.g. with {!includeWiki} in MacroFilter
31: *
32: * @author Stephan J. Schmidt
33: * @version $Id: IncludeRenderEngine.java 7707 2006-04-12 17:30:19Z
34: * ian@caret.cam.ac.uk $
35: */
36:
37: public interface IncludeRenderEngine {
38: /**
39: * Include an object in the input. This could be a wiki page, snips,
40: * comments.
41: *
42: * @param name
43: * Name of the object to include, e.g. wiki page name
44: * @param context
45: * @return result A string representation of the included object
46: */
47: public String include(String name, RenderContext context);
48: }
|