/usr/share/doc/libdoxia-sitetools-java/api/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html is in libdoxia-sitetools-java-doc 1.1.4-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Thu Nov 24 17:10:43 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
AbstractDocumentRenderer (Doxia Sitetools 1.1.4 API)
</TITLE>
<META NAME="date" CONTENT="2011-11-24">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractDocumentRenderer (Doxia Sitetools 1.1.4 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDocumentRenderer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocRenderer.html" title="interface in org.apache.maven.doxia.docrenderer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractDocumentRenderer.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.maven.doxia.docrenderer</FONT>
<BR>
Class AbstractDocumentRenderer</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.codehaus.plexus.logging.AbstractLogEnabled
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A>, org.codehaus.plexus.logging.LogEnabled</DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.html" title="class in org.apache.maven.doxia.docrenderer.pdf">AbstractPdfRenderer</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractDocumentRenderer</B><DT>extends org.codehaus.plexus.logging.AbstractLogEnabled<DT>implements <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A></DL>
</PRE>
<P>
Abstract <code>document</code> renderer.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>Version:</B></DT>
<DD>$Id: AbstractDocumentRenderer.java 947013 2010-05-21 14:04:46Z ltheussl $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>, ltheussl</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected org.apache.maven.doxia.Doxia</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#doxia">doxia</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected org.apache.maven.doxia.module.site.manager.SiteModuleManager</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#siteModuleManager">siteModuleManager</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.maven.doxia.docrenderer.DocumentRenderer"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.apache.maven.doxia.docrenderer.<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#ROLE">ROLE</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#AbstractDocumentRenderer()">AbstractDocumentRenderer</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#copyDirectory(java.io.File, java.io.File)">copyDirectory</A></B>(java.io.File source,
java.io.File destination)</CODE>
<BR>
Copy content of a directory, excluding scm-specific files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#copyResources(java.io.File)">copyResources</A></B>(java.io.File outputDirectory)</CODE>
<BR>
Copies the contents of the resource directory to an output folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()">getBaseDir</A></B>()</CODE>
<BR>
Return the current base directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getFilesToProcess(java.util.Collection)">getFilesToProcess</A></B>(java.util.Collection files)</CODE>
<BR>
Returns a Map of files to process.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getFilesToProcess(java.io.File)">getFilesToProcess</A></B>(java.io.File baseDirectory)</CODE>
<BR>
Returns a Map of files to process.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getOutputName(org.apache.maven.doxia.document.DocumentModel)">getOutputName</A></B>(org.apache.maven.doxia.document.DocumentModel documentModel)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#parse(java.lang.String, java.lang.String, org.apache.maven.doxia.sink.Sink)">parse</A></B>(java.lang.String fullDocPath,
java.lang.String parserId,
org.apache.maven.doxia.sink.Sink sink)</CODE>
<BR>
<B>Deprecated.</B> <I>since 1.1.2, use <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#parse(java.lang.String, java.lang.String, org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><CODE>parse(String, String, Sink, DocumentRendererContext)</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#parse(java.lang.String, java.lang.String, org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.docrenderer.DocumentRendererContext)">parse</A></B>(java.lang.String fullDocPath,
java.lang.String parserId,
org.apache.maven.doxia.sink.Sink sink,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)</CODE>
<BR>
Parse a source document into a sink.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.apache.maven.doxia.document.DocumentModel</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#readDocumentModel(java.io.File)">readDocumentModel</A></B>(java.io.File documentDescriptor)</CODE>
<BR>
Read a document model from a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.util.Collection, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></B>(java.util.Collection files,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)</CODE>
<BR>
Render a document from a set of files, depending on a rendering context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File)">render</A></B>(java.io.File baseDirectory,
java.io.File outputDirectory)</CODE>
<BR>
Render a document from the files found in baseDirectory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></B>(java.io.File baseDirectory,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)</CODE>
<BR>
Render a document from the files found in a source directory, depending on a rendering context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel, org.apache.maven.doxia.docrenderer.DocumentRendererContext)">render</A></B>(java.io.File baseDirectory,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)</CODE>
<BR>
Render a document from the files found in a source directory, depending on a rendering context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File, java.io.File)">render</A></B>(java.io.File baseDirectory,
java.io.File outputDirectory,
java.io.File documentDescriptor)</CODE>
<BR>
Render a document from the files found in baseDirectory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></B>(java.util.Map filesToProcess,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)</CODE>
<BR>
<B>Deprecated.</B> <I>since 1.1.2, use <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><CODE>render(Map, File, DocumentModel, DocumentRendererContext)</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel, org.apache.maven.doxia.docrenderer.DocumentRendererContext)">render</A></B>(java.util.Map filesToProcess,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)</CODE>
<BR>
Render an aggregate document from the files found in a Map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#renderIndividual(java.util.Map, java.io.File)">renderIndividual</A></B>(java.util.Map filesToProcess,
java.io.File outputDirectory)</CODE>
<BR>
<B>Deprecated.</B> <I>since 1.1.2, use <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#renderIndividual(java.util.Map, java.io.File, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><CODE>renderIndividual(Map, File, DocumentRendererContext)</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#renderIndividual(java.util.Map, java.io.File, org.apache.maven.doxia.docrenderer.DocumentRendererContext)">renderIndividual</A></B>(java.util.Map filesToProcess,
java.io.File outputDirectory,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)</CODE>
<BR>
Render documents separately for each file found in a Map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#setBaseDir(java.lang.String)">setBaseDir</A></B>(java.lang.String newDir)</CODE>
<BR>
Sets the current base directory.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.codehaus.plexus.logging.AbstractLogEnabled"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>enableLogging, getLogger, setupLogger, setupLogger, setupLogger</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.maven.doxia.docrenderer.DocumentRenderer"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.maven.doxia.docrenderer.<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#getOutputExtension()">getOutputExtension</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="siteModuleManager"><!-- --></A><H3>
siteModuleManager</H3>
<PRE>
protected org.apache.maven.doxia.module.site.manager.SiteModuleManager <B>siteModuleManager</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="doxia"><!-- --></A><H3>
doxia</H3>
<PRE>
protected org.apache.maven.doxia.Doxia <B>doxia</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AbstractDocumentRenderer()"><!-- --></A><H3>
AbstractDocumentRenderer</H3>
<PRE>
public <B>AbstractDocumentRenderer</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><!-- --></A><H3>
render</H3>
<PRE>
public abstract void <B>render</B>(java.util.Map filesToProcess,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD><B>Deprecated.</B> <I>since 1.1.2, use <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><CODE>render(Map, File, DocumentModel, DocumentRendererContext)</CODE></A></I>
<P>
<DD>Render an aggregate document from the files found in a Map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filesToProcess</CODE> - the Map of Files to process. The Map should contain as keys the paths of the
source files (relative to <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()"><CODE>baseDir</CODE></A>), and the corresponding SiteModule as values.<DD><CODE>outputDirectory</CODE> - the output directory where the aggregate document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any</DL>
</DD>
</DL>
<HR>
<A NAME="render(java.util.Collection, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(java.util.Collection files,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from a set of files, depending on a rendering context.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#render(java.util.Collection, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>files</CODE> - the path name Strings (relative to a common base directory)
of files to include in the document generation.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files from the Collection of files will be processed.
If the model is null, render all files individually.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any.
<DD><CODE>java.io.IOException</CODE> - if any.</DL>
</DD>
</DL>
<HR>
<A NAME="render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(java.io.File baseDirectory,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from the files found in a source directory, depending on a rendering context.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)">render</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDirectory</CODE> - the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files found under baseDirectory will be processed.
If the model is null, render all files from baseDirectory individually.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any
// * @deprecated since 1.1.2, use <CODE>#render(File, File, DocumentModel, DocumentRendererContext)</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(java.util.Map filesToProcess,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render an aggregate document from the files found in a Map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filesToProcess</CODE> - the Map of Files to process. The Map should contain as keys the paths of the
source files (relative to <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()"><CODE>baseDir</CODE></A>), and the corresponding SiteModule as values.<DD><CODE>outputDirectory</CODE> - the output directory where the aggregate document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.<DD><CODE>context</CODE> - the rendering context when processing files.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any</DL>
</DD>
</DL>
<HR>
<A NAME="render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(java.io.File baseDirectory,
java.io.File outputDirectory,
org.apache.maven.doxia.document.DocumentModel documentModel,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from the files found in a source directory, depending on a rendering context.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDirectory</CODE> - the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.<DD><CODE>documentModel</CODE> - the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files found under baseDirectory will be processed.
If the model is null, render all files from baseDirectory individually.<DD><CODE>context</CODE> - the rendering context when processing files.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any<DT><B>Since:</B></DT>
<DD>1.1.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="render(java.io.File, java.io.File)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(java.io.File baseDirectory,
java.io.File outputDirectory)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from the files found in baseDirectory. This just forwards to
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><CODE>render(File,File,DocumentModel)</CODE></A> with a new DocumentModel.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDirectory</CODE> - the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><CODE>render(File, File, DocumentModel)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="render(java.io.File, java.io.File, java.io.File)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(java.io.File baseDirectory,
java.io.File outputDirectory,
java.io.File documentDescriptor)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render a document from the files found in baseDirectory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDirectory</CODE> - the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.<DD><CODE>outputDirectory</CODE> - the output directory where the document should be generated.<DD><CODE>documentDescriptor</CODE> - a file containing the document model.
If this file does not exist or is null, some default settings will be used.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.io.File, java.io.File)"><CODE>if documentDescriptor does not exist or is null</CODE></A>,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#render(java.util.Map, java.io.File, org.apache.maven.doxia.document.DocumentModel)"><CODE>otherwise</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="renderIndividual(java.util.Map, java.io.File)"><!-- --></A><H3>
renderIndividual</H3>
<PRE>
public void <B>renderIndividual</B>(java.util.Map filesToProcess,
java.io.File outputDirectory)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD><B>Deprecated.</B> <I>since 1.1.2, use <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#renderIndividual(java.util.Map, java.io.File, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><CODE>renderIndividual(Map, File, DocumentRendererContext)</CODE></A></I>
<P>
<DD>Render documents separately for each file found in a Map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filesToProcess</CODE> - the Map of Files to process. The Map should contain as keys the paths of the
source files (relative to <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()"><CODE>baseDir</CODE></A>), and the corresponding SiteModule as values.<DD><CODE>outputDirectory</CODE> - the output directory where the documents should be generated.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any<DT><B>Since:</B></DT>
<DD>1.1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="renderIndividual(java.util.Map, java.io.File, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><!-- --></A><H3>
renderIndividual</H3>
<PRE>
public void <B>renderIndividual</B>(java.util.Map filesToProcess,
java.io.File outputDirectory,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Render documents separately for each file found in a Map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filesToProcess</CODE> - the Map of Files to process. The Map should contain as keys the paths of the
source files (relative to <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()"><CODE>baseDir</CODE></A>), and the corresponding SiteModule as values.<DD><CODE>outputDirectory</CODE> - the output directory where the documents should be generated.<DD><CODE>context</CODE> - the rendering context.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any<DT><B>Since:</B></DT>
<DD>1.1.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getFilesToProcess(java.io.File)"><!-- --></A><H3>
getFilesToProcess</H3>
<PRE>
public java.util.Map <B>getFilesToProcess</B>(java.io.File baseDirectory)
throws java.io.IOException,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></PRE>
<DL>
<DD>Returns a Map of files to process. The Map contains as keys the paths of the source files
(relative to <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()"><CODE>baseDir</CODE></A>), and the corresponding SiteModule as values.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDirectory</CODE> - the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.
<DT><B>Returns:</B><DD>a Map of files to process.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - in case of a problem reading the files under baseDirectory.
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any</DL>
</DD>
</DL>
<HR>
<A NAME="getFilesToProcess(java.util.Collection)"><!-- --></A><H3>
getFilesToProcess</H3>
<PRE>
public java.util.Map <B>getFilesToProcess</B>(java.util.Collection files)</PRE>
<DL>
<DD>Returns a Map of files to process. The Map contains as keys the paths of the source files
(relative to <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#getBaseDir()"><CODE>baseDir</CODE></A>), and the corresponding SiteModule as values.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>files</CODE> - The Collection of source files.
<DT><B>Returns:</B><DD>a Map of files to process.</DL>
</DD>
</DL>
<HR>
<A NAME="readDocumentModel(java.io.File)"><!-- --></A><H3>
readDocumentModel</H3>
<PRE>
public org.apache.maven.doxia.document.DocumentModel <B>readDocumentModel</B>(java.io.File documentDescriptor)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Read a document model from a file.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#readDocumentModel(java.io.File)">readDocumentModel</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html" title="interface in org.apache.maven.doxia.docrenderer">DocumentRenderer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>documentDescriptor</CODE> - a document descriptor file that contains the document model.
<DT><B>Returns:</B><DD>the document model, containing all the metadata, etc.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - if any
<DD><CODE>java.io.IOException</CODE> - if any</DL>
</DD>
</DL>
<HR>
<A NAME="setBaseDir(java.lang.String)"><!-- --></A><H3>
setBaseDir</H3>
<PRE>
public void <B>setBaseDir</B>(java.lang.String newDir)</PRE>
<DL>
<DD>Sets the current base directory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newDir</CODE> - the absolute path to the base directory to set.</DL>
</DD>
</DL>
<HR>
<A NAME="getBaseDir()"><!-- --></A><H3>
getBaseDir</H3>
<PRE>
public java.lang.String <B>getBaseDir</B>()</PRE>
<DL>
<DD>Return the current base directory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the current base directory.</DL>
</DD>
</DL>
<HR>
<A NAME="parse(java.lang.String, java.lang.String, org.apache.maven.doxia.sink.Sink)"><!-- --></A><H3>
parse</H3>
<PRE>
protected void <B>parse</B>(java.lang.String fullDocPath,
java.lang.String parserId,
org.apache.maven.doxia.sink.Sink sink)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD><B>Deprecated.</B> <I>since 1.1.2, use <A HREF="../../../../../org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#parse(java.lang.String, java.lang.String, org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><CODE>parse(String, String, Sink, DocumentRendererContext)</CODE></A></I>
<P>
<DD>Parse a source document into a sink.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fullDocPath</CODE> - absolute path to the source document.<DD><CODE>parserId</CODE> - determines the parser to use.<DD><CODE>sink</CODE> - the sink to receive the events.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - in case of a parsing error.
<DD><CODE>java.io.IOException</CODE> - if the source document cannot be opened.</DL>
</DD>
</DL>
<HR>
<A NAME="parse(java.lang.String, java.lang.String, org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.docrenderer.DocumentRendererContext)"><!-- --></A><H3>
parse</H3>
<PRE>
protected void <B>parse</B>(java.lang.String fullDocPath,
java.lang.String parserId,
org.apache.maven.doxia.sink.Sink sink,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererContext.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererContext</A> context)
throws <A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A>,
java.io.IOException</PRE>
<DL>
<DD>Parse a source document into a sink.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fullDocPath</CODE> - absolute path to the source document.<DD><CODE>parserId</CODE> - determines the parser to use.<DD><CODE>sink</CODE> - the sink to receive the events.<DD><CODE>context</CODE> - the rendering context.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRendererException.html" title="class in org.apache.maven.doxia.docrenderer">DocumentRendererException</A></CODE> - in case of a parsing error.
<DD><CODE>java.io.IOException</CODE> - if the source document cannot be opened.</DL>
</DD>
</DL>
<HR>
<A NAME="copyResources(java.io.File)"><!-- --></A><H3>
copyResources</H3>
<PRE>
protected void <B>copyResources</B>(java.io.File outputDirectory)
throws java.io.IOException</PRE>
<DL>
<DD>Copies the contents of the resource directory to an output folder.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>outputDirectory</CODE> - the destination folder.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if any.</DL>
</DD>
</DL>
<HR>
<A NAME="copyDirectory(java.io.File, java.io.File)"><!-- --></A><H3>
copyDirectory</H3>
<PRE>
protected void <B>copyDirectory</B>(java.io.File source,
java.io.File destination)
throws java.io.IOException</PRE>
<DL>
<DD>Copy content of a directory, excluding scm-specific files.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - directory that contains the files and sub-directories to be copied.<DD><CODE>destination</CODE> - destination folder.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if any.</DL>
</DD>
</DL>
<HR>
<A NAME="getOutputName(org.apache.maven.doxia.document.DocumentModel)"><!-- --></A><H3>
getOutputName</H3>
<PRE>
protected java.lang.String <B>getOutputName</B>(org.apache.maven.doxia.document.DocumentModel documentModel)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>documentModel</CODE> - not null
<DT><B>Returns:</B><DD>the output name defined in the documentModel without the output extension. If the output name is not
defined, return target by default.<DT><B>Since:</B></DT>
<DD>1.1.1</DD>
<DT><B>See Also:</B><DD><CODE>DocumentModel.getOutputName()</CODE>,
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocumentRenderer.html#getOutputExtension()"><CODE>DocumentRenderer.getOutputExtension()</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDocumentRenderer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../org/apache/maven/doxia/docrenderer/DocRenderer.html" title="interface in org.apache.maven.doxia.docrenderer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractDocumentRenderer.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2005-2011. All Rights Reserved.
</BODY>
</HTML>
|