added top level HTML navigation page for documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@19582 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
arobert 2004-06-22 22:15:06 +00:00
parent e926ec6994
commit 6255bcadf0
5 changed files with 200 additions and 1 deletions

View file

@ -0,0 +1,11 @@
The files here get installed into
'$GNUSTEP_SYSTEM_ROOT/Library/Documentation'. They provide a simple means for
the user to navigate through the various GNUstep documentation that gets
installed there. It includes links for the GUI documentation, which may not
necessarily be installed, but it points out that the links might not work.
This approach seemed better than maintaining two separate index files for GUI
and Base.
If you add documentation, you should also add links to it to these HTML files.

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

View file

@ -0,0 +1,104 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dli"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>GNUstep System Documentation</title>
<link type="text/css" href="style.css" rel="stylesheet"/>
<meta content="text/html; charset=UTF-8" http-equiv="Content-type"/>
</head>
<body>
<div class="header" align="center">
<a href="http://gnustep.org/"><img height="72" width="560" alt="GNUstep.org" src="gnustep-header.png"/></a>
</div>
<div class="container">
<div class="content">
<h2>GNUstep System Documentation</h2>
<p>
This is the system documentation for GNUstep, including both user
and developer documentation. GNUstep provides an object-oriented
application framework and tool set for use on a wide variety of
computer platforms. It is based on the original OpenStep
specification created by NeXT, Inc. (now Apple). (<a
href="http://gnustep.org/">Web site</a>)
</p>
<div style="clear: both;"></div>
</div>
<div class="content">
<h2>User Documentation</h2>
<table><tr>
<td width="50%">
<ul>
<li><a href="User/GNUstep/faq_toc.html">General FAQ</a></li>
<li><a href="User/GNUstep/userfaq_toc.html">User FAQ</a></li>
<li><a href="User/GNUstep/gnustep-howto_toc.html">How-To</a></li>
<li><a href="User/GNUstep/filesystem_toc.html">Filesystem Layout</a></li>
</ul>
</td>
<td width="50%">
The following links will work only if you have installed the GUI
portion of GNUstep.
<ul>
<li><a href="User/Gui/DefaultsSummary.html">User Defaults Summary</a></li>
<li><a href="User/Gui/KeyboardSetup.html">User Keyboard Setup</a></li>
<li><a href="User/Gui/LanguageSetup.html">Setup for East Asian Languages</a></li>
</ul>
</td>
</tr></table>
</div>
<div class="content">
<h2>Developer Documentation</h2>
<table><tr>
<td width="50%">
<ul>
<li><a href="Developer/Base/ProgrammingManual/manual_toc.html">GNUstep Programming Manual</a></li>
<li><a href="Developer/Make/Manual/make_toc.html">GNUstep Make Utility</a>&nbsp;&nbsp;(<a href="Developer/Make/ReleaseNotes/">Release notes</a>)</li>
<li><a href="Developer/Tools/Reference/index.html">Command-line Tools Documentation</a></li>
</ul>
<br/>
<ul>
<li><a href="Developer/Base/Reference/index.html">Base (Foundation) Library API</a>&nbsp;&nbsp;(<a href="Developer/Base/ReleaseNotes/ReleaseNotes.html">Release notes</a>)</li>
<li><a href="Developer/BaseAdditions/Reference/index.html">Base Additions Library API</a></li>
</ul>
<br/>
<ul>
<li><a href="Developer/Base/General/OpenStepCompliance.html">OpenStep and OS X Compliance
</a></li>
<li><a href="Developer/CodingStandards/coding-standards_toc.html">GNUstep Coding Standards</a></li>
<li><a href="Developer/Base/General/Debugging.html">Debugging Information</a></li>
</ul>
</td>
<td width="50%">
The following links will work only if you have installed the GUI
portion of GNUstep.
<ul>
<li><a href="Developer/Gui/ProgrammingManual/manual_toc.html">GUI Programming Manual</a></li>
</ul>
<br/>
<ul>
<li><a href="Developer/Gui/Reference/index.html">GUI (AppKit) Library API</a>&nbsp;&nbsp;(<a href="Developer/Gui/ReleaseNotes/ReleaseNotes.html">Release notes</a>)</li>
<li><a href="Developer/Gui/Additions/index.html">GUI Additions Library API</a></li>
</ul>
</td>
</tr></table>
</div>
<div class="content">
<h2>Development Tools</h2>
<p>
<a href="http://gnustep.org/experience/ProjectCenter.html">Project Center</a> provides an integrated development environment (IDE) for GNUstep.
<a href="http://gnustep.org/experience/Gorm.html">Gorm</a> is a
graphical user interface construction tool. Using these, developers
can quickly design and build cross-platform applications in
Objective-C or Java.
</p>
<br/><br/>
</div>
</div>
</body>
</html>

View file

@ -0,0 +1,74 @@
*{padding:0;margin:0;border:0;}
body
{
background: #fff;
color: #282931;
background: #fff;
font-family: "Trebuchet MS", Trebuchet, Tahoma, sans-serif;
font-size: 10pt;
margin: 0px;
padding: 0px;
}
a { color: #37425f; }
a:link { color: #37425f; }
a:visited { color: #37425f; }
a:hover { color: black; }
h1 { font-size: 20pt; font-weight: 900; }
h2 { font-size: 16pt; font-weight: bold; }
h3 { font-size: 16pt; font-weight: normal; }
h4 { font-size: 12pt; font-weight: bold; }
h1,h2,h3,h4 {
margin-top: 0px;
margin-bottom: 3pt;
padding-top: 10pt;
}
.floatright
{
float: right;
}
.floatleft
{
float: left;
}
/* #424f6f; */
.header
{
height: 72px;
background-color: #3f4c6c;
margin: 0px 100px 0px 100px;
}
.header img
{
display: block;
border: 0px;
}
.container
{
margin: 0px 100px 0px 100px;
border-left: 1px dashed #282931;
border-right: 1px dashed #282931;
}
.content
{
padding: 5pt 5pt;
border-bottom: 1pt solid #e8e8e8;
}
.content * {
line-height: 18pt;
}
ul,ol { margin-left: 14pt; }
blockquote { margin: 6pt; padding: 0 6pt; border-left: 3px solid #ccc; }

View file

@ -50,24 +50,32 @@ endif
# Things to do before installing
# before-install::
# Install the library reference documentaion manually
# Install the library reference documentation manually
#
after-install::
ifeq ($(HAVE_LIBXML),1)
rm -rf $(REF_DOC_INSTALL_DIR)/Base/Reference
rm -rf $(REF_DOC_INSTALL_DIR)/BaseAdditions/Reference
rm -rf $(REF_DOC_INSTALL_DIR)/Tools/Reference
$(MKDIRS) $(REF_DOC_INSTALL_DIR)/Base/Reference
$(MKDIRS) $(REF_DOC_INSTALL_DIR)/BaseAdditions/Reference
$(MKDIRS) $(REF_DOC_INSTALL_DIR)/Tools/Reference
(cd Base; $(TAR) cf - .) | \
(cd $(REF_DOC_INSTALL_DIR)/Base/Reference; $(TAR) xf -)
(cd BaseAdditions; $(TAR) cf - .) | \
(cd $(REF_DOC_INSTALL_DIR)/BaseAdditions/Reference; $(TAR) xf -)
(cd BaseTools; $(TAR) cf - .) | \
(cd $(REF_DOC_INSTALL_DIR)/Tools/Reference; $(TAR) xf -)
ifneq ($(CHOWN_TO),)
$(CHOWN) -R $(CHOWN_TO) \
$(REF_DOC_INSTALL_DIR/Base)
$(REF_DOC_INSTALL_DIR/BaseAdditions)
$(REF_DOC_INSTALL_DIR/Tools)
endif
endif
cp -f HtmlNav/index.html $(REF_DOC_INSTALL_DIR)/..
cp -f HtmlNav/style.css $(REF_DOC_INSTALL_DIR)/..
cp -f HtmlNav/gnustep-header.png $(REF_DOC_INSTALL_DIR)/..
# Things to do before uninstalling
@ -84,9 +92,11 @@ after-uninstall::
after-clean::
ifeq ($(HAVE_LIBXML),1)
$(MAKE) -C ../Source -f DocMakefile clean
$(MAKE) -C ../Tools -f DocMakefile clean
endif
rm -rf Base
rm -rf BaseAdditions
rm -rf BaseTools
# Things to do before distcleaning
# before-distclean::