File: README

package info (click to toggle)
orgadoc 0.8-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,464 kB
  • ctags: 11,003
  • sloc: ansic: 218,658; sh: 4,128; makefile: 352; yacc: 112; lex: 100; xml: 25
file content (79 lines) | stat: -rw-r--r-- 1,743 bytes parent folder | download | duplicates (2)
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
===== DESCRIPTION =====

Orgadoc is a tool to organize you documents. Is goal is not to provide a 
full web access with database but to give possibility to everyone to have a 
copy of the database on this computers without having to install a web server 
or database.

Orgadoc includes a research tools (with regexp support), and multiple 
output backend with templates support : static html, latex, bibtex. An output 
of the html output is available at : http://docs.happycoders.org/html/

===== USE =====

Use is very easy : a xml file per directory describing all documents 
of this directory.

===== USE of CGI =====
the cgi read a variable 'query'.
Here is a example of HTML form to use with this cgi :

<FORM ACTION="cgi-bin/orgadoc_cgi" xmethod="PRE">
<P>Regexp search :
<INPUT NAME="query" SIZE="10">
<INPUT TYPE="SUBMIT" VALUE="Search">
</FORM>

===== EXAMPLE =====

Here is a example of readme.xml file :
<?xml version="1.0"?>
<readme>
  <document>
    <comment>	
      <author_name>Julien Lemoine</author_name>
      <content>This is a comment</content>
    </comment>
    <comment>	
      <author_name>Julien Lemoine</author_name>
      <content>Second comment</content>
    </comment>
  </document>
</readme>

here is a example of command :
  orgadoc -r -p /var/www/docs -w -e /tmp

===== FRENCH NOTES =====
You can add "accents" in your xml file, here is a summary :

 : &Acirc;
 :&acirc;
 : &AElig;
 : &aelig;
 : &Agrave;
 : &agrave;
 : &Ccedil;
 : &ccedil;
 : &Eacute;
 : &eacute;
 : &Ecirc;
 : &ecirc;
 : &Egrave;
 : &egrave;
 : &Euml;
 : &euml;
 : &Icirc;
 : &icirc;
 : &Iuml;
 : &iuml;
 : &Ocirc;
 : &ocirc;
 : &Ouml;
 : &ouml;
 : &Ugrave;
 : &ugrave;
 : &Ucirc;
 : &ucirc;
 : &Uuml;
 : &uuml;