SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

HowTo

  1463

38. Setup, initialisation

38. Setup, initialisation

  1488

38.1 initialise output directory

  1489

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

  1490

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

  1491

sisu -CC

  1492

38.1.1 Use of search functionality, an example using sqlite

  1493

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

  1494

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

  1495

It is necessary to:

  1496

(1) make sure the required dependencies have been installed

  1497

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

  1498

(3) use sisu to create a database

  1499

(4) use sisu tp populate a database

  1500

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

  1501

(6) use sisu to create a search form

  1502

(7) copy the search form to the cgi directory

  1503

(8) open up the form in your browser

  1504

(9) query the database using the search form

  1505

(1) make sure the required dependencies have been installed

  1506

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

  1507

aptitude install sisu-sqlite

  1508

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

  1509

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

  1510

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

  1511

(3) use sisu to create an sqlite database

  1512

within the sisu-examples directory

  1513

sisu -dv createall

  1514

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

  1515

within the sisu-examples directory

  1516

sisu -div free_*.sst

  1517

or

  1518

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

  1519

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

  1520

sisu -W

  1521

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

  1522

within the sisu-examples directory

  1523

sisu -F webrick

  1524

#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

  1525

#now this should be possible: sisu -F webrick

  1526

(7) copy the search form to the cgi directory

  1527

the string should be provided as output from the previous command

  1528

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

  1529

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

  1530

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

  1531

url:

  1532

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

  1533

or as instructed by command sisu -F webrick

  1534

(9) query the database using the search form

  1535

if there are other options in the dropdown menu select

  1536

document_samples_sisu_markup

  1537

and search for some text, e.g.:

  1538

aim OR project

  1539

  1540

  1541

(10) to start again with a new database

  1542

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

  1543

sisu -dv dropall

  1544

and go to step 3

  1545

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

  1546

sisu -dv recreate

  1547

continue subsequent steps

  1548

38.2 misc

  1549

38.2.1 url for output files -u -U

  1550

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

  1551

sisu -Uv [filename/wildcard]

  1552

38.2.2 toggle screen color

  1553

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

  1554

38.2.3 verbose mode

  1555

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

  1556

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

  1557

38.2.4 quiet mode

  1558

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

  1559

38.2.5 maintenance mode intermediate files kept -M

  1560

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

  1561

38.2.6 start the webrick server

  1562

sisu -W

  1563

38.3 remote placement of output

  1564

configuration is necessary

  1565

scp

  1566

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

  1567

rsync

  1568

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

  1569

Output generated by SiSU 0.59.0 2007-09-23 (2007w38/0)
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!