You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2016/10/30 16:33:51 UTC
svn commit: r1000145 [22/30] - in
/websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST:
./ apidocs/ apidocs/org/apache/maven/doxia/docrenderer/
apidocs/org/apache/maven/doxia/docrenderer/class-use/ apidocs/org/apache...
Modified: websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/Renderer.html
==============================================================================
--- websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/Renderer.html (original)
+++ websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST/doxia-site-renderer/xref/org/apache/maven/doxia/siterenderer/Renderer.html Sun Oct 30 16:33:39 2016
@@ -37,130 +37,132 @@
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <p>Site Renderer interface: render a collection of documents into a site, ie decored with a site template</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * (eventually packaged as skin).</p></em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:evenisse@codehaus.org" target="alexandria_uri">mailto:evenisse@codehaus.org</a>">Emmanuel Venisse</a></em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @version $Id: Renderer.java 1729502 2016-02-09 23:28:47Z michaelo $</em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/maven/doxia/siterenderer/Renderer.html">Renderer</a>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> {
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Plexus lookup role.</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> String ROLE = Renderer.<strong class="jxr_keyword">class</strong>.getName();
-<a class="jxr_linenumber" name="L48" href="#L48">48</a>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Render a collection of documents into a site.</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @param documents the documents to render.</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext the SiteRenderingContext to use.</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory to write results.</em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">void</strong> render( Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext,
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> File outputDirectory )
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">throws</strong> RendererException, IOException;
-<a class="jxr_linenumber" name="L61" href="#L61">61</a>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Generate a document output from a Doxia SiteRenderer Sink.</em>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param writer the Writer to use.</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param sink the Site Renderer Sink to receive the Doxia events.</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext the SiteRenderingContext to use.</em>
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">void</strong> generateDocument( Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext )
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">throws</strong> RendererException;
-<a class="jxr_linenumber" name="L72" href="#L72">72</a>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Create a Site Rendering Context for a site using a skin.</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @param skinFile</em>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param attributes</em>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param decoration</em>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param defaultWindowTitle</em>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @param locale</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @return a SiteRenderingContext.</em>
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if it bombs.</em>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <a href="../../../../../org/apache/maven/doxia/siterenderer/SiteRenderingContext.html">SiteRenderingContext</a> createContextForSkin( File skinFile, Map<String, ?> attributes, DecorationModel decoration,
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> String defaultWindowTitle, Locale locale )
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">throws</strong> RendererException, IOException;
-<a class="jxr_linenumber" name="L87" href="#L87">87</a>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Create a Site Rendering Context for a site using a local template.</em>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @param templateFile</em>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @param attributes</em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param decoration</em>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param defaultWindowTitle</em>
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param locale</em>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @return a SiteRenderingContext.</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws MalformedURLException if it bombs.</em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @since 1.7, had an additional skinFile parameter before</em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @deprecated Deprecated without replacement, use skins only.</em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @see #createContextForSkin(File, Map, DecorationModel, String, Locale)</em>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> @Deprecated
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <a href="../../../../../org/apache/maven/doxia/siterenderer/SiteRenderingContext.html">SiteRenderingContext</a> createContextForTemplate( File templateFile, Map<String, ?> attributes,
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> DecorationModel decoration, String defaultWindowTitle,
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> Locale locale )
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">throws</strong> MalformedURLException;
-<a class="jxr_linenumber" name="L107" href="#L107">107</a>
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * Copy resource files.</em>
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext</em>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @param resourcesDirectory</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @param outputDirectory</em>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @deprecated since 1.7, use copyResources without resourcesDirectory parameter</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">void</strong> copyResources( SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory )
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throws</strong> IOException;
-<a class="jxr_linenumber" name="L119" href="#L119">119</a>
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * Copy resource files from skin, template, and site resources.</em>
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @param outputDirectory</em>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @since 1.7</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">void</strong> copyResources( SiteRenderingContext siteRenderingContext, File outputDirectory )
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">throws</strong> IOException;
-<a class="jxr_linenumber" name="L130" href="#L130">130</a>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * Locate Doxia document source files in the site source context.</em>
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext</em>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @return the Doxia document renderers in a Map keyed by output file name.</em>
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> Map<String, DocumentRenderer> locateDocumentFiles( SiteRenderingContext siteRenderingContext )
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">throws</strong> IOException, RendererException;
-<a class="jxr_linenumber" name="L141" href="#L141">141</a>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * Render a document written in a Doxia markup language. This method is an internal method, used by</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * {@link DoxiaDocumentRenderer}.</em>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param writer the writer to render the document to.</em>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @param renderingContext the document's rendering context, which is expected to have a non-null parser id.</em>
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @param siteContext the site's rendering context</em>
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @throws FileNotFoundException if it bombs.</em>
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @throws UnsupportedEncodingException if it bombs.</em>
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">void</strong> renderDocument( Writer writer, RenderingContext renderingContext, SiteRenderingContext siteContext )
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">throws</strong> RendererException, FileNotFoundException, UnsupportedEncodingException;
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <p>Site Renderer interface: render a collection of documents into a site, ie decored with a site template</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * (eventually packaged as skin).</p></em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:evenisse@codehaus.org" target="alexandria_uri">mailto:evenisse@codehaus.org</a>">Emmanuel Venisse</a></em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @version $Id: Renderer.java 1767162 2016-10-30 14:48:28Z hboutemy $</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/maven/doxia/siterenderer/Renderer.html">Renderer</a>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> {
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Plexus lookup role.</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> String ROLE = Renderer.<strong class="jxr_keyword">class</strong>.getName();
+<a class="jxr_linenumber" name="L49" href="#L49">49</a>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Render a collection of documents into a site.</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param documents the documents to render.</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext the SiteRenderingContext to use.</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @param outputDirectory the output directory to write results.</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">void</strong> render( Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext,
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> File outputDirectory )
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">throws</strong> RendererException, IOException;
+<a class="jxr_linenumber" name="L62" href="#L62">62</a>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Generate a document output from a Doxia SiteRenderer Sink.</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param writer the Writer to use.</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @param sink the Site Renderer Sink to receive the Doxia events.</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext the SiteRenderingContext to use.</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">void</strong> generateDocument( Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext )
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">throws</strong> RendererException;
+<a class="jxr_linenumber" name="L73" href="#L73">73</a>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Create a Site Rendering Context for a site using a skin.</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param skin</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param attributes</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param decoration</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @param defaultWindowTitle</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @param locale</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @return a SiteRenderingContext.</em>
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if it bombs.</em>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @since 1.7.3 was previously with skin as File instead of Artifact</em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <a href="../../../../../org/apache/maven/doxia/siterenderer/SiteRenderingContext.html">SiteRenderingContext</a> createContextForSkin( Artifact skin, Map<String, ?> attributes, DecorationModel decoration,
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> String defaultWindowTitle, Locale locale )
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">throws</strong> RendererException, IOException;
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Create a Site Rendering Context for a site using a local template.</em>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param templateFile</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param attributes</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param decoration</em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @param defaultWindowTitle</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param locale</em>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @return a SiteRenderingContext.</em>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @throws MalformedURLException if it bombs.</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @since 1.7, had an additional skinFile parameter before</em>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @deprecated Deprecated without replacement, use skins only.</em>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @see #createContextForSkin(File, Map, DecorationModel, String, Locale)</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> @Deprecated
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <a href="../../../../../org/apache/maven/doxia/siterenderer/SiteRenderingContext.html">SiteRenderingContext</a> createContextForTemplate( File templateFile, Map<String, ?> attributes,
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> DecorationModel decoration, String defaultWindowTitle,
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> Locale locale )
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">throws</strong> MalformedURLException;
+<a class="jxr_linenumber" name="L109" href="#L109">109</a>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Copy resource files.</em>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext</em>
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @param resourcesDirectory</em>
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @param outputDirectory</em>
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * @deprecated since 1.7, use copyResources without resourcesDirectory parameter</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">void</strong> copyResources( SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory )
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="L121" href="#L121">121</a>
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Copy resource files from skin, template, and site resources.</em>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext</em>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param outputDirectory</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @since 1.7</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">void</strong> copyResources( SiteRenderingContext siteRenderingContext, File outputDirectory )
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Locate Doxia document source files in the site source context.</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @param siteRenderingContext</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @return the Doxia document renderers in a Map keyed by output file name.</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @throws IOException if it bombs.</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> Map<String, DocumentRenderer> locateDocumentFiles( SiteRenderingContext siteRenderingContext )
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">throws</strong> IOException, RendererException;
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Render a document written in a Doxia markup language. This method is an internal method, used by</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * {@link DoxiaDocumentRenderer}.</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @param writer the writer to render the document to.</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @param renderingContext the document's rendering context, which is expected to have a non-null parser id.</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @param siteContext the site's rendering context</em>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @throws RendererException if it bombs.</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @throws FileNotFoundException if it bombs.</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @throws UnsupportedEncodingException if it bombs.</em>
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">void</strong> renderDocument( Writer writer, RenderingContext renderingContext, SiteRenderingContext siteContext )
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">throws</strong> RendererException, FileNotFoundException, UnsupportedEncodingException;
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>