--- /dev/null
+<!--
+@LIBRARY=SILC Client Library
+@FILENAME=silcclient.html
+-->
+
+<OL>
+<FONT SIZE="+3">SILC Client Library</FONT><BR><BR>
+<FONT SIZE="+1" COLOR="#000044"><B>Introduction</B></FONT><BR><BR>
+<PRE>
+SILC Client Library is SILC Client implementation without the actual user
+interface. The library uses common and core components of SILC protocol from
+lib/silccore library and normal utility routines from lib/silcutil library.
+The library has been designed to be complete SILC Client implementation
+without actual user interface. The library provides the API for the
+application which it can use to implement generally whatever user interface
+it wants.
+
+The `silcapi.h' file defines the function prototypes that application must
+implement in order to be able to create the user interface with the
+library. The idea is that the application can implement whatever user
+interface routines in the functions and display the data whatever way
+it wants. The library is entirely transparent to the user interface and
+it does not include any user interface specific issues such as window
+handling or item handling on the screen etc. These does not interest
+the library.
+</PRE>
+
+<LI><A HREF="silcapi.html">SILC Client API</A>
+</OL>
--- /dev/null
+<!--
+@LIBRARY=SILC Core Library
+@FILENAME=silccore.html
+-->
+
+<OL>
+<FONT SIZE="+3">SILC Core Library</FONT><BR><BR>
+<FONT SIZE="+1" COLOR="#000044"><B>Introduction</B></FONT><BR><BR>
+<PRE>
+SILC Core Library includes all the core components of the SILC Protocol.
+It provides routines to encode and decode all SILC packet payloads defined
+in the protocol specification. It provides packet assembling and parsing
+routines, and routines for sending private message and channel messages.
+</PRE>
+
+<LI><A HREF="silcauth.html">SILC Auth API</A>
+<LI><A HREF="silcchannel.html">SILC Channel API</A>
+<LI><A HREF="silccomand.html">SILC Command API</A>
+<LI><A HREF="silcid.html">SILC ID API</A>
+<LI><A HREF="silcidcache.html">SILC ID Cache API</A>
+<LI><A HREF="silcmode.html">SILC Modes</A>
+<LI><A HREF="silcnotify.html">SILC Notify API</A>
+<LI><A HREF="silcpacket.html">SILC Packet API</A>
+<LI><A HREF="silcpayload.html">SILC Payload API</A>
+<LI><A HREF="silcprivate.html">SILC Private API</A>
+<LI><A HREF="silcprotocol.html">SILC Protocol API</A>
+</OL>
mkdir /tmp/silcdoc.html
cp $headers /tmp/silcdoc.html
+ # Generate the actual detailed documentation
path=`pwd`
cd /tmp/silcdoc.html
headers=`find . -name "silc*.h" |cut -d/ -f2 |cut -d. -f1`
sh gen.sh index.php $DST/$i.html $DST/$i.html
# Generate the details and the layour
- files=`find $DST -name "$i_*.html"`
+ files=`find $DST -name ""$i"_*.html"`
for k in $files
do
sh gen.sh gen_detail.php $k $k
rm -f $DST/$i_index.tmpl
done
+ # Generate the index and TOC files from the DIRECTORY files
+ files=`find $SRC -name "DIRECTORY"`
+ index=`find $SRC -name "INDEX"`
+ cat $index >$DST/index.html
+ for i in $files
+ do
+ # Get library name
+ name=`grep $i "@LIBRARY=" |cut -d= -f2`
+ fname=`grep $i "@FILENAME" |cut -d= -f2`
+
+ # Generate the TOC file for the library
+ sh gen.sh gen_toc.php $i $DST/$fname
+ sh gen.sh index.php $DST/$fname $DST/$fname
+
+ # Generate the link for the top index.html for this library
+ echo "<LI><A HREF="$fname">$name</A>" >>$DST/index.html
+ done
+
+ # Generate the top index.html file
+ sh gen.sh gen_toc.php $DST/index.html $DST/index.html
+ sh gen.sh index.php $DST/index.html $DST/index.html
+
rm -rf /tmp/silcdoc.html
fi
if (item_attributes[item_type] & TEXT_BODY_SHINE)
fprintf (dest_doc, format_str,
att_start_command[MAKE_SHINE][output_mode]);
+ if (item_attributes[item_type] & TEXT_BODY_DEFAULT)
+ fprintf (dest_doc, format_str,
+ att_start_command[MAKE_DEFAULT][output_mode]);
/*
* For some modes, the text body is always non-prop
if (item_attributes[item_type] & TEXT_BODY_LARGE_FONT)
fprintf (dest_doc, format_str,
att_stop_command[MAKE_LARGE][output_mode]);
+ if (item_attributes[item_type] & TEXT_BODY_DEFAULT)
+ fprintf (dest_doc, format_str,
+ att_stop_command[MAKE_DEFAULT][output_mode]);
if (output_mode != HTML)
{
ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* SYNOPSIS_ITEM */
ITEM_NAME_LARGE_FONT, /* USAGE_ITEM */
ITEM_NAME_LARGE_FONT, /* FUNCTION_ITEM */
- ITEM_NAME_LARGE_FONT, /* DESCRIPTION_ITEM */
+ ITEM_NAME_LARGE_FONT | TEXT_BODY_DEFAULT, /* DESCRIPTION_ITEM */
ITEM_NAME_LARGE_FONT, /* PURPOSE_ITEM */
ITEM_NAME_LARGE_FONT | TEXT_BODY_BOLD, /* AUTHOR_ITEM */
ITEM_NAME_LARGE_FONT | TEXT_BODY_BOLD, /* CREATION_DATE_ITEM */
ITEM_NAME_LARGE_FONT, /* IDEAS_ITEM */
ITEM_NAME_LARGE_FONT, /* PORTABILITY_ITEM */
ITEM_NAME_LARGE_FONT, /* SEE_ALSO_ITEM */
- ITEM_NAME_LARGE_FONT, /* SOURCE_ITEM */
+ ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* SOURCE_ITEM */
ITEM_NAME_LARGE_FONT, /* METHODS_ITEM */
ITEM_NAME_LARGE_FONT, /* NEW_METHODS_ITEM */
ITEM_NAME_LARGE_FONT, /* ATTRIBUTES_ITEM */
{
/* "NORMAL", */
"LARGE", "ITALICS", "NONPROP", "SMALL", "BOLD",
- "UNDERLINE", "SHINE", "HIGHLIGHT"
+ "UNDERLINE", "SHINE", "HIGHLIGHT", "DEFAULT",
};
/*************/
char *att_start_command[SIZE_ATTRIBUTES][SIZE_MODES] =
{
- {"", "@{b}", "<FONT SIZE=\"+1\">", "{\\large ", "\\par\\fs28 "},
- /* Large Font */
+ {"", "@{b}", "<FONT SIZE=\"+1\">", "{\\large ", "\\par\\fs28 "}, /* Large Font */
{"", "@{i}", "<I>", "{\\it ", "\\i1 "}, /* Italics. */
{"", "", "", "", ""}, /* NON-Proportional font. */
{"", "", "<SMALL>", "{\\small ", "\\fs16 "}, /* Small Font. */
{"", "@{b}", "<B>", "{\\bf ", "\\b1 "}, /* Bold. */
{"", "@{u}", "<U>", "\\underline{", "\\ul1 "}, /* Underline */
{"", "@{fg shine}", "<FONT FACE=\"courier\" size=\"3\">", "{\\em ", ""},/* Shine */
- {"", "@{fg highlight}", "<EM>", "{\\em ", ""} /* Highlight */
+ {"", "@{fg highlight}", "<EM>", "{\\em ", ""}, /* Highlight */
+ {"", "", "<FONT FACE=\"Helvetiva,Arial,Sans-serif\">", "", ""} /* Default */
};
char *att_stop_command[SIZE_ATTRIBUTES][SIZE_MODES] =
{"", "@{ub}", "</B>", "}", "\\b0 "}, /* Bold. */
{"", "@{uu}", "</U>", "}", "\\ul0 "}, /* Underline */
{"", "@{fg text}", "</FONT>", "}", ""}, /* Shine */
- {"", "@{fg text}", "</EM>", "}", ""} /* Highlight */
+ {"", "@{fg text}", "</EM>", "}", ""}, /* Highlight */
+ {"", "", "</FONT>", "", ""} /* Normal */
};
enum
{
MAKE_NORMAL = -1, MAKE_LARGE, MAKE_ITALICS, MAKE_NON_PROP, MAKE_SMALL,
- MAKE_BOLD, MAKE_UNDERLINE, MAKE_SHINE, MAKE_HIGH, SIZE_ATTRIBUTES
+ MAKE_BOLD, MAKE_UNDERLINE, MAKE_SHINE, MAKE_HIGH, MAKE_DEFAULT,
+ SIZE_ATTRIBUTES
};
#define ITEM_NAME_LARGE_FONT (1<<0)
#define TEXT_BODY_UNDERLINE (1<<(MAKE_UNDERLINE + 1))
#define TEXT_BODY_SHINE (1<<(MAKE_SHINE + 1))
#define TEXT_BODY_HIGHLIGHT (1<<(MAKE_HIGH + 1))
+#define TEXT_BODY_DEFAULT (1<<(MAKE_DEFAULT + 1))
/****** ROBODoc/ItemTypes *
projects / crypto.git / commitdiff