7 /****v* ROBODoc/item_names [3.0g]
13 * Defines the names of items that ROBODoc recognized as
14 * items. For each name their is a corresponding
15 * item type (see ItemType). So if you add a name here
16 * you have to add an item type to. In addition you
17 * have to add an item attribute (see item_attributes)
22 * RB_Get_Item_Type(), item_attributes, item_attr_names,
30 /* Item name + short description */
32 /* who own the copyright : "(c) <year>-<year> by <company/person>" */
35 "FUNCTION", "DESCRIPTION", "PURPOSE",
40 /* when did the work start */
41 "MODIFICATION HISTORY", "HISTORY",
42 /* who done what changes when */
43 "INPUTS", "ARGUMENTS", "OPTIONS", "PARAMETERS", "SWITCHES",
44 /* what can we feed into it */
45 "OUTPUT", "SIDE EFFECTS",
46 /* what output will be made */
47 "RESULT", "RETURN VALUE",
48 /* what do we get returned */
50 /* a clear example of the items use */
54 /* diagnostical output */
56 /* warning & error-messages */
60 /* what to implement next & ideas */
62 /* where does it come from, where will it work */
66 /* source code inclusion */
67 "METHODS", "NEW METHODS",
69 "ATTRIBUTES", "NEW ATTRIBUTES",
72 /* tagitem description */
74 /* command description */
80 /* what modules are used by this one */
82 /* which modules do use this */
89 /****v* ROBODoc/item_attributes [3.0h]
91 * item_attributes -- attributes of the various items
93 * links each item type with a text attribute.
95 * RB_Get_Item_Type(), item_names, item_attr_names
99 long item_attributes[NUMBER_OF_ITEMS] =
102 ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* NAME_ITEM */
103 ITEM_NAME_LARGE_FONT, /* COPYRIGHT_ITEM */
104 ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* SYNOPSIS_ITEM */
105 ITEM_NAME_LARGE_FONT, /* USAGE_ITEM */
106 ITEM_NAME_LARGE_FONT, /* FUNCTION_ITEM */
107 ITEM_NAME_LARGE_FONT | TEXT_BODY_DEFAULT, /* DESCRIPTION_ITEM */
108 ITEM_NAME_LARGE_FONT, /* PURPOSE_ITEM */
109 ITEM_NAME_LARGE_FONT | TEXT_BODY_BOLD, /* AUTHOR_ITEM */
110 ITEM_NAME_LARGE_FONT | TEXT_BODY_BOLD, /* CREATION_DATE_ITEM */
111 ITEM_NAME_LARGE_FONT, /* MODIFICATION_HISTORY_ITEM */
112 ITEM_NAME_LARGE_FONT, /* HISTORY_ITEM */
113 ITEM_NAME_LARGE_FONT, /* INPUT_ITEM */
114 ITEM_NAME_LARGE_FONT, /* ARGUMENT_ITEM */
115 ITEM_NAME_LARGE_FONT, /* OPTION_ITEM */
116 ITEM_NAME_LARGE_FONT, /* PARAMETER_ITEM */
117 ITEM_NAME_LARGE_FONT, /* SWITCH_ITEM */
118 ITEM_NAME_LARGE_FONT, /* OUTPUT_ITEM */
119 ITEM_NAME_LARGE_FONT, /* SIDE_EFFECTS_ITEM */
120 ITEM_NAME_LARGE_FONT, /* RESULT_ITEM */
121 ITEM_NAME_LARGE_FONT, /* RETURN_VALUE_ITEM */
122 ITEM_NAME_LARGE_FONT, /* EXAMPLE_ITEM */
123 ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* NOTE_ITEM */
124 ITEM_NAME_LARGE_FONT, /* DIAGNOSTICS_ITEM */
125 ITEM_NAME_LARGE_FONT, /* WARNING_ITEM */
126 ITEM_NAME_LARGE_FONT, /* ERROR_ITEM */
127 ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* BUGS_ITEM */
128 ITEM_NAME_LARGE_FONT, /* TODO_ITEM */
129 ITEM_NAME_LARGE_FONT, /* IDEAS_ITEM */
130 ITEM_NAME_LARGE_FONT, /* PORTABILITY_ITEM */
131 ITEM_NAME_LARGE_FONT, /* SEE_ALSO_ITEM */
132 ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* SOURCE_ITEM */
133 ITEM_NAME_LARGE_FONT, /* METHODS_ITEM */
134 ITEM_NAME_LARGE_FONT, /* NEW_METHODS_ITEM */
135 ITEM_NAME_LARGE_FONT, /* ATTRIBUTES_ITEM */
136 ITEM_NAME_LARGE_FONT, /* NEW_ATTRIBUTES_ITEM */
137 ITEM_NAME_LARGE_FONT, /* TAGS_ITEM */
138 ITEM_NAME_LARGE_FONT, /* COMMANDS_ITEM */
139 ITEM_NAME_LARGE_FONT, /* DERIVED_FROM_ITEM */
140 ITEM_NAME_LARGE_FONT, /* DERIVED_BY_ITEM */
141 ITEM_NAME_LARGE_FONT, /* USES_ITEM */
142 ITEM_NAME_LARGE_FONT, /* CHILDREN */
143 ITEM_NAME_LARGE_FONT, /* USED_BY_ITEM */
144 ITEM_NAME_LARGE_FONT, /* PARENTS */
151 /****v* ROBODoc/item_attr_names [3.0j]
155 * char *item_attr_names[]
157 * used for strcmp() in RB_Get_Item_Attr()
161 * RB_Get_Item_Attr(), item_attributes, item_names
165 char *item_attr_names[] =
168 "LARGE", "ITALICS", "NONPROP", "SMALL", "BOLD",
169 "UNDERLINE", "SHINE", "HIGHLIGHT", "DEFAULT",
175 /* ASCII AMIGAGUIDE HTML LATEX RTF */
177 char *att_start_command[SIZE_ATTRIBUTES][SIZE_MODES] =
179 {"", "@{b}", "<FONT SIZE=\"+1\">", "{\\large ", "\\par\\fs28 "}, /* Large Font */
180 {"", "@{i}", "<I>", "{\\it ", "\\i1 "}, /* Italics. */
181 {"", "", "", "", ""}, /* NON-Proportional font. */
182 {"", "", "<SMALL>", "{\\small ", "\\fs16 "}, /* Small Font. */
183 {"", "@{b}", "<B>", "{\\bf ", "\\b1 "}, /* Bold. */
184 {"", "@{u}", "<U>", "\\underline{", "\\ul1 "}, /* Underline */
185 {"", "@{fg shine}", "<FONT FACE=\"courier\" size=\"3\">", "{\\em ", ""},/* Shine */
186 {"", "@{fg highlight}", "<EM>", "{\\em ", ""}, /* Highlight */
187 {"", "", "<FONT FACE=\"Helvetiva,Arial,Sans-serif\">", "", ""} /* Default */
190 char *att_stop_command[SIZE_ATTRIBUTES][SIZE_MODES] =
192 {"", "@{ub}", "</FONT>", "}", "\\fs20\\line "}, /* Large Font */
193 {"", "@{ui}", "</I>", "}", "\\i0 "}, /* Italics. */
194 {"", "", "", "", ""}, /* NON-Proportional font. */
195 {"", "", "</SMALL>", "}", "\\fs20 "}, /* Small Font. */
196 {"", "@{ub}", "</B>", "}", "\\b0 "}, /* Bold. */
197 {"", "@{uu}", "</U>", "}", "\\ul0 "}, /* Underline */
198 {"", "@{fg text}", "</FONT>", "}", ""}, /* Shine */
199 {"", "@{fg text}", "</EM>", "}", ""}, /* Highlight */
200 {"", "", "</FONT>", "", ""} /* Normal */
205 /****f* ROBODoc/RB_Get_Item_Type [3.0b]
207 * RB_Get_Item_Type -- shortcut
209 * int RB_Get_Item_Type( char *cmp_name )
211 * return the item_type represented by the given string
213 * char *cmp_name -- item_name to evaluate
215 * int -- the right item_type or NO_ITEM
217 * uses global char *item_names[]
221 * RB_Analyse_Defaults_File(), RB_Get_Item_Attr()
226 RB_Get_Item_Type (char *cmp_name)
230 for (item_type = NAME_ITEM; item_type < OTHER_ITEM; ++item_type)
232 if (!strncmp (item_names[item_type], cmp_name,
233 strlen (item_names[item_type])))
239 /*** RB_Get_Item_Type ***/
243 /****f* ROBODoc/RB_Get_Item_Attr [3.0b]
246 * RB_Get_Item_Attr -- shortcut
248 * int RB_Get_Item_Attr( char *cmp_name )
250 * return the item_attr represented by the given string
252 * char *cmp_name -- item_attr_name to evaluate
254 * int -- the right item_attr or NULL
256 * uses global char *item_attr_names[]
260 * RB_Analyse_Defaults_File(), RB_Get_Item_Type()
265 RB_Get_Item_Attr (char *cmp_name)
269 for (item_attr = MAKE_LARGE; item_attr < SIZE_ATTRIBUTES; ++item_attr)
270 if (!strcmp (item_attr_names[item_attr], cmp_name))
272 if (strcmp ("NORMAL", cmp_name))
274 fprintf (stderr, "%s: Warning unknown attribute [%s] in defaults file.\n",
277 return (MAKE_NORMAL);