SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

HowTo

  1464

38. Setup, initialisation

38. Setup, initialisation

  1489

38.1 initialise output directory

  1490

Images, css files for a document directory are copied to their respective locations in the output directory.

  1491

while within your document markup/preparation directory, issue the following command

  1492

sisu -CC

  1493

38.1.1 Use of search functionality, an example using sqlite

  1494

SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases.

  1495

This note provides an example to get you started and will use sqlite

  1496

It is necessary to:

  1497

(1) make sure the required dependencies have been installed

  1498

(2) have a directory with sisu markup samples that is writable

  1499

(3) use sisu to create a database

  1500

(4) use sisu tp populate a database

  1501

(5) use sisu to start the webrick (httpd) server

  1502

(6) use sisu to create a search form

  1503

(7) copy the search form to the cgi directory

  1504

(8) open up the form in your browser

  1505

(9) query the database using the search form

  1506

(1) make sure the required dependencies have been installed

  1507

if you use Debian, the following command will install the required dependencies

  1508

aptitude install sisu-sqlite

  1509

(2) have a directory with sisu markup samples that is writable

  1510

ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable)

  1511

cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup ~/.

  1512

(3) use sisu to create an sqlite database

  1513

within the sisu-examples directory

  1514

sisu -dv createall

  1515

(4) use sisu tp populate a database with some text

  1516

within the sisu-examples directory

  1517

sisu -div free_*.sst

  1518

or

  1519

sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst gpl2.fsf.sst

  1520

(5) use sisu to start the webrick (httpd) server (if it has not already been started):

  1521

sisu -W

  1522

(6) use sisu to create a search form (for use with the webrick server, and your sample documents)

  1523

within the sisu-examples directory

  1524

sisu -F webrick

  1525

#here i run into a problem, you are working from a read only #directory..., not my usual mode of operation, to complete the example #the following is necessary sudo touch sisu_sqlite.cgi sisu_pgsql.cgi sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi

  1526

#now this should be possible: sisu -F webrick

  1527

(7) copy the search form to the cgi directory

  1528

the string should be provided as output from the previous command

  1529

sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi /usr/lib/cgi-bin

  1530

sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi

  1531

(8) open up the form in your browser and query it

  1532

url:

  1533

<http://localhost:8081/cgi-bin/sisu_sqlite.cgi>

  1534

or as instructed by command sisu -F webrick

  1535

(9) query the database using the search form

  1536

if there are other options in the dropdown menu select

  1537

document_samples_sisu_markup

  1538

and search for some text, e.g.:

  1539

aim OR project

  1540

  1541

  1542

(10) to start again with a new database

  1543

to start from scratch you can drop the database with the command

  1544

sisu -dv dropall

  1545

and go to step 3

  1546

to get to step 3 in one step with a single command

  1547

sisu -dv recreate

  1548

continue subsequent steps

  1549

38.2 misc

  1550

38.2.1 url for output files -u -U

  1551

sisu -uv[and other flags] [filename/wildcard]

  1552

sisu -Uv [filename/wildcard]

  1553

38.2.2 toggle screen color

  1554

sisu -cv[and processing flags] [filename/wildcard]

  1555

38.2.3 verbose mode

  1556

sisu -v[and processing flags] [filename/wildcard]

  1557

sisu -V[and processing flags] [filename/wildcard]

  1558

38.2.4 quiet mode

  1559

sisu -q[and processing flags] [filename/wildcard]

  1560

38.2.5 maintenance mode intermediate files kept -M

  1561

sisu -Mv[and other flags] [filename/wildcard]

  1562

38.2.6 start the webrick server

  1563

sisu -W

  1564

38.3 remote placement of output

  1565

configuration is necessary

  1566

scp

  1567

sisu -vr[and processing flags] [filename/wildcard]

  1568

rsync

  1569

sisu -vR[and processing flags] [filename/wildcard]

  1570

Output generated by SiSU 0.59.1 2007-09-25 (2007w39/2)
SiSU Copyright ^© Ralph Amissah 1997, current 2007. All Rights Reserved.
SiSU is software for document structuring, publishing and search,
www.jus.uio.no/sisu and www.sisudoc.org
w3 since October 3 1993 ralph@amissah.com

SiSU using:
Standard SiSU markup syntax,
Standard SiSU meta-markup syntax, and the
Standard SiSU object citation numbering and system, (object/text positioning system)
Copyright ^© Ralph Amissah 1997, current 2007. All Rights Reserved.

SiSU is released under GPLv3 or later, <http://www.gnu.org/licenses/gpl.html>

SiSU, developed using Ruby on Debian/Gnu/Linux software infrastructure, with the usual GPL (or OSS) suspects.
Better - "performance, reliability, scalability, security & total cost of ownership" [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre.
Get With the Future Way Better!