TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> I skimmed Sun's FAQ but couldn't find info on how to populate
> the top-right
> header (for API identification) and first two lines under the
> header of
> overview-summary.html
For the top-right header, use the -header option when you compile javadoc.
You can use HTML formatting. For the overview text, use the -overview
option and specify an HTML file you want to import. You'll need to put that
file in every directory for which you want an overview. It must be named
the same in each directory. Example:
REM Set the header & footer -- VERSION/COPYRIGHT/ID INFO
SET HEADER="<b>Your_product </b><font size='-1'>v4.5</font><br><font
size='-1'><a href='http://www.your_product.com'
target='_top'>www.your_product.com</a></font>"
SET FOOTER="<b>Your_product </b><font size='-1'>v4.5</font><br><font
size='-1'>"
SET BOTTOM="<font size='-2'>Copyright 2001 Your Company</font>"
REM the javadoc directory must exist - create it if it doesn't
IF NOT EXIST javadoc md javadoc
REM Run the command with options
javadoc -windowtitle "Your_product Java API" -d javadoc -header %HEADER%
-bottom %BOTTOM% -footer %FOOTER% -overview overview.html -stylesheetfile
ontosjdoc.css -nodeprecatedlist -doctitle "Your_product JavaDoc" -classpath
"%jars%" com.your_product.dsl.base com.your_product.dsl.objs
com.your_product.rts
For full-text search, you just need something that'll search straight HTML
-- maybe others can suggest products.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
