diff options
91 files changed, 2575 insertions, 10360 deletions
diff --git a/conf/sisu/skin/dir/skin_sisu.rb b/conf/sisu/skin/dir/skin_sisu.rb index ad1d42a6..77ee1e13 100644..120000 --- a/conf/sisu/skin/dir/skin_sisu.rb +++ b/conf/sisu/skin/dir/skin_sisu.rb @@ -1,98 +1 @@ -=begin - * Name: SiSU information Structuring Universe - Structured information, Serialized Units - * Author: Ralph@Amissah.com - * http://www.jus.uio.no/sisu - * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... - * License: Same as SiSU see http://www.jus.uio.no/sisu - * Notes: Site default appearance variables set in defaults.rb - Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb -=end -module SiSU_Viz - require SiSU_lib + '/defaults' - class Skin - #% widget - def widget_search - true - end - def widget_promo -#put s "#{__LINE__} #{__FILE__}" - #['sisu','ruby','sisu_search_libre','ruby','open_society'] - end - #% path - def path_root -#puts "#{__LINE__} #{__FILE__}" - './sisu/' # the only parameter that cannot be changed here - end - def path_rel -#puts "#{__LINE__} #{__FILE__}" - '../' - end - #% url - def url_home -#puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu/' - end - def url_site # used in pdf header -#puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' - end - def url_txt # text to go with url usually stripped url -#puts "#{__LINE__} #{__FILE__}" - 'www.jus.uio.no/sisu/' - end - def url_home_url -#puts "#{__LINE__} #{__FILE__}" - '../index.html' - end - #def url_root_http - #root server path info, used in document information - #end - #% color - def color_band1 - '"#ffffff"' - end - def color_band2 - '"#ffffff"' - end - #% text - def text_hp - ' SiSU' - end - def text_home - 'SiSU' - end - #% icon - def icon_home_button - 'sisu.png' - end - def icon_home_banner - icon_home_button - end - #% banner - def banner_home_button - %{<table summary="home button" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/">#{png_home}</a></td></tr></table>\n} - end - def banner_home_and_index_buttons - %{<table><tr><td width="20%"><table summary="home and index buttons" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}</td><td width="60%"><center><center><table summary="buttons" border="1" cellpadding="3" cellspacing="0"><tr><td align="center" bgcolor="#ffffff"><font face="arial" size="2"><a href="toc" target="_top"> This text sub- <br /> Table of Contents </a></font>#{table_close}</center></center></td><td width="20%"> #{table_close}} - end - def banner_band - %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}} - end - end - class TeX - def header_center - "\\chead{\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}}" - end - def home_url - "\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}" - end - def home - "\\href{#{@vz.url_site}/}{Ralph Amissah}" - end - def owner_chapter - 'Document owner details' - end - end -end -__END__ +../doc/skin_sisu.rb
\ No newline at end of file diff --git a/conf/sisu/skin/doc/skin_gnu.rb b/conf/sisu/skin/doc/skin_gnu.rb index a41d9c10..3fbaedf8 100644 --- a/conf/sisu/skin/doc/skin_gnu.rb +++ b/conf/sisu/skin/doc/skin_gnu.rb @@ -1,9 +1,9 @@ -# coding: utf-8 +# encoding: utf-8 =begin * Name: SiSU - Simple information Structuring Universe - Structured information, Serialized Units * Author: Ralph Amissah + * http://www.sisudoc.org/ * http://www.jus.uio.no/sisu - * http://www.jus.uio.no/sisu/SiSU/download * Description: Free Software Foundation, Gnu sisu skin * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb diff --git a/conf/sisu/skin/doc/skin_kdissert.rb b/conf/sisu/skin/doc/skin_kdissert.rb deleted file mode 100644 index f695b908..00000000 --- a/conf/sisu/skin/doc/skin_kdissert.rb +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 -=begin - * Name: SiSU - Simple information Structuring Universe - Structured information, Serialized Units - * Author: Ralph Amissah - * http://www.jus.uio.no/sisu - * http://www.jus.uio.no/sisu/SiSU/download - * Description: Kdissert - * License: Same as SiSU see http://www.jus.uio.no/sisu - * Notes: Site default appearance variables set in defaults.rb - Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb -=end -module SiSU_Viz - require "#{SiSU_lib}/defaults" - class Skin - ##% path - #def path_root - # './sisu/' # the only parameter that cannot be changed here - #end - #def path_rel - # '../' - #end - #% url - def url_home - 'http://www.jus.uio.no/sisu' - end - def url_site # used in pdf header - url_home - end - def url_txt # text to go with url usually stripped url - 'www.jus.uio.no/sisu' - url_home - end - def url_hp - 'http://freehackers.org/~tnagy/kdissert' - end - def url_home_url - '../index.html' - end - #% color - def color_band1 - '"#ffffff"' - end - #% txt - def txt_hp - 'Kdissert, Document Mapping' - end - def txt_home # this should be the name of the site eg. Lex Mercatoria or if you prefer to see a url the url in text form copy & ... - #"www.jus.uio.no/sisu/" - 'SiSU (document prepared using Kdissert)' - end - #% icon - def icon_home_button - 'kdissert.png' - end - def icon_home_banner - icon_home_button - end - #% banner - def banner_home_button - %{<table border="0" summary="home button" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#000070"><a href="#{url_hp}/">#{png_home}</a></td></tr></table>\n} - end - def banner_home_and_index_buttons - %{<table><tr><td width="20%"><table summary="home and index buttons" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#000070"><a href="#{url_hp}/" target="_top">#{png_home}</a>#{table_close}</td><td width="60%"><center><table summary="buttons" border="1" cellpadding="3" cellspacing="0"><tr><td align="center" bgcolor="#f1e8de"><font face="arial" size="2"><a href="toc" target="_top"> This text sub- <br /> Table of Contents </a></font>#{table_close}</center></td><td width="20%"> #{table_close}} - end - def banner_band - %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_hp}/" target="_top">#{png_home}</a>#{table_close}} - end - def banner_home_guide - end - end - class TeX - def header_center - "\\chead{\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}}" - end - def home_url - "\\href{#{@vz.url_site}/}{www.fsf.org}" - end - def home - "\\href{#{@vz.url_site}/}{Free Software Foundation}" - end - def owner_chapter - "Document owner details" - end - end -end -__END__ diff --git a/conf/sisu/skin/doc/skin_sisu.rb b/conf/sisu/skin/doc/skin_sisu.rb index a52b7b91..fbe95681 100644 --- a/conf/sisu/skin/doc/skin_sisu.rb +++ b/conf/sisu/skin/doc/skin_sisu.rb @@ -1,9 +1,9 @@ -# coding: utf-8 +# encoding: utf-8 =begin * Name: SiSU information Structuring Universe - Structured information, Serialized Units * Author: Ralph@Amissah.com + * http://www.sisudoc.org/ * http://www.jus.uio.no/sisu - * http://www.jus.uio.no/sisu/SiSU/download * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb diff --git a/conf/sisu/skin/doc/skin_sisu_manual.rb b/conf/sisu/skin/doc/skin_sisu_manual.rb index 954be971..e5278a83 100644 --- a/conf/sisu/skin/doc/skin_sisu_manual.rb +++ b/conf/sisu/skin/doc/skin_sisu_manual.rb @@ -1,9 +1,9 @@ -# coding: utf-8 +# encoding: utf-8 =begin * Name: SiSU information Structuring Universe - Structured information, Serialized Units - * Author: Ralph@Amissah.com + * Author: ralph@amissah.com + * http://www.sisudoc.org/ * http://www.jus.uio.no/sisu - * http://www.jus.uio.no/sisu/SiSU/download * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb diff --git a/conf/sisu/skin/site/skin_sisu.rb b/conf/sisu/skin/site/skin_sisu.rb index a9fce5d0..77ee1e13 100644..120000 --- a/conf/sisu/skin/site/skin_sisu.rb +++ b/conf/sisu/skin/site/skin_sisu.rb @@ -1,98 +1 @@ -=begin - * Name: SiSU information Structuring Universe - Structured information, Serialized Units - * Author: Ralph@Amissah.com - * http://www.jus.uio.no/sisu - * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... - * License: Same as SiSU see http://www.jus.uio.no/sisu - * Notes: Site default appearance variables set in defaults.rb - Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb -=end -module SiSU_Viz - require SiSU_lib + '/defaults' - class Skin - #% widget - def widget_search - true - end - def widget_promo -#put s "#{__LINE__} #{__FILE__}" - #['sisu','ruby','sisu_search_libre','ruby','open_society'] - end - #% path - def path_root -#puts "#{__LINE__} #{__FILE__}" - './sisu/' # the only parameter that cannot be changed here - end - def path_rel -#puts "#{__LINE__} #{__FILE__}" - '../' - end - #% url - def url_home -#puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu/' - end - def url_site # used in pdf header -#puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' - end - def url_txt # text to go with url usually stripped url -#puts "#{__LINE__} #{__FILE__}" - 'www.jus.uio.no/sisu/' - end - def url_home_url -#puts "#{__LINE__} #{__FILE__}" - '../index.html' - end - #def url_root_http - #root server path info, used in document information - #end - #% color - def color_band1 - '"#ffffff"' - end - def color_band2 - '"#ffffff"' - end - #% text - def text_hp - ' SiSU' - end - def text_home - 'SiSU' - end - #% icon - def icon_home_button - 'sisu.png' - end - def icon_home_banner - icon_home_button - end - #% banner - def banner_home_button - %{<table summary="home button" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/">#{png_home}</a></td></tr></table>\n} - end - def banner_home_and_index_buttons - %{<table><tr><td width="20%"><table summary="home and index buttons" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}</td><td width="60%"><center><center><table summary="buttons" border="1" cellpadding="3" cellspacing="0"><tr><td align="center" bgcolor="#ffffff"><font face="arial" size="2"><a href="toc" target="_top"> This text sub- <br /> Table of Contents </a></font>#{table_close}</center></center></td><td width="20%"> #{table_close}} - end - def banner_band - %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}} - end - end - class TeX - def header_center - "\\chead{\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}}" - end - def home_url - "\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}" - end - def home - "\\href{#{@vz.url_site}/}{Ralph Amissah}" - end - def owner_chapter - 'Document owner details' - end - end -end -__END__ +../doc/skin_sisu.rb
\ No newline at end of file diff --git a/conf/sisu/skin/yml/skin_countries.yml b/conf/sisu/skin/yml/skin_countries.yml deleted file mode 100644 index 179b9978..00000000 --- a/conf/sisu/skin/yml/skin_countries.yml +++ /dev/null @@ -1,482 +0,0 @@ -# arch-tag: yaml country list -# Author: Ralph@Amissah.com -# License: Same as SiSU see http://www.jus.uio.no/sisu -id: AF - name: Afghanistan -id: AL - name: Albania -id: DZ - name: Algeria -id: AS - name: American Samoa -id: AD - name: Andorra -id: AO - name: Angola -id: AI - name: Anguilla -id: AQ - name: Antarctica -id: AG - name: Antigua and Barbuda -id: AR - name: Argentina -id: AM - name: Armenia -id: AW - name: Aruba -id: AU - name: Australia -id: AT - name: Austria -id: AZ - name: Azerbaijan -id: BS - name: Bahamas -id: BH - name: Bahrain -id: BD - name: Bangladesh -id: BB - name: Barbados -id: BY - name: Belarus -id: BE - name: Belgium -id: BZ - name: Belize -id: BJ - name: Benin -id: BM - name: Bermuda -id: BT - name: Bhutan -id: BO - name: Bolivia -id: BA - name: Bosnia and Herzegovina -id: BW - name: Botswana -id: BV - name: Bouvet Island -id: BR - name: Brazil -id: IO - name: British Indian Ocean Territory -id: BN - name: Brunei Darussalam -id: BG - name: Bulgaria -id: BF - name: Burkina Faso -id: BI - name: Burundi -id: KH - name: Cambodia -id: CM - name: Cameroon -id: CA - name: Canada -id: CV - name: Cape Verde -id: KY - name: Cayman Islands -id: CF - name: Central African Republic -id: TD - name: Chad -id: CL - name: Chile -id: CN - name: China -id: CX - name: Christmas Island -id: CC - name: Cocos (Keeling) Islands -id: CO - name: Colombia -id: KM - name: Comoros -id: CG - name: Congo -id: CK - name: Cook Islands -id: CR - name: Costa Rica -id: HR - name: Croatia (Hrvatska) -id: CU - name: Cuba -id: CY - name: Cyprus -id: CZ - name: Czech Republic -id: CS - name: Czechoslovakia -id: DK - name: Denmark -id: DJ - name: Djibouti -id: DM - name: Dominica -id: DO - name: Dominican Republic -id: TP - name: East Timor -id: EC - name: Ecuador -id: EG - name: Egypt -id: SV - name: El Salvador -id: GQ - name: Equatorial Guinea -id: ER - name: Eritrea -id: EE - name: Estonia -id: ET - name: Ethiopia -id: FK - name: Falkland Islands (Malvinas) -id: FO - name: Faroe Islands -id: FJ - name: Fiji -id: FI - name: Finland -id: FR - name: France -id: FX - name: France, Metroplitan -id: GF - name: French Guiana -id: PF - name: French Polynesia -id: TF - name: French Southern Territories -id: GA - name: Gabon -id: GM - name: Gambia -id: GE - name: Georgia -id: DE - name: Germany -id: GH - name: Ghana -id: GI - name: Gibraltar -id: GB - name: Great Britain (UK) -id: GR - name: Greece -id: GL - name: Greenland -id: GD - name: Grenada -id: GP - name: Guadeloupe -id: GU - name: Guam -id: GT - name: Guatemala -id: GN - name: Guinea -id: GW - name: Guinea-Bissau -id: GY - name: Guyana -id: HT - name: Haiti -id: HM - name: Heard and McDonald Islands -id: HN - name: Honduras -id: HK - name: Hong Kong -id: HU - name: Hungary -id: IS - name: Iceland -id: IN - name: India -id: ID - name: Indonesia -id: IR - name: Iran -id: IQ - name: Iraq -id: IE - name: Ireland -id: IL - name: Israel -id: IT - name: Italy -id: CI - name: Ivory Coast -id: JM - name: Jamaica -id: JP - name: Japan -id: JO - name: Jordan -id: KZ - name: Kazakhstan -id: KE - name: Kenya -id: KI - name: Kiribati -id: KP - name: Korea (North) -id: KR - name: Korea (South) -id: KW - name: Kuwait -id: KG - name: Kyrgyzstan -id: LA - name: Laos -id: LV - name: Latvia -id: LB - name: Lebanon -id: LS - name: Lesotho -id: LR - name: Liberia -id: LY - name: Libya -id: LI - name: Liechtenstein -id: LT - name: Lithuania -id: LU - name: Luxembourg -id: MO - name: Macau -id: ME - name: Macedonia -id: MG - name: Madagascar -id: MW - name: Malawi -id: MY - name: Malaysia -id: MV - name: Maldives -id: ML - name: Mali -id: MT - name: Malta -id: MB - name: Marshall Islands -id: MQ - name: Martinique -id: MR - name: Mauritania -id: MU - name: Mauritius -id: YT - name: Mayotte -id: MX - name: Mexico -id: FM - name: Micronesia -id: MD - name: Moldova -id: MC - name: Monaco -id: MN - name: Mongolia -id: MS - name: Montserrat -id: MA - name: Morocco -id: MZ - name: Mozambique -id: MM - name: Myanmar -id: NA - name: Namibia -id: NR - name: Nauru -id: NP - name: Nepal -id: NL - name: Netherlands -id: AN - name: Netherlands Antilles -id: NT - name: Neutral Zone -id: NC - name: New Caledonia -id: NZ - name: New Zealand (Aotearoa) -id: NI - name: Nicaragua -id: NE - name: Niger -id: NG - name: Nigeria -id: NU - name: Niue -id: NF - name: Norfolk Island -id: MP - name: Northern Mariana Islands -id: NO - name: Norway -id: OM - name: Oman -id: 00 - name: Other -id: PK - name: Pakistan -id: PW - name: Palau -id: PA - name: Panama -id: PG - name: Papua New Guinea -id: PY - name: Paraguay -id: PE - name: Peru -id: PH - name: Philippines -id: PN - name: Pitcairn -id: PL - name: Poland -id: PT - name: Portugal -id: PR - name: Puerto Rico -id: QA - name: Qatar -id: RE - name: Reunion -id: RO - name: Romania -id: RU - name: Russian Federation -id: RW - name: Rwanda -id: GS - name: S. Georgia and S. Sandwich Isls. -id: KN - name: Saint Kitts and Nevis -id: LC - name: Saint Lucia -id: VC - name: Saint Vincent and the Grenadines -id: WS - name: Samoa -id: SM - name: San Marino -id: ST - name: Sao Tome and Principe -id: SA - name: Saudi Arabia -id: SN - name: Senegal -id: SC - name: Seychelles -id: SL - name: Sierra Leone -id: SG - name: Singapore -id: SK - name: Slovak Republic -id: SI - name: Slovenia -id: SB - name: Solomon Islands -id: SO - name: Somalia -id: ZA - name: South Africa -id: ES - name: Spain -id: LK - name: Sri Lanka -id: SH - name: St. Helena -id: PM - name: St. Pierre and Miquelon -id: SD - name: Sudan -id: SR - name: Suriname -id: SJ - name: Svalbard and Jan Mayen Islands -id: SZ - name: Swaziland -id: SE - name: Sweden -id: CH - name: Switzerland -id: SY - name: Syria -id: TW - name: Taiwan -id: TJ - name: Tajikistan -id: TZ - name: Tanzania -id: TH - name: Thailand -id: TG - name: Togo -id: TK - name: Tokelau -id: TO - name: Tonga -id: TT - name: Trinidad and Tobago -id: TN - name: Tunisia -id: TR - name: Turkey -id: TM - name: Turkmenistan -id: TC - name: Turks and Caicos Islands -id: TV - name: Tuvalu -id: UM - name: US Minor Outlying Islands -id: SU - name: USSR (former) -id: UG - name: Uganda -id: UA - name: Ukraine -id: AE - name: United Arab Emirates -id: UK - name: United Kingdom -id: US - name: United States -id: UY - name: Uruguay -id: UZ - name: Uzbekistan -id: VU - name: Vanuatu -id: VA - name: Vatican City State (Holy See) -id: VE - name: Venezuela -id: VN - name: Viet Nam -id: VG - name: Virgin Islands (British) -id: VI - name: Virgin Islands (U.S.) -id: WF - name: Wallis and Futuna Islands -id: EH - name: Western Sahara - diff --git a/conf/sisu/skin/yml/skin_country.yml b/conf/sisu/skin/yml/skin_country.yml deleted file mode 100644 index dc835465..00000000 --- a/conf/sisu/skin/yml/skin_country.yml +++ /dev/null @@ -1,735 +0,0 @@ -# arch-tag: yaml country list array -# Author: Ralph@Amissah.com -# License: Same as SiSU see http://www.jus.uio.no/sisu -- - - AF - - Afghanistan -- - - AL - - Albania -- - - DZ - - Algeria -- - - AS - - American Samoa -- - - AD - - Andorra -- - - AO - - Angola -- - - AI - - Anguilla -- - - AQ - - Antarctica -- - - AG - - Antigua and Barbuda -- - - AR - - Argentina -- - - AM - - Armenia -- - - AW - - Aruba -- - - AU - - Australia -- - - AT - - Austria -- - - AZ - - Azerbaijan -- - - BS - - Bahamas -- - - BH - - Bahrain -- - - BD - - Bangladesh -- - - BB - - Barbados -- - - BY - - Belarus -- - - BE - - Belgium -- - - BZ - - Belize -- - - BJ - - Benin -- - - BM - - Bermuda -- - - BT - - Bhutan -- - - BO - - Bolivia -- - - BA - - Bosnia and Herzegovina -- - - BW - - Botswana -- - - BV - - Bouvet Island -- - - BR - - Brazil -- - - IO - - British Indian Ocean Territory -- - - BN - - Brunei Darussalam -- - - BG - - Bulgaria -- - - BF - - Burkina Faso -- - - BI - - Burundi -- - - KH - - Cambodia -- - - CM - - Cameroon -- - - CA - - Canada -- - - CV - - Cape Verde -- - - KY - - Cayman Islands -- - - CF - - Central African Republic -- - - TD - - Chad -- - - CL - - Chile -- - - CN - - China -- - - CX - - Christmas Island -- - - CC - - Cocos (Keeling) Islands -- - - CO - - Colombia -- - - KM - - Comoros -- - - CG - - Congo -- - - CK - - Cook Islands -- - - CR - - Costa Rica -- - - HR - - Croatia (Hrvatska) -- - - CU - - Cuba -- - - CY - - Cyprus -- - - CZ - - Czech Republic -- - - CS - - Czechoslovakia (former) -- - - DK - - Denmark -- - - DJ - - Djibouti -- - - DM - - Dominica -- - - DO - - Dominican Republic -- - - TP - - East Timor -- - - EC - - Ecuador -- - - EG - - Egypt -- - - SV - - El Salvador -- - - GQ - - Equatorial Guinea -- - - ER - - Eritrea -- - - EE - - Estonia -- - - ET - - Ethiopia -- - - FK - - Falkland Islands (Malvinas) -- - - FO - - Faroe Islands -- - - FJ - - Fiji -- - - FI - - Finland -- - - FR - - France -- - - FX - - France, Metropolitan -- - - GF - - French Guiana -- - - PF - - French Polynesia -- - - TF - - French Southern Territories -- - - GA - - Gabon -- - - GM - - Gambia -- - - GE - - Georgia -- - - DE - - Germany -- - - GH - - Ghana -- - - GI - - Gibraltar -- - - GB - - Great Britain (UK) -- - - GR - - Greece -- - - GL - - Greenland -- - - GD - - Grenada -- - - GP - - Guadeloupe -- - - GU - - Guam -- - - GT - - Guatemala -- - - GN - - Guinea -- - - GW - - Guinea-Bissau -- - - GY - - Guyana -- - - HT - - Haiti -- - - HM - - Heard and McDonald Islands -- - - HN - - Honduras -- - - HK - - Hong Kong -- - - HU - - Hungary -- - - IS - - Iceland -- - - IN - - India -- - - ID - - Indonesia -- - - IR - - Iran -- - - IQ - - Iraq -- - - IE - - Ireland -- - - IL - - Israel -- - - IT - - Italy -- - - CI - - Ivory Coast -- - - JM - - Jamaica -- - - JP - - Japan -- - - JO - - Jordan -- - - KZ - - Kazakhstan -- - - KE - - Kenya -- - - KI - - Kiribati -- - - KP - - Korea (North) -- - - KR - - Korea (South) -- - - KW - - Kuwait -- - - KG - - Kyrgyzstan -- - - LA - - Laos -- - - LV - - Latvia -- - - LB - - Lebanon -- - - LS - - Lesotho -- - - LR - - Liberia -- - - LY - - Libya -- - - LI - - Liechtenstein -- - - LT - - Lithuania -- - - LU - - Luxembourg -- - - MO - - Macau -- - - ME - - Macedonia -- - - MG - - Madagascar -- - - MW - - Malawi -- - - MY - - Malaysia -- - - MV - - Maldives -- - - ML - - Mali -- - - MT - - Malta -- - - MB - - Marshall Islands -- - - MQ - - Martinique -- - - MR - - Mauritania -- - - MU - - Mauritius -- - - YT - - Mayotte -- - - MX - - Mexico -- - - FM - - Micronesia -- - - MD - - Moldova -- - - MC - - Monaco -- - - MN - - Mongolia -- - - MS - - Montserrat -- - - MA - - Morocco -- - - MZ - - Mozambique -- - - MM - - Myanmar -- - - NA - - Namibia -- - - NR - - Nauru -- - - NP - - Nepal -- - - NL - - Netherlands -- - - AN - - Netherlands Antilles -- - - NT - - Neutral Zone -- - - NC - - New Caledonia -- - - NZ - - New Zealand (Aotearoa) -- - - NI - - Nicaragua -- - - NE - - Niger -- - - NG - - Nigeria -- - - NU - - Niue -- - - NF - - Norfolk Island -- - - MP - - Northern Mariana Islands -- - - 'NO' - - Norway -- - - OM - - Oman -- - - '00' - - Other -- - - PK - - Pakistan -- - - PW - - Palau -- - - PA - - Panama -- - - PG - - Papua New Guinea -- - - PY - - Paraguay -- - - PE - - Peru -- - - PH - - Philippines -- - - PN - - Pitcairn -- - - PL - - Poland -- - - PT - - Portugal -- - - PR - - Puerto Rico -- - - QA - - Qatar -- - - RE - - Reunion -- - - RO - - Romania -- - - RU - - Russian Federation -- - - RW - - Rwanda -- - - GS - - S. Georgia and S. Sandwich Isls. -- - - KN - - Saint Kitts and Nevis -- - - LC - - Saint Lucia -- - - VC - - Saint Vincent and the Grenadines -- - - WS - - Samoa -- - - SM - - San Marino -- - - ST - - Sao Tome and Principe -- - - SA - - Saudi Arabia -- - - SN - - Senegal -- - - SC - - Seychelles -- - - SL - - Sierra Leone -- - - SG - - Singapore -- - - SK - - Slovak Republic -- - - SI - - Slovenia -- - - SB - - Solomon Islands -- - - SO - - Somalia -- - - ZA - - South Africa -- - - ES - - Spain -- - - LK - - Sri Lanka -- - - SH - - St. Helena -- - - PM - - St. Pierre and Miquelon -- - - SD - - Sudan -- - - SR - - Suriname -- - - SJ - - Svalbard and Jan Mayen Islands -- - - SZ - - Swaziland -- - - SE - - Sweden -- - - CH - - Switzerland -- - - SY - - Syria -- - - TW - - Taiwan -- - - TJ - - Tajikistan -- - - TZ - - Tanzania -- - - TH - - Thailand -- - - TG - - Togo -- - - TK - - Tokelau -- - - TO - - Tonga -- - - TT - - Trinidad and Tobago -- - - TN - - Tunisia -- - - TR - - Turkey -- - - TM - - Turkmenistan -- - - TC - - Turks and Caicos Islands -- - - TV - - Tuvalu -- - - UM - - US Minor Outlying Islands -- - - SU - - USSR (former) -- - - UG - - Uganda -- - - UA - - Ukraine -- - - AE - - United Arab Emirates -- - - UK - - United Kingdom -- - - US - - United States -- - - UY - - Uruguay -- - - UZ - - Uzbekistan -- - - VU - - Vanuatu -- - - VA - - Vatican City State (Holy See) -- - - VE - - Venezuela -- - - VN - - Viet Nam -- - - VG - - Virgin Islands (British) -- - - VI - - Virgin Islands (U.S.) -- - - WF - - Wallis and Futuna Islands -- - - EH - - Western Sahara -- - - YE - - Yemen -- - - YU - - Yugoslavia -- - - ZR - - Zaire -- - - ZM - - Zambia -- - - ZW - - Zimbabwe diff --git a/data/doc/sisu/CHANGELOG_v2 b/data/doc/sisu/CHANGELOG_v2 index 790b1b10..9866e098 100644 --- a/data/doc/sisu/CHANGELOG_v2 +++ b/data/doc/sisu/CHANGELOG_v2 @@ -12,7 +12,7 @@ Reverse Chronological: %% STABLE Branch -%% 2.8.1.orig.tar.gz (2011-03-01:09/2) +%% 2.8.1.orig.tar.gz (2011-03-05:09/6) http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.1.orig.tar.gz sisu_2.8.1.orig.tar.gz sisu_2.8.1-1.dsc @@ -20,6 +20,17 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.1.orig.tar.gz * make sisu: v2 require >=ruby1.8.7; v3 require >=ruby1.9.2 + * v2, v3: manpage, adjust output, fewer backslashes + + * v2, v3: defaults, clean homepage + + * v2, v3: consolidate manual & markup samples + sisu markup source, manpages, man2html + * clean up headers + * update and correct links + * tidy + * small fixes + %% 2.8.0.orig.tar.gz (2011-02-01:05/2) http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.0-1 http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.0.orig.tar.gz diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index db83cd2c..871a9c6e 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -13,7 +13,8 @@ Reverse Chronological: %% Development branch UNSTABLE v3 branch once stable will supersede & replace current stable v2 branch -%% 3.0.2.orig.tar.gz (2011-03-02:09/3) +%% 3.0.2.orig.tar.gz (2011-03-05:09/6) +http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.2-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.2.orig.tar.gz sisu_3.0.2.orig.tar.gz sisu_3.0.2-1.dsc @@ -42,7 +43,19 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.2.orig.tar.gz * hub, minor rearranging + * v2, v3: manpage, adjust output, fewer backslashes + + * v2, v3: defaults, clean homepage + * v2, v3: consolidate manual & markup samples + sisu markup source, manpages, man2html + * clean up headers + * update and correct links + * tidy + * small fixes + + * conf/skin remove less important skins and use syslink to share + doc/skin_sisu.rb %% 3.0.1.orig.tar.gz (2011-02-16:07/3) http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.1-1 diff --git a/data/doc/sisu/html/README b/data/doc/sisu/html/README index a4263458..c8ebc4ad 100644 --- a/data/doc/sisu/html/README +++ b/data/doc/sisu/html/README @@ -4,7 +4,3 @@ this "html" directory contains SiSU man pages in html man pages are either created by sisu from sisu markup documents contained in the directory "sisu_markup_samples/sisu_manual" or manually crafted - -also see the contents of the directories: -* "sisu_manual" [sisu documentation in various file formats] -* "sisu_markup_samples" [sisu markup examples] diff --git a/data/doc/sisu/html/_sisu b/data/doc/sisu/html/_sisu deleted file mode 120000 index 0e977351..00000000 --- a/data/doc/sisu/html/_sisu +++ /dev/null @@ -1 +0,0 @@ -../sisu_manual/_sisu
\ No newline at end of file diff --git a/data/doc/sisu/html/homepage/index.html b/data/doc/sisu/html/homepage/index.html deleted file mode 100644 index 6c55c9c0..00000000 --- a/data/doc/sisu/html/homepage/index.html +++ /dev/null @@ -1,264 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>SiSU information Structuring Universe - Structured -information, Serialized Units - software for electronic texts, -documents, books, digital libraries in plaintext, html, xhtml, XML, -ODF (OpenDocument), LaTeX, pdf, SQL (PostgreSQL and SQLite), and -for search</title> -<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> -<meta name="dc.title" content= -"SiSU information Structuring Universe, Structured information Serialised Units, 2007" /> -<meta name="dc.creator" content="Ralph Amissah" /> -<meta name="dc.subject" content= -"ebook, publishing, pdf, LaTeX, XML, ODF, SQL, postgresql, sqlite, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search, digital library" /> -<meta name="dc.publisher" content= -"SiSU http://www.jus.uio.no/sisu" /> -<meta name="dc.language" content="en" /> -<meta name="dc.rights" content="Copyright Ralph Amissah" /> -<meta name="generator" content="SiSU 0.48.9 of 2007w01/1 (20070101) (n*x and Ruby!)" /> -<link rel="generator" href="http://www.jus.uio.no/sisu/SiSU" /> -<link rel="stylesheet" href="./_sisu/css/html.css" type="text/css" /> -<link rel="shortcut icon" href="./_sisu/image/rb7.ico" /> -</head> -<body> -<div id="top_band"> -<p class="top_band_image"> - <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > - <img border="0" src="./_sisu/image/sisu.png" alt="SiSU >>"> - </a> -</p> -<h1 class="top_band"> - SiSU information Structuring Universe -</h1> -<h2 class="top_band_tiny"> - Structured information, Serialized Units -</h2> -<h2 class="top_band_tiny"> -software for electronic texts, document collections, books, digital libraries, and search -</h2> -<h2 class="top_band_tiny"> - with "atomic search" and text positioning system (shared text citation numbering: "<i>ocn</i>") -</h2> -<h2 class="top_band_tiny"> -outputs include: plaintext, html, xhtml, XML, ODF (OpenDocument), LaTeX, pdf, SQL (PostgreSQL and SQLite) -</h2> -</div> -<div id="column_left"> -<p class="bold"> - <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > - SiSU - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/1.html#summary" target="_top" > - What does SiSU do? Summary - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/2.html" target="_top" > - Book Samples and Markup Examples - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/1.html#ocn" target="_top" > - Object Citation Numbering - <i>ocn</i> - </a> -</p> -<p class="tiny">(a text positioning system)</p> -<p class="tiny"> - --- -</p> -<p class="small"> -<p> - <a href="http://www.jus.uio.no/sisu/SiSU/1.html#search" target="_top" > - Search - "<i>Atomic</i>" - </a> -</p> -<p class="tiny"> - Of interest is the ease of streaming documents to a relational database, at an object (roughly paragraph) level and the potential for increased precision in the presentation of matches that results thereby. The ability to serialise html, LaTeX, XML, SQL, (whatever) is also inherent in / incidental to the design. For a description see the - <a href="http://www.jus.uio.no/sisu/sisu_provisional_patent_application_200408" target="_top" > - abandoned U.S. provisional patent application - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/download.html" target="_top" > - <b>Download</b> - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/changelog.html" target="_top" > - Changelog - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/license.html" target="_top" > - License - </a> -</p> -<p class="tiny"> - Gnu / Linux / Unix -</p> -<p class="tiny"> - ============= -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/man" target="_top" > - sisu man pages - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="tiny"> - document preparation can be on any platform, in any editor: - (syntax highlight support currently for: vim, kate, write, gedit, diakonos) -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/syntax_highlight" target="_top" > - Syntax highlighting - </a> -</p> -<p class="tiny"> - ============= -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > - * Composite document - </a> -</p> -<p class="tiny"> - the composite document is a superset of the following documents: -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_description" target="_top" > - SiSU description - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_examples" target="_top" > - SiSU examples - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_chronology" target="_top" > - SiSU chronology - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_technical_info" target="_top" > - SiSU technical - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_faq" target="_top" > - SiSU FAQ - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_download" target="_top" > - SiSU download - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_changelog" target="_top" > - SiSU changelog - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_license" target="_top" > - SiSU license - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_standard" target="_top" > - SiSU standard - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_provisional_patent_application_200408" target="_top" > - SiSU abandoned provisional patent - </a> -</p> -<p class="tiny"> - Note: the placement of SiSU documents on the Net predate the release of SiSU. -</p> -</div> -<div id="column_center"> -<p class="bold"> - For less markup than the most elementary HTML you can have so much more. -</p> -<p><a href="http://www.jus.uio.no/sisu/SiSU" target="_top" ><b>SiSU</b> - Structured information, Serialized Units</a> for Electronic Documents, is an information structuring, transforming and publishing framework with the following features:</p> -<p><b>(i)</b> markup syntax: (a) simpler than html, (b) mnemonic, influenced by mail/messaging/wiki markup practices, (c) human readable, and easily writable,</p> -<p><b>(ii)</b> (a) minimal markup requirement, (b) single file marked up for multiple outputs,</p> -<p><b>(iii)</b> (a) multiple outputs include amongst others: html; pdf via LaTeX; (structured) XML; ODF (OpenDocument); sql - currently PostgreSQL (and SQLite); ascii, (also texinfo), (b) takes advantage of the strengths implicit in these very different output types, (e.g. pdfs produced using typsetting of LaTeX, databases populated with documents at an individual object/paragraph level, with implications for search possibilities...)</p> -<p><b>(iv)</b> provides a common object positioning and citation system for all outputs, which is human relevant and machine usable: <u><i>object citation numbering</i></u>, all objects (paragraphs, headings, verse, tables etc. and images) are numbered identically, for citation purposes, in all outputs (html, pdf, sql etc.),</p> -<p><b>(v)</b> use of Dublin Core and other meta-tags to permit the addition of some semantic information on documents, and making easy integration of rdf/rss feeds etc.,</p> -<p><b>(vi)</b> creates organised directory/file structure for (file-system) output, easily mapped with its clearly defined structure, with all text objects numbered, you know in advance where in each document output type, a bit of text will be found (eg. from an sql search, you know where to go to find the prepared html output or pdf etc.)... there is more; easy directory management and document associations, the document preparation (sub-)directory may be used to determine output (sub-)directory, the skin used, and the sql database used,</p> -<p><b>(vii)</b> search of document sets, at object/paragraph level, the relational database retains information on the document structure, and citation numbering makes it possible for example to present search matches as an index of documents and locations within the document where the match is found,</p> -<p><b>(viii)</b> "Concordance file" wordmap, consisting of all the words in a document and their (text/ object) locations within the text, (and the possibility of adding vocabularies),</p> -<p><b>(ix)</b> document content certification and comparison considerations: (a) the document and each object within it stamped with an md5 hash making it possible to easily check or guarantee that the substantive content of a document is unchanged, (b) version control, documents integrated with time based source control system, default RCS or CVS with use of $Id$ tag, which SiSU checks -<p><b>(x)</b> SiSU's minimalist markup makes for meaningful "diffing" of the substantive content of markup-files,</p> -<p><b>(xi)</b> easily skinnable, document appearance on a project/site wide, directory wide, or document instance level easily controlled/changed,</p> -<p><b>(xii)</b> in many cases a regular expression may be used (once in the document header) to define all or part of a documents structure obviating or reducing the need to provide structural markup within the document,</p> -<p><b>(xiii)</b> is a batch processor for handling large document sets, ... though once generated they need not be re-generated, unless changes are made to the desired presentation of a particular output type,</p> -<p><b>(xiv)</b> possible to pre-process, which permits: the easy creation of standard form documents, and templates/term-sheets, or; building of composite documents (master documents) from other sisu marked up documents, or marked up parts, i.e. import documents or parts of text into a main document should this be desired</p> -<p><b>(xv)</b> future proofing, a framework for adding further capability or updating existing capability as required: (a) modular, (thanks in no small part to Ruby) another output format required, write another module....(b) easy to update output formats (eg html, xhtml, latex/pdf produced can be updated in program and run against whole document set), (c) easy to add, modify, or have alternative syntax rules for input, should you need to,</p> -<p><b>(xvi)</b> scalability, dependent on your file-system (in my case Reiserfs) and on the relational database used (currently Postgresql and SQLite), and your hardware,</p> -<p><b>(xvii)</b> only marked up files need be backed up, to secure the larger document set produced,</p> -<p><b>(xviii)</b> document management,</p> -<p><b>(xix)</b> use your favourite editor, syntax highlighting files for markup, primarily (g)vim so far,</p> -<p><b>(xx)</b> remote operations: (a) run SiSU on a remote server, (having prepared sisu markup documents locally or on that server, i.e. this solution where sisu is installed on the remote server, would work whatever type of machine you chose to prepare your markup documents on), (b) alternatively, (assuming sisu is available to you locally but not installed on the remote server) configure sisu to securely copy (scp) its output to your remote host and run sisu locally, (c) request a remotely located sisu markup file and process it locally by identifying it by its' url.</p> -<br /> -<p class="small"> -More information on <a href="http://www.jus.uio.no/sisu/SiSU/"><b>SiSU</b></a> provided at <a href="http://www.jus.uio.no/sisu/SiSU/">www.jus.uio.no/sisu/SiSU</a></p> -</div> -<div id="column_right"> -<p class="small"> - More information on <a href="http://www.jus.uio.no/sisu/SiSU/"><b>SiSU</b></a> provided at: - <a href="http://www.jus.uio.no/sisu/SiSU/"> - www.jus.uio.no/sisu/SiSU - </a> -<p class="tiny"> -SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...(humanities, law and part of the social sciences)). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time.</p> -<p class="tiny"> -SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored.</p> -<p class="tiny"> -Some modules are more mature than others, the most mature being Html and LaTeX / pdf. PostgreSQL and search functions are useable and together with <i>ocn</i> unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept, as is the OpenDocument output which is a limited SiSU feature set (SiSU is interested in a very limited ODF feature set).</p> -<p class="small"> -<a href="mailto://ralph@amissah.com"> -ralph@amissah.com -</a> -</p> -<p class="small"> -<a href="mailto://ralph.amissah@gmail.com"> -ralph.amissah@gmail.com -</a> -</p> -<p class="small"> -2007 -</p> -<p class="tiny"> -w3 since October 3 1993 -</p> -</div> -</body> -</html> diff --git a/data/doc/sisu/html/index.html b/data/doc/sisu/html/index.html deleted file mode 120000 index c6513ea0..00000000 --- a/data/doc/sisu/html/index.html +++ /dev/null @@ -1 +0,0 @@ -../sisu_manual/index.html
\ No newline at end of file diff --git a/data/doc/sisu/html/sisu-concordance.1.html b/data/doc/sisu/html/sisu-concordance.1.html index 0c1f5622..f1ca71bb 100644 --- a/data/doc/sisu/html/sisu-concordance.1.html +++ b/data/doc/sisu/html/sisu-concordance.1.html @@ -30,6 +30,8 @@ for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concord , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concord , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-epub.1.html b/data/doc/sisu/html/sisu-epub.1.html index f3722477..747756ac 100644 --- a/data/doc/sisu/html/sisu-epub.1.html +++ b/data/doc/sisu/html/sisu-epub.1.html @@ -30,6 +30,8 @@ The <b>sisu-epub</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ The <b>sisu-epub</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-git.1.html b/data/doc/sisu/html/sisu-git.1.html index 8df25642..6c70396f 100644 --- a/data/doc/sisu/html/sisu-git.1.html +++ b/data/doc/sisu/html/sisu-git.1.html @@ -40,6 +40,8 @@ document and associated parts (images, ). , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-harvest.1.html b/data/doc/sisu/html/sisu-harvest.1.html index 8a542a94..410c805f 100644 --- a/data/doc/sisu/html/sisu-harvest.1.html +++ b/data/doc/sisu/html/sisu-harvest.1.html @@ -34,6 +34,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> @@ -42,6 +44,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-html.1.html b/data/doc/sisu/html/sisu-html.1.html index 99fd959f..2672f615 100644 --- a/data/doc/sisu/html/sisu-html.1.html +++ b/data/doc/sisu/html/sisu-html.1.html @@ -32,6 +32,8 @@ The <b>sisu-html</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> @@ -40,6 +42,8 @@ The <b>sisu-html</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-odf.1.html b/data/doc/sisu/html/sisu-odf.1.html index ae929917..ef3110f8 100644 --- a/data/doc/sisu/html/sisu-odf.1.html +++ b/data/doc/sisu/html/sisu-odf.1.html @@ -32,6 +32,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-pdf.1.html b/data/doc/sisu/html/sisu-pdf.1.html index 685e0a68..bb34a771 100644 --- a/data/doc/sisu/html/sisu-pdf.1.html +++ b/data/doc/sisu/html/sisu-pdf.1.html @@ -32,6 +32,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-pg.1.html b/data/doc/sisu/html/sisu-pg.1.html index c87ae7a7..fec48e39 100644 --- a/data/doc/sisu/html/sisu-pg.1.html +++ b/data/doc/sisu/html/sisu-pg.1.html @@ -32,12 +32,16 @@ The <b>sisu-pq</b> command is an alias for <b>sisu , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-po.1.html b/data/doc/sisu/html/sisu-po.1.html new file mode 100644 index 00000000..681cda4c --- /dev/null +++ b/data/doc/sisu/html/sisu-po.1.html @@ -0,0 +1,73 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>SISU\-ODF(1) manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<p> +<h2><a name='sect0' href='#toc0'>Name</a></h2> +<b>SiSU</b> - Structured information, Serialized Units - a document publishing + +<p>system +<p> +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +<b>sisu-odf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i> +<p> +<h2><a name='sect2' href='#toc2'>Description</a></h2> +<b>SiSU</b> +is a lightweight markup based document structuring, publishing and search +framework for document collections. <p> +The <b>sisu-po</b> command is an alias for <b>sisu +--po4a</b> (or <b>sisu -o</b>) which provided two sisu markup files of the same document +in different languages produces .pot and .po output of a SiSU markup file. +Experimental, and under development. +<p> +<h2><a name='sect3' href='#toc3'>See Also</a></h2> +<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> +. +<p> +<h2><a name='sect4' href='#toc4'>Homepage</a></h2> +More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. + +<p> +<h2><a name='sect5' href='#toc5'>Author</a></h2> +<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <p> + +<hr><p> +<a name='toc'><b>Table of Contents</b></a><p> +<ul> +<li><a name='toc0' href='#sect0'>Name</a></li> +<li><a name='toc1' href='#sect1'>Synopsis</a></li> +<li><a name='toc2' href='#sect2'>Description</a></li> +<li><a name='toc3' href='#sect3'>See Also</a></li> +<li><a name='toc4' href='#sect4'>Homepage</a></li> +<li><a name='toc5' href='#sect5'>Author</a></li> +</ul> +</body> +</html> diff --git a/data/doc/sisu/html/sisu-sqlite.1.html b/data/doc/sisu/html/sisu-sqlite.1.html index ab0997e8..7a09c353 100644 --- a/data/doc/sisu/html/sisu-sqlite.1.html +++ b/data/doc/sisu/html/sisu-sqlite.1.html @@ -32,6 +32,8 @@ The <b>sisu-sqlite</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -42,6 +44,8 @@ The <b>sisu-sqlite</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> . <p> diff --git a/data/doc/sisu/html/sisu-txt.1.html b/data/doc/sisu/html/sisu-txt.1.html index 2479cd8e..3edb168f 100644 --- a/data/doc/sisu/html/sisu-txt.1.html +++ b/data/doc/sisu/html/sisu-txt.1.html @@ -32,6 +32,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -42,6 +44,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> . <p> diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 67867294..1a598784 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -18,20 +18,20 @@ sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] <p> sisu [-CcFLSVvW] <p> sisu --v2 [operations] -<p> sisu --v1 [operations] SISU - MANUAL, -RALPH AMISSAH +<p> sisu --v3 [operations] +<p> sisu3 [operations] +SISU - MANUAL, RALPH AMISSAH <p> WHAT IS SISU? <p> 1. INTRODUCTION - WHAT IS SISU? -<p> <b>SiSU</b> is -a framework for document structuring, publishing (in multiple open standard -formats) and search, comprising of: (a) a lightweight document structure -and presentation markup syntax; and (b) an accompanying engine for generating -standard document format outputs from documents prepared in sisu markup -syntax, which is able to produce multiple standard outputs (including the -population of sql databases) that (can) share a common numbering system -for the citation of text within a document. -<p> <b>SiSU</b> is developed under an -open source, software libre license (GPL3). Its use case for development +<p> <b>SiSU</b> is a framework for document structuring, publishing (in multiple +open standard formats) and search, comprising of: (a) a lightweight document +structure and presentation markup syntax; and (b) an accompanying engine +for generating standard document format outputs from documents prepared +in sisu markup syntax, which is able to produce multiple standard outputs +(including the population of sql databases) that (can) share a common numbering +system for the citation of text within a document. +<p> <b>SiSU</b> is developed under +an open source, software libre license (GPL3). Its use case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output @@ -128,158 +128,159 @@ system to reliably reference its documents. <b>SiSU</b> works well in a compleme manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in <b>SiSU</b> <p> -<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > <p> 2. COMMANDS SUMMARY -<p> 2.1 DESCRIPTION -<p> <b>SiSU</b> <b>SiSU</b> -is a document publishing system, that from a simple single marked-up document, -produces multiple of output formats including: plaintext, html, xhtml, -XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), -which share numbered text objects ("object citation numbering") and the -same document structure information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> 2.1 + +<p>DESCRIPTION +<p> <b>SiSU</b> <b>SiSU</b> is a document publishing system, that from a simple +single marked-up document, produces multiple of output formats including: +plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and +SQL (PostgreSQL and SQLite), which share numbered text objects ("object +citation numbering") and the same document structure information. For more +see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > - <p> 2.2 DOCUMENT PROCESSING COMMAND FLAGS <p> <dl> -<dt><b>-a [filename/wildcard]</b> </dt> -<dd>produces plaintext -with Unix linefeeds and without markup, (object numbers are omitted), has -footnotes at end of each paragraph that contains them [ -A for equivalent - dos (linefeed) output file] [see -e for (Options include: --endnotes for endnotes ---footnotes for footnotes at the end of each paragraph --unix for unix linefeed -(default) --msdos for msdos linefeed) +<dt><b>-a [filename/wildcard]</b> +</dt> +<dd>produces plaintext with Unix linefeeds and without markup, (object numbers +are omitted), has footnotes at end of each paragraph that contains them +[ -A for equivalent dos (linefeed) output file] [see -e for -A endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) <p> </dd> -<dt><b>-b [filename/wildcard]</b> </dt> +<dt><b>-b +[filename/wildcard]</b> </dt> <dd>see --xhtml <p> </dd> -<dt><b>--color-toggle -[filename/wildcard]</b> </dt> -<dd>screen toggle ansi screen colour on or off depending -on default set (unless -c flag is used: if sisurc colour default is set -to ’true’, output to screen will be with colour, if sisurc colour default -is set to ’false’ or is undefined screen output will be without colour). Alias +<dt><b>--color-toggle [filename/wildcard]</b> </dt> +<dd>screen toggle +ansi screen colour on or off depending on default set (unless -c flag is +used: if sisurc colour default is set to ’true’, output to screen will be +with colour, if sisurc colour default is set to ’false’ or is undefined screen +output will be without colour). Alias -c +<p> </dd> -<p>- -<p>c +<dt><b>--concordance [filename/wildcard]</b> +</dt> +<dd>produces concordance (wordmap) a rudimentary index of all the words in +a document. (Concordance files are not generated for documents of over 260,000 +words unless this limit is increased in the file sisurc.yml). Alias -w <p> </dd> -<dt><b>--concordance [filename/wildcard]</b> </dt> -<dd>produces concordance (wordmap) a rudimentary -index of all the words in a document. (Concordance files are not generated -for documents of over 260,000 words unless this limit is increased in the -file sisurc.yml). Alias -w +<dt><b>-C +[--init-site]</b> </dt> +<dd>configure/initialise shared output directory files initialize +shared output directory (config files such as css and dtd files are not +updated if they already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force +update, existing shared output config files such as css and dtd files are +updated if this modifier is used. <p> </dd> -<dt><b>-C [--init-site]</b> </dt> +<dt><b>-CC</b> </dt> <dd>configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier -is used). -C --init-site configure/initialise site more extensive than -C on -its own, shared output directory files/force update, existing shared output -config files such as css and dtd files are updated if this modifier is -used. +is used). The equivalent of: -C --init-site configure/initialise site, more +extensive than -C on its own, shared output directory files/force update, +existing shared output config files such as css and dtd files are updated +if -CC is used. <p> </dd> -<dt><b>-CC</b> </dt> -<dd>configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd files are not -updated if they already exist unless modifier is used). The equivalent of: --C --init-site configure/initialise site, more extensive than -C on its own, -shared output directory files/force update, existing shared output config -files such as css and dtd files are updated if -CC is used. +<dt><b>-c [filename/wildcard]</b> </dt> +<dd>see --color-toggle <p> </dd> -<dt><b>-c [filename/wildcard]</b> +<dt><b>--dal [filename/wildcard/url]</b> </dt> -<dd> -<p>see --color-toggle +<dd>assumed for most other flags, creates new intermediate files for processing +(document abstraction) that is used in all subsequent processing of other +output. This step is assumed for most processing flags. To skip it see -n. + +<p>Alias -m <p> </dd> -<dt><b>--dal [filename/wildcard/url]</b> </dt> -<dd>assumed for most other flags, -creates new intermediate files for processing (document abstraction) that -is used in all subsequent processing of other output. This step is assumed -for most processing flags. To skip it see -n. Alias -m +<dt><b>--delete [filename/wildcard]</b> </dt> +<dd>see --zap <p> </dd> -<dt><b>--delete [filename/wildcard]</b> +<dt><b>-D [instruction] [filename]</b> </dt> <dd> -<p>see --zap +<p>see --pg <p> </dd> -<dt><b>-D [instruction] [filename]</b> </dt> -<dd>see --pg -<p> </dd> - -<dt><b>-d [--db-[database type (sqlite|pg)]] ---[instruction] [filename]</b> </dt> +<dt><b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]</b> </dt> <dd>see --sqlite + <p> </dd> <dt><b>--epub [filename/wildcard]</b> </dt> -<dd>produces -an epub document, [sisu version 2 only] (filename.epub). Alias -e +<dd>produces an epub document, [sisu version 2 only] +(filename.epub). Alias -e +<p> </dd> + +<dt><b>-e [filename/wildcard]</b> </dt> +<dd>see --epub <p> </dd> -<dt><b>-e [filename/wildcard]</b> +<dt><b>-F [--webserv=webrick]</b> </dt> <dd> -<p>see --epub +<p>see --sample-search-form <p> </dd> -<dt><b>-F [--webserv=webrick]</b> </dt> -<dd>see --sample-search-form -<p> </dd> +<dt><b>--git [filename/wildcard]</b> </dt> +<dd>produces or updates markup +source file structure in a git repo (experimental and subject to change). -<dt><b>--git [filename/wildcard]</b> -</dt> -<dd>produces or updates markup source file structure in a git repo (experimental -and subject to change). Alias -g +<p>Alias -g <p> </dd> <dt><b>-g [filename/wildcard]</b> </dt> <dd>see --git <p> </dd> -<dt><b>--harvest -*.ss[tm]</b> </dt> -<dd>makes two lists of sisu output based on the sisu markup documents -in a directory: list of author and authors works (year and titles), and; -list by topic with titles and author. Makes use of header metadata fields -(author, title, date, topic_register). Can be used with maintenance (-M) -and remote placement (-R) flags. +<dt><b>--harvest *.ss[tm]</b> </dt> +<dd>makes two lists +of sisu output based on the sisu markup documents in a directory: list +of author and authors works (year and titles), and; list by topic with +titles and author. Makes use of header metadata fields (author, title, date, +topic_register). Can be used with maintenance (-M) and remote placement (-R) +flags. <p> </dd> <dt><b>--help [topic]</b> </dt> -<dd>provides help on the selected -topic, where topics (keywords) include: list, (com)mands, short(cuts), -(mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, -tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, -install, setup, (conf)igure, convert, termsheet, search, sql, features, - -<p>license +<dd>provides help on the selected topic, where topics (keywords) +include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, +syntax, headers, headings, endnotes, tables, example, customise, skin, +(dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, +termsheet, search, sql, features, license <p> </dd> <dt><b>--html [filename/wildcard]</b> </dt> -<dd>produces html output, segmented text -with table of contents (toc.html and index.html) and the document in a single -file (scroll.html). Alias -h -<p> </dd> - -<dt><b>-h [filename/wildcard]</b> </dt> -<dd>see --html +<dd>produces +html output, segmented text with table of contents (toc.html and index.html) +and the document in a single file (scroll.html). Alias -h <p> </dd> -<dt><b>-I [filename/wildcard]</b> +<dt><b>-h [filename/wildcard]</b> </dt> <dd> -<p>see --texinfo +<p>see --html +<p> </dd> + +<dt><b>-I [filename/wildcard]</b> </dt> +<dd>see --texinfo <p> </dd> <dt><b>-i [filename/wildcard]</b> </dt> @@ -288,83 +289,102 @@ file (scroll.html). Alias -h <dt><b>-L</b> </dt> <dd>prints license information. - <p> </dd> -<dt><b>--machine [filename/wildcard/url]</b> </dt> +<dt><b>--machine [filename/wildcard/url]</b> +</dt> <dd>see --dal (document abstraction level/layer) - <p> </dd> -<dt><b>--maintenance [filename/wildcard/url]</b> </dt> -<dd>maintenance mode files created for -processing preserved and their locations indicated. (also see -V). Alias -M - +<dt><b>--maintenance [filename/wildcard/url]</b> +</dt> +<dd>maintenance mode files created for processing preserved and their locations +indicated. (also see -V). Alias -M <p> </dd> <dt><b>--manpage [filename/wildcard]</b> </dt> -<dd>produces man page of file, not suitable for -all outputs. Alias -i +<dd>produces man +page of file, not suitable for all outputs. Alias -i <p> </dd> -<dt><b>-M [filename/wildcard/url]</b> </dt> -<dd>see --maintenance +<dt><b>-M [filename/wildcard/url]</b> +</dt> +<dd> +<p>see --maintenance <p> </dd> -<dt><b>-m [filename/wildcard/url]</b> -</dt> -<dd>see --dal (document abstraction level/layer) +<dt><b>-m [filename/wildcard/url]</b> </dt> +<dd>see --dal (document abstraction +level/layer) <p> </dd> <dt><b>--no-ocn</b> </dt> -<dd>[with --html --pdf or --epub] -switches off object citation numbering. Produce output without identifying -numbers in margins of html or LaTeX/pdf output. +<dd>[with --html --pdf or --epub] switches off object citation +numbering. Produce output without identifying numbers in margins of html +or LaTeX/pdf output. <p> </dd> -<dt><b>-N [filename/wildcard/url]</b> -</dt> -<dd>document digest or document content certificate ( DCC ) as md5 digest tree -of the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). -NV for verbose digest output to screen. +<dt><b>-N [filename/wildcard/url]</b> </dt> +<dd>document digest or document +content certificate ( DCC ) as md5 digest tree of the document: the digest +for the document, and digests for each object contained within the document +(together with information on software versions that produced it) (digest.txt). +-NV for verbose digest output to screen. <p> </dd> -<dt><b>-n -[filename/wildcard/url]</b> </dt> -<dd>skip the creation of intermediate processing files -(document abstraction) if they already exist, this skips the equivalent -of -m which is otherwise assumed by most processing flags. +<dt><b>-n [filename/wildcard/url]</b> </dt> +<dd>skip +the creation of intermediate processing files (document abstraction) if +they already exist, this skips the equivalent of -m which is otherwise assumed +by most processing flags. <p> </dd> -<dt><b>--odf [filename/wildcard/url]</b> -</dt> -<dd> -<p>see --odt +<dt><b>--odf [filename/wildcard/url]</b> </dt> +<dd>see --odt <p> </dd> -<dt><b>--odt [filename/wildcard/url]</b> </dt> -<dd>output basic document in opendocument -file format (opendocument.odt). Alias -o +<dt><b>--odt [filename/wildcard/url]</b> +</dt> +<dd>output basic document in opendocument file format (opendocument.odt). Alias + +<p>- +<p>o <p> </dd> <dt><b>-o [filename/wildcard/url]</b> </dt> <dd>see --odt - <p> </dd> <dt><b>--pdf [filename/wildcard]</b> </dt> -<dd>produces LaTeX pdf (portrait.pdf & landscape.pdf). -Default paper size is set in config file, or document header, or provided -with additional command line parameter, e.g. --papersize-a4 preset sizes include: -’A4’, U.S. ’letter’ and +<dd>produces +LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config +file, or document header, or provided with additional command line parameter, +e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and +<p> </dd> + +<dt><b>--pg [instruction] +[filename]</b> </dt> +<dd>database postgresql ( --pgsql may be used instead) possible instructions, +include: --createdb; --create; --dropall; --import [filename]; --update [filename]; +--remove [filename]; see database section below. Alias -D <p> </dd> -<dt><b>--pg [instruction] [filename]</b> </dt> -<dd>database postgresql ( --pgsql -may be used instead) possible instructions, include: --createdb; --create; ---dropall; --import [filename]; --update [filename]; --remove [filename]; see database -section below. Alias -D +<dt><b>--po [language_directory/filename + language_directory]</b> </dt> +<dd>see --po4a +<p> </dd> + +<dt><b>--po4a [language_directory/filename language_directory]</b> +</dt> +<dd>produces .pot and po files for the file in the languages specified by the +language directory. <b>SiSU</b> markup is placed in subdirectories named with the +language code, e.g. en/ fr/ es/. The sisu config file must set the output +directory structure to multilingual. v3, experimental +<p> </dd> + +<dt><b>-P [language_directory/filename + language_directory]</b> </dt> +<dd>see --po4a <p> </dd> <dt><b>-p [filename/wildcard]</b> </dt> @@ -438,8 +458,8 @@ below. Alias -d files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] -option. Note: (this<br> - option is tested only with zsh). Alias -S +option. Note: (this option<br> + is tested only with zsh). Alias -S <p> </dd> <dt><b>--sisupod [filename/wildcard]</b> </dt> @@ -490,47 +510,43 @@ file to output directory. Alias -s </dt> <dd>produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them -[ -A for equivalent dos (linefeed) output file] [see -e for (Options include: ---endnotes for endnotes --footnotes for footnotes at the end of each paragraph ---unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t +[ -A for equivalent dos (linefeed) output file] [see -e for -A endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias + +<p>- +<p>t <p> </dd> -<dt><b>-T [filename/wildcard - (*.termsheet.rb)]</b> </dt> -<dd>standard form document builder, preprocessing feature -<p> -</dd> +<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> +<dd>standard form document builder, + +<p>preprocessing feature +<p> </dd> <dt><b>-t [filename/wildcard]</b> </dt> <dd>see --txt <p> </dd> -<dt><b>--urls [filename/wildcard]</b> </dt> -<dd>prints url output -list/map for the available processing flags options and resulting files -that could be requested, (can be used to get a list of processing options -in relation to a file, together with information on the output that would -be produced), -u provides url output mapping for those flags requested for -processing. The default assumes sisu_webrick is running and provides webrick -url mappings where appropriate, but these can be switched to file system -paths in sisurc.yml. Alias -U +<dt><b>--urls [filename/wildcard]</b> +</dt> +<dd>prints url output list/map for the available processing flags options and +resulting files that could be requested, (can be used to get a list of +processing options in relation to a file, together with information on +the output that would be produced), -u provides url output mapping for those +flags requested for processing. The default assumes sisu_webrick is running +and provides webrick url mappings where appropriate, but these can be switched +to file system paths in sisurc.yml. Alias -U <p> </dd> <dt><b>-U [filename/wildcard]</b> </dt> <dd>see --urls -<p> </dd> - -<dt><b>-u [filename/wildcard]</b> -</dt> -<dd>provides url mapping of output files for the flags requested for processing, -<p>also see -U <p> </dd> -<dt><b>--v1 [filename/wildcard]</b> </dt> -<dd>invokes the sisu v1 document parser/generator. -For use with sisu v1 markup documents. (Markup conversion to v2 involves -the modification of document headers) +<dt><b>-u [filename/wildcard]</b> </dt> +<dd>provides url mapping of output files for the flags +requested for processing, also see -U <p> </dd> <dt><b>--v2 [filename/wildcard]</b> </dt> @@ -539,75 +555,79 @@ sisu v2 document parser/generator. This is the default and is normally omitted. <p> </dd> -<dt><b>--verbose [filename/wildcard]</b> </dt> -<dd>provides verbose output of what is being generated, -where output is placed (and error messages if any), as with -u flag provides -a url mapping of files created for each of the processing flag requests. +<dt><b>--v3 [filename/wildcard]</b> </dt> +<dd>invokes the sisu v3 document parser/generator. Currently +under development and incomplete, v3 requires >= ruby1.9.2p180. You may run +sisu3 instead. +<p> </dd> -<p>Alias -v +<dt><b>--verbose [filename/wildcard]</b> </dt> +<dd>provides verbose output of what +is being generated, where output is placed (and error messages if any), +as with -u flag provides a url mapping of files created for each of the +processing flag requests. Alias -v <p> </dd> <dt><b>-V</b> </dt> -<dd>on its own, provides <b>SiSU</b> version and environment information -(sisu --help env) +<dd>on its own, provides <b>SiSU</b> version and +environment information (sisu --help env) <p> </dd> <dt><b>-V [filename/wildcard]</b> </dt> -<dd>even more verbose than the -v flag. - +<dd>even more +verbose than the -v flag. <p> </dd> <dt><b>-v</b> </dt> <dd>on its own, provides <b>SiSU</b> version information + <p> </dd> -<dt><b>-v [filename/wildcard]</b> -</dt> -<dd> -<p>see --verbose +<dt><b>-v [filename/wildcard]</b> </dt> +<dd>see --verbose <p> </dd> <dt><b>--webrick</b> </dt> -<dd>starts ruby’s webrick webserver points at sisu output -directories, the default port is set to 8081 and can be changed in the -resource configuration files. [tip: the webrick server requires link suffixes, - so html output should be created using the -h option rather than and search --H ; also, note -F webrick ]. Alias -W +<dd>starts ruby’s webrick webserver +points at sisu output directories, the default port is set to 8081 and +can be changed in the resource configuration files. [tip: the webrick server + requires link suffixes, so html output should be created using the -h option + rather than -H ; also, note -F webrick ]. Alias -W <p> </dd> <dt><b>-W</b> </dt> <dd>see --webrick <p> </dd> -<dt><b>--wordmap [filename/wildcard]</b> -</dt> -<dd> -<p>see --concordance +<dt><b>--wordmap +[filename/wildcard]</b> </dt> +<dd>see --concordance <p> </dd> <dt><b>-w [filename/wildcard]</b> </dt> <dd>see --concordance -<p> </dd> -<dt><b>--xhtml [filename/wildcard]</b> -</dt> -<dd>produces xhtml/XML output for browser viewing (sax parsing). Alias -b <p> </dd> -<dt><b>--xml-dom -[filename/wildcard]</b> </dt> -<dd>produces XML output with deep document structure, in -the nature of dom. Alias -X +<dt><b>--xhtml [filename/wildcard]</b> </dt> +<dd>produces xhtml/XML output for browser viewing +(sax parsing). Alias -b <p> </dd> -<dt><b>--xml-sax [filename/wildcard]</b> </dt> -<dd>produces XML output -shallow structure (sax parsing). Alias -x +<dt><b>--xml-dom [filename/wildcard]</b> </dt> +<dd>produces XML output with +deep document structure, in the nature of dom. Alias -X <p> </dd> -<dt><b>-X [filename/wildcard]</b> </dt> -<dd>see --xml-dom +<dt><b>--xml-sax [filename/wildcard]</b> +</dt> +<dd>produces XML output shallow structure (sax parsing). Alias -x +<p> </dd> +<dt><b>-X [filename/wildcard]</b> +</dt> +<dd> +<p>see --xml-dom <p> </dd> <dt><b>-x [filename/wildcard]</b> </dt> @@ -615,8 +635,8 @@ shallow structure (sax parsing). Alias -x <p> </dd> <dt><b>-Y [filename/wildcard]</b> </dt> -<dd>produces a short -sitemap entry for the document, based on html output and the sisu_manifest. +<dd>produces +a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week]) <p> </dd> @@ -682,60 +702,60 @@ modifiable with --db=[database type (pgsql or sqlite)] <dd>initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name -as working directory, as requested) (rb.dbi) [ -dv --createall sqlite equivalent] -it may be necessary to run sisu -Dv --createdb initially NOTE: at the present -time for postgresql it may be necessary to manually create the database. -The command would be ’createdb [database name]’ where database name would -be SiSU_[present working directory name (without path)]. Please use only -alphanumerics and underscores. +as working directory, as requested) (rb.dbi) [ -dv --createall it may be necessary +to run sisu -Dv --createdb initially NOTE: at the present time for postgresql +it may be necessary to manually create the database. The command would be +’createdb [database name]’ where database name would be SiSU_[present working + directory name (without path)]. Please use only alphanumerics and underscores. + <p> </dd> <dt><b>--pg -v --import</b> </dt> -<dd>[filename/wildcard] imports -data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] - +<dd>[filename/wildcard] imports data specified to postgresql db +(rb.dbi) [ -dv --import sqlite equivalent] <p> </dd> <dt><b>--pg -v --update</b> </dt> -<dd>[filename/wildcard] updates/imports specified data to postgresql -db (rb.dbi) [ -dv --update sqlite equivalent] +<dd>[filename/wildcard] +updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite + equivalent] <p> </dd> <dt><b>--pg --remove</b> </dt> -<dd>[filename/wildcard] -removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] - +<dd>[filename/wildcard] removes specified data to postgresql +db (rb.dbi) [ -d --remove sqlite equivalent] <p> </dd> <dt><b>--pg --dropall</b> </dt> -<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes -[ -d --dropall sqlite equivalent] +<dd>kills data" and drops +(postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] + <p> The -v is for verbose output. <p> </dd> </dl> -5. SHORTCUTS, -SHORTHAND FOR MULTIPLE FLAGS +5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS + <p> <dl> <dt><b>--update [filename/wildcard]</b> </dt> -<dd>Checks existing -file output and runs the flags required to update this output. This means -that if only html and pdf output was requested on previous runs, only the --hp files will be applied, and only these will be generated this time, together -with the summary. This can be very convenient, if you offer different outputs -of different files, and just want to do the same again. +<dd>Checks existing file output and runs the flags +required to update this output. This means that if only html and pdf output +was requested on previous runs, only the -hp files will be applied, and +only these will be generated this time, together with the summary. This +can be very convenient, if you offer different outputs of different files, +and just want to do the same again. <p> </dd> -<dt><b>-0 to -5 [filename - or wildcard]</b> </dt> -<dd>Default shorthand mappings (note that the defaults can be -changed/configured in the sisurc.yml file): +<dt><b>-0 to -5 [filename or wildcard]</b> </dt> +<dd>Default +shorthand mappings (note that the defaults can be changed/configured in +the sisurc.yml file): <p> </dd> <dt><b>-0</b> </dt> -<dd>-mNhwpAobxXyYv [this is the - default action run when no i.e. on ’sisu [filename]’] +<dd>-mNhwpAobxXyYv [this is the default action run when + no i.e. on ’sisu [filename]’] <p> </dd> <dt><b>-1</b> </dt> @@ -744,7 +764,6 @@ changed/configured in the sisurc.yml file): <dt><b>-2</b> </dt> <dd>-mhewpaoy - <p> </dd> <dt><b>-3</b> </dt> @@ -752,38 +771,43 @@ changed/configured in the sisurc.yml file): <p> </dd> <dt><b>-4</b> </dt> -<dd>-mhewpAobxXDyY --import +<dd>-mhewpAobxXDyY + +<p>- +<p>- +<p>import <p> </dd> <dt><b>-5</b> </dt> <dd>-mhewpAobxXDyY --update -<p> add -v -for verbose mode and -c for color, e.g. sisu -2vc [filename or -<p> consider -u +<p> add -v for verbose mode and -c for color, +e.g. sisu -2vc [filename or +<p> consider -u for appended url info or -v for verbose -<p>for appended url info or -v for verbose output +<p>output <p> </dd> </dl> -5.1 COMMAND LINE WITH FLAGS -- BATCH PROCESSING -<p> In the data directory run sisu -mh filename or wildcard -eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all -documents. -<p> Running sisu (alone without any flags, filenames or wildcards) -brings up the interactive help, as does any sisu command that is not recognised. -Enter to escape. +5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +<p> In the data directory +run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" +to produce html version of all documents. +<p> Running sisu (alone without +any flags, filenames or wildcards) brings up the interactive help, as does +any sisu command that is not recognised. Enter to escape. <p> 6. HELP -<p> 6.1 SISU MANUAL -<p> The most up to date information -on sisu should be contained in the sisu_manual, available at: +<p> 6.1 SISU + +<p>MANUAL +<p> The most up to date information on sisu should be contained in +the sisu_manual, available at: <p> <<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a> ><br> <p> The manual can be generated from source, found respectively, either within the <b>SiSU</b> tarball or installed locally at: -<p> ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/<br> +<p> ./data/doc/sisu/markup-samples/sisu_manual<br> -<p> /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/<br> +<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br> <p> move to the respective directory and type e.g.: <p> sisu sisu_manual.ssm<br> @@ -800,15 +824,15 @@ should be available, try: <p> Most <b>SiSU</b> man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the <b>SiSU</b> tarball at: -<p> ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/<br> +<p> ./data/doc/sisu/markup-samples/sisu_manual<br> <p> Once installed, directory equivalent to: -<p> /usr/share/doc/sisu/sisu_manual/<br> +<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br> <p> Available man pages are converted back to html using man2html: -<p> /usr/share/doc/sisu/v2/html/<br> +<p> /usr/share/doc/sisu/html/<br> -<p> ./data/doc/sisu/v2/html/<br> +<p> ./data/doc/sisu/html<br> <p> An online version of the sisu man page is available here: <p> * various @@ -851,6 +875,9 @@ see: <p> <b>man2html</b> <p> /usr/share/doc/sisu/v2/html/sisu.1.html<br> +<p> <b>sisu generated html</b> +<p> /usr/share/doc/sisu/html/sisu_help_sources/index.html<br> + <p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> ><br> @@ -982,17 +1009,18 @@ that has a header similar to this one: <p> Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All -header instructions take either the form @headername: or 0~headername. All +header instructions take the form @headername: or on the next line and +indented by once space :subheadername: All Dublin Core meta tags are available -<p>Dublin Core meta tags are available <p> <b>@indentifier:</b> information or instructions +<p> where the "identifier" is +a tag recognised by the program, and the "information" or "instructions" + +<p>belong to the tag/indentifier specified +<p> Note: a header where used should +only be used once; all headers apart from @title: are optional; the @structure: +header is used to describe document structure, and can be useful to know. -<p> where the "identifier" is a tag recognised by the program, and the "information" -or "instructions" belong to the tag/indentifier specified -<p> Note: a header -where used should only be used once; all headers apart from @title: are -optional; the @structure: header is used to describe document structure, -and can be useful to know. <p> This is a sample header <p> <p> <br> @@ -1040,7 +1068,7 @@ and can be useful to know. :pg: [Project Gutenberg text number] </pre> <p> <br> -<pre> @links: { SiSU }http://www.jus.uio.no/sisu/ +<pre> @links: { SiSU }http://www.sisudoc.org { FSF }http://www.fsf.org </pre> <p> <br> @@ -1072,21 +1100,22 @@ by other heading levels, and 1 -6 being headings followed by substantive text or sub-headings. :A~ usually the title :A~? conditional level 1 heading (used where a stand-alone document may be imported into another) <p> <b>:A~ [heading - text]</b> Top level heading [this usually has similar content to the ] NOTE: -the heading levels described here are in 0.38 notation, see heading -<p> <b>:B~ -[heading text]</b> Second level heading [this is a heading level divider] -<p> - <b>:C~ [heading text]</b> Third level heading [this is a heading level divider] - -<p> <b>1~ [heading text]</b> Top level heading preceding substantive text of document -or sub-heading 2, the heading level that would normally be marked 1. or 2. -or 3. etc. in a document, and the level on which sisu by default would break -html output into named segments, names are provided automatically if none -are given (a number), otherwise takes the form 1~my_filename_for_this_segment + text]</b> Top level heading [this usually has similar content to the title + @title: ] NOTE: the heading levels described here are in 0.38 notation, + +<p>see heading +<p> <b>:B~ [heading text]</b> Second level heading [this is a heading + level divider] +<p> <b>:C~ [heading text]</b> Third level heading [this is a heading + level divider] +<p> <b>1~ [heading text]</b> Top level heading preceding substantive +text of document or sub-heading 2, the heading level that would normally +be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by +default would break html output into named segments, names are provided +automatically if none are given (a number), otherwise takes the form 1~my_filename_for_this_segment <p> <b>2~ [heading text]</b> Second level heading preceding substantive text of -document or sub-heading 3, the heading level that would normally be marked +document or sub-heading 3 , the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. <p> <b>3~ [heading text]</b> Third level heading preceding substantive text of document, that would normally be @@ -1106,13 +1135,14 @@ html <p> <br> <pre> normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- #{monospace}# + ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text - !{emphasis}! - *{bold text}* + *{emphasis}* [note: can be configured to be represented by bold, italics + or underscore] + !{bold text}! _{underscore}_ /{italics}/ - + "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+ @@ -1120,12 +1150,13 @@ html #{monospace}# </pre> <p> <b>resulting output:</b> -<p> normal text <b>emphasis</b> <b>bold text</b> <i>underscore</i> <i>italics</i> -"citation" ^superscript^ [subscript] ++inserted text++ --strikethrough-- monospace +<p> normal text, <b>emphasis</b> , <b>bold text</b> , <i>italics</i> , <i>underscore</i> +, "citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, +<p>monospace <p> normal text -<p> <b>emphasis</b> [note: can be configured to be represented by - bold, italics or underscore] +<p> <b>emphasis</b> [note: can be configured to be represented + by bold, italics or underscore] <p> <b>bold text</b> <p> <i>italics</i> <p> <i>underscore</i> @@ -1177,10 +1208,11 @@ html _# numbered list numbered list indented a., b., c., d., etc. </pre> <p> 9.4 FOOTNOTES / ENDNOTES -<p> Footnotes and endnotes not distinguished in -markup. They are automatically numbered. Depending on the output file format -(html, EPUB, odf, pdf etc.), the document output selected will have either -footnotes or endnotes. +<p> Footnotes and endnotes are marked up at the +location where they would be indicated within a text. They are automatically +numbered. The output type determines whether footnotes or endnotes will + +<p>be produced <p> <b>markup example:</b> <p> <p> <br> @@ -1221,7 +1253,7 @@ asterisks if required }~ continues <p> <b>Alternative endnote pair notation for footnotes/endnotes:</b> <p> <p> <br> -<pre> % note the endnote marker +<pre> % note the endnote marker "~^" normal text~^ continues ^~ endnote text following the paragraph in which the marker occurs </pre> @@ -1239,10 +1271,10 @@ is omitted). <p> <b>markup example:</b> <p> <p> <br> -<pre> normal text http://www.jus.uio.no/sisu continues +<pre> normal text http://www.sisudoc.org/ continues </pre> <p> <b>resulting output:</b> -<p> normal text <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> normal text <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > continues <p> An @@ -1250,70 +1282,74 @@ is omitted). <p> <b>markup example:</b> <p> <p> <br> -<pre> normal text _http://www.jus.uio.no/sisu continues +<pre> normal text _http://www.sisudoc.org/ continues deb http://www.jus.uio.no/sisu/archive unstable main non-free </pre> <p> <b>resulting output:</b> -<p> normal text <_<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> normal text <_<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > continues -<p> -deb <_<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> +<p> deb +<_<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> > unstable main non-free -<p> where a code -block is used there is neither decoration nor hyperlinking, code blocks +<p> where a code block +is used there is neither decoration nor hyperlinking, code blocks are discussed -<p>are discussed later in this document +<p>later in this document <p> <b>resulting output:</b> <p> <p> <br> <pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free deb-src http://www.jus.uio.no/sisu/archive unstable main non-free </pre> -<p> To link text or an image to a url the markup is as follows -<p> <b>markup example:</b> +<p> 9.5.2 LINKING TEXT +<p> To link text or an image to a url the markup is as +<p>follows +<p> <b>markup example:</b> <p> <p> <br> <pre> about { SiSU }http://url.org markup </pre> -<p> 9.5.2 LINKING TEXT <p> <b>resulting output:</b> -<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> -> +<p> aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> markup +<p> A shortcut -<p>markup -<p> A shortcut notation is available so the url link may also be provided +<p>notation is available so the url link may also be provided automatically -<p>automatically as a footnote +<p>as a footnote <p> <b>markup example:</b> <p> <p> <br> <pre> about {~^ SiSU }http://url.org markup </pre> <p> <b>resulting output:</b> -<p> abou tSiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +<p> about SiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > [^14] markup -<p> +<p> 9.5.3 -<p>9.5.3 LINKING IMAGES +<p>LINKING IMAGES <p> <b>markup example:</b> <p> <p> <br> <pre> { tux.png 64x80 }image % various url linked images - {tux.png 64x80 - {GnuDebianLinuxRubyBetterWay.png 100x101 - {~^ ruby_logo.png + {tux.png 64x80 "a better way" }http://www.sisudoc.org/ + {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, +Debian and Ruby" }http://www.sisudoc.org/ + {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ </pre> <p> <b>resulting output:</b> <p> [ tux.png ] -<p> tux.png 64x80 -<p> [ ruby_logo (png missing) - ] [^15] -<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby -<p> <b>linked url footnote +<p> tux.png 64x80 "Gnu/Linux - a better way" +<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +<p> [ ruby_logo (png missing) ] [^15] +<p> GnuDebianLinuxRubyBetterWay.png +100x101 "Way Better - with Gnu/Linux, Debian and Ruby" <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +> -<p>shortcut</b> +<p> <b>linked url footnote shortcut</b> <p> <p> <br> <pre> {~^ [text to link] }http://url.org @@ -1347,7 +1383,7 @@ auto-heading numbering, without further intervention. }table </pre> <p> <b>resulting output:</b> -<p> [table omitted, see other document formats]<br> +<p> [table omitted, see other document formats]<br> <p> a second form may be easier to work with in cases where there is not @@ -1375,7 +1411,7 @@ auto-heading numbering, without further intervention. <p> <b>resulting output:</b> <p> <b>Table 3.1: Contributors to Wikipedia, January 2001 - June 2005</b> -<p> [table omitted, see other document formats]<br> +<p> [table omitted, see other document formats]<br> <p> * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. @@ -1386,7 +1422,7 @@ auto-heading numbering, without further intervention. <pre> poem{ Your poem here }poem - Each verse in a poem is given a separate object number. + Each verse in a poem is given an object number. </pre> <p> <b>markup example:</b> <p> @@ -1396,7 +1432,7 @@ auto-heading numbering, without further intervention. mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1408,10 +1444,10 @@ auto-heading numbering, without further intervention. really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1420,14 +1456,14 @@ auto-heading numbering, without further intervention. would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1435,15 +1471,15 @@ auto-heading numbering, without further intervention. condemn you to - death. + death."’ }poem </pre> <p> <b>resulting output:</b> -<p> ’Fury said to a<br> +<p> ‘Fury said to a<br> mouse, That he<br> met in the<br> house,<br> - <br> + "Let us<br> both go to<br> law: I will<br> prosecute<br> @@ -1455,10 +1491,10 @@ auto-heading numbering, without further intervention. really this<br> morning I’ve<br> nothing<br> - to do.<br> + to do."<br> Said the<br> mouse to the<br> - cur,<br> + cur, "Such<br> a trial,<br> dear Sir,<br> With<br> @@ -1467,14 +1503,14 @@ auto-heading numbering, without further intervention. would be<br> wasting<br> our<br> - breath.<br> - <br> + breath."<br> + "I’ll be<br> judge, I’ll<br> - be jury,<br> + be jury,"<br> Said<br> cunning<br> old Fury:<br> - <br> + "I’ll<br> try the<br> whole<br> cause,<br> @@ -1482,7 +1518,7 @@ auto-heading numbering, without further intervention. condemn<br> you<br> to<br> - death.<br> + death."’<br> <p> 9.6.3 GROUP <p> <b>basic markup:</b> @@ -1501,7 +1537,7 @@ auto-heading numbering, without further intervention. mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1513,10 +1549,10 @@ auto-heading numbering, without further intervention. really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1525,14 +1561,14 @@ auto-heading numbering, without further intervention. would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1540,15 +1576,15 @@ auto-heading numbering, without further intervention. condemn you to - death. + death."’ }group </pre> <p> <b>resulting output:</b> -<p> ’Fury said to a<br> +<p> ‘Fury said to a<br> mouse, That he<br> met in the<br> house,<br> - <br> + "Let us<br> both go to<br> law: I will<br> prosecute<br> @@ -1560,10 +1596,10 @@ auto-heading numbering, without further intervention. really this<br> morning I’ve<br> nothing<br> - to do.<br> + to do."<br> Said the<br> mouse to the<br> - cur,<br> + cur, "Such<br> a trial,<br> dear Sir,<br> With<br> @@ -1572,14 +1608,14 @@ auto-heading numbering, without further intervention. would be<br> wasting<br> our<br> - breath.<br> - <br> + breath."<br> + "I’ll be<br> judge, I’ll<br> - be jury,<br> + be jury,"<br> Said<br> cunning<br> old Fury:<br> - <br> + "I’ll<br> try the<br> whole<br> cause,<br> @@ -1587,26 +1623,25 @@ auto-heading numbering, without further intervention. condemn<br> you<br> to<br> - death.<br> + death."’<br> <p> 9.6.4 CODE -<p> Code tags are used to escape regular sisu markup, and have -been used extensively within this document to provide examples of <b>SiSU</b> -markup. You cannot however use code tags to escape code tags. They are however -used in the same way as group or poem tags. -<p> A code-block is treated as -an object and given a single object number. [an more than 100 times in last -month. option to number each line of code may be considered at more than -100 times in last month. some later time] +<p> Code tags code{ ... }code (used as with other group tags described +above) are used to escape regular sisu markup, and have been used extensively +within this document to provide examples of <b>SiSU</b> markup. You cannot however +use code tags to escape code tags. They are however used in the same way +as group or poem tags. +<p> A code-block is treated as an object and given a +single object number. [an some later time] <p> <b>use of code tags instead of poem compared, resulting output:</b> <p> <p> <br> -<pre> ’Fury said to a +<pre> ‘Fury said to a mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1618,10 +1653,10 @@ poem compared, resulting output:</b> really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1630,14 +1665,14 @@ poem compared, resulting output:</b> would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1645,7 +1680,56 @@ poem compared, resulting output:</b> condemn you to - death. + death."’ +</pre> +<p> From <b>SiSU</b> 2.7.7 on you can number codeblocks by placing a hash after the +opening code tag code{# as demonstrated here: +<p> +<p> <br> +<pre>1 | ‘Fury said to a +2 | mouse, That he +3 | met in the +4 | house, +5 | "Let us +6 | both go to +7 | law: I will +8 | prosecute +9 | YOU. --Come, +10 | I’ll take no +11 | denial; We +12 | must have a +13 | trial: For +14 | really this +15 | morning I’ve +16 | nothing +17 | to do." +18 | Said the +19 | mouse to the +20 | cur, "Such +21 | a trial, +22 | dear Sir, +23 | With +24 | no jury +25 | or judge, +26 | would be +27 | wasting +28 | our +29 | breath." +30 | "I’ll be +31 | judge, I’ll +32 | be jury," +33 | Said +34 | cunning +35 | old Fury: +36 | "I’ll +37 | try the +38 | whole +39 | cause, +40 | and +41 | condemn +42 | you +43 | to +44 | death."’ </pre> <p> 9.7 BOOK INDEX <p> To make an index append to paragraph the book index term @@ -1737,16 +1821,17 @@ of documents under consideration, and occasionally supported have been. <p> MARKUP SYNTAX HISTORY <p> 11. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX -<p> 0.38 is substantially current, depreciated 0.16 supported, though file - -<p>names were changed at 0.37 -<p> * sisu --query=[sisu version [0.38] or ’history] +<p> 2.0 introduced new headers and is therefore incompatible with 1.0 though +otherwise the same with the addition of a couple of tags (i.e. a superset) +<p> 0.38 is substantially current for version 1.0 +<p> * sisu --query=[sisu version + [0.38] or ’history] <p> provides a short history of changes to <b>SiSU</b> markup -<p> <b>0.57</b> (2007w34/4) -<b>SiSU</b> 0.57 is the same as 0.42 with the introduction of some a shortcut to -use the headers @title and @creator in the first heading [expanded using - the and @author:] + +<p> <b>0.57</b> (2007w34/4) <b>SiSU</b> 0.57 is the same as 0.42 with the introduction of +some a shortcut to use the headers @title and @creator in the first heading +[expanded using the and @author:] <p> <p> <br> <pre> :A~ @title by @author @@ -1876,30 +1961,30 @@ may be located locally or on a remote server for which a url is provided. <p> 12.1.1 SISU TEXT - REGULAR FILES (.SST) <p> The most common form of document in <b>SiSU</b> , see the section on <b>SiSU</b> markup. -<p> <<a href='http://www.jus.uio.no/sisu/sisu_markup'>http://www.jus.uio.no/sisu/sisu_markup</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> > -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > <p> 12.1.2 SISU MASTER FILES (.SSM) -<p> Composite -documents which incorporate other <b>SiSU</b> documents which may be either regular -<b>SiSU</b> text .sst which may be generated independently, or inserts prepared -solely for the purpose of being incorporated into one or more master documents. - -<p> The mechanism by which master files incorporate other documents is described -as one of the headings under under <b>SiSU</b> markup in the <b>SiSU</b> manual. -<p> Note: -Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a .sst file is renamed .ssm without -requiring any other documents; the .ssm marker flags that the document may -contain other documents. -<p> Note: a secondary file of the composite document -is built prior to processing with the same prefix and the suffix ._sst [^17] - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_markup'>http://www.jus.uio.no/sisu/sisu_markup</a> +<p> + Composite documents which incorporate other <b>SiSU</b> documents which may be +either regular <b>SiSU</b> text .sst which may be generated independently, or inserts +prepared solely for the purpose of being incorporated into one or more +master documents. +<p> The mechanism by which master files incorporate other +documents is described as one of the headings under under <b>SiSU</b> markup in +the <b>SiSU</b> manual. +<p> Note: Master documents may be prepared in a similar way +to regular documents, and processing will occur normally if a .sst file +is renamed .ssm without requiring any other documents; the .ssm marker flags +that the document may contain other documents. +<p> Note: a secondary file +of the composite document is built prior to processing with the same prefix +and the suffix ._sst [^17] +<p> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> > -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > <p> 12.1.3 SISU INSERT FILES (.SSI) @@ -1935,10 +2020,10 @@ sisu -S<br> <p> <b>SiSU</b> processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. -<p> <<a href='http://www.jus.uio.no/sisu/sisu_commands'>http://www.jus.uio.no/sisu/sisu_commands</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_commands'>http://www.sisudoc.org/sisu/sisu_commands</a> > -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > <p> 13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS @@ -2082,17 +2167,17 @@ and symbolic links as needed from the site, or dir directories as required. <p> With <b>SiSU</b> installed sample skins may be found in: <p> /etc/sisu/skin/doc and<br> - /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc<br> + /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc<br> <p> (or equivalent directory) and if sisu-markup-samples is installed also under: -<p> /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc<br> +<p> /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc<br> <p> Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml -(or equivalent<br> - directory)<br> +<p> /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml +(or<br> + equivalent directory)<br> <p> 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) <p> CSS files @@ -2201,47 +2286,42 @@ index.html and document output samples are provided at <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > -<p> Some markup with syntax highlighting may be found under <<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> -> -but is not as up to date. -<p> For some documents hardly any markup at all -is required at all, other than a header, and an indication that the levels -to be taken into account by the program in generating its output are. -<p> 20. -SISU SEARCH - INTRODUCTION -<p> <b>SiSU</b> output can easily and conveniently be -indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. - -<p> Because the document structure of sites created is clearly defined, and -the text object citation system is available hypothetically at least, for -all forms of output, it is possible to search the sql database, and either -read results from that database, or just as simply map the results to the -html output, which has richer text markup. -<p> In addition to this <b>SiSU</b> has -the ability to populate a relational sql type database with documents at -an object level, with objects numbers that are shared across different -output types, which make them searchable with that degree of granularity. -Basically, your match criteria is met by these documents and at these locations -within each document, which can be viewed within the database directly -or in various output formats. -<p> 21. SQL +<p> For some documents hardly any markup at all is required at all, other +than a header, and an indication that the levels to be taken into account +by the program in generating its output are. +<p> 20. SISU SEARCH - INTRODUCTION + +<p> <b>SiSU</b> output can easily and conveniently be indexed by a number of standalone +indexing tools, such as Lucene, Hyperestraier. +<p> Because the document structure +of sites created is clearly defined, and the text object citation system +is available hypothetically at least, for all forms of output, it is possible +to search the sql database, and either read results from that database, +or just as simply map the results to the html output, which has richer +text markup. +<p> In addition to this <b>SiSU</b> has the ability to populate a relational +sql type database with documents at an object level, with objects numbers +that are shared across different output types, which make them searchable +with that degree of granularity. Basically, your match criteria is met by +these documents and at these locations within each document, which can +be viewed within the database directly or in various output formats. +<p> 21. +SQL <p> 21.1 POPULATING SQL TYPE DATABASES - -<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^19] -and/or SQLite[^20] database together with information related to document -structure. -<p> This is one of the more interesting output forms, as all the -structural data of the documents are retained (though can be ignored by -the user of the database should they so choose). All site texts/documents -are (currently) streamed to four tables: -<p> * one containing semantic -(and other) headers, including, title, author,<br> +<p> <b>SiSU</b> feeds sisu markupd documents +into sql type databases PostgreSQL[^19] and/or SQLite[^20] database together +with information related to document structure. +<p> This is one of the more +interesting output forms, as all the structural data of the documents are +retained (though can be ignored by the user of the database should they +so choose). All site texts/documents are (currently) streamed to four tables: + +<p> * one containing semantic (and other) headers, including, title, author,<br> subject, (the Dublin Core...);<br> <p> * another the substantive texts by individual "paragraph" (or object) --<br> - along with structural information, each paragraph being identifiable -by its<br> +- along<br> + with structural information, each paragraph being identifiable by its<br> paragraph number (if it has one which almost all of them do), and the<br> substantive text of each paragraph quite naturally being searchable (both in<br> @@ -2371,8 +2451,7 @@ to populate an sqlite database, this being part of <b>SiSU</b> - man sisu). <p>SYNOPSIS <p> sisu -d [instruction] [filename/wildcard if required]<br> -<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> - required]<br> +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]<br> <p> 23.4 COMMANDS <p> Mappings to two databases are provided by default, postgresql @@ -2560,8 +2639,8 @@ be desirable to exclude files ’plain.txt’, ’toc.html’ an these duplicate information held in other html output e.g. <p> find /home/ralph/sisu_www -type f | egrep<br> - ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v<br> - ’(doc|concordance).html$’ |estcmd gather -sd casket -<br> + ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v ’(doc|concordance).html$’<br> + |estcmd gather -sd casket -<br> <p> from your current document preparation/markup directory, you would construct a rune along the following lines: @@ -2585,7 +2664,7 @@ and set file permissions to 755: <p> [see estraier documentation for paths]<br> <p> (ii) edit estseek.conf, with attention to the lines starting ’indexname:’ -and ’replace:’: +and <p> indexname: /home/ralph/sisu_www/casket<br> <p> replace: ^file:///home/ralph/sisu_www{{!}}<a href='http://localhost'>http://localhost</a> @@ -2611,37 +2690,38 @@ and ’replace:’: <p> 26.3 DESCRIPTION <p> sisu_webrick is part of <b>SiSU</b> (man sisu) sisu_webrick -starts <b>Ruby</b> ’s Webrick web-server and points it to the directories to which -<b>SiSU</b> output is written, providing a list of these directories (assuming -<b>SiSU</b> is in use and they exist). -<p> The default port for sisu_webrick is set -to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample -of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory -on your system). +starts <b>Ruby</b> <b>SiSU</b> output is written, providing a list of these directories +(assuming <b>SiSU</b> is in use and they exist). +<p> The default port for sisu_webrick +is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml +a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent +directory on your system). <p> 26.4 SUMMARY OF MAN PAGE -<p> sisu_webrick, may be started -on it’s own with the command: sisu_webrick [port] or using the sisu command -with the -W flag: sisu -W [port] -<p> where no port is given and settings are +<p> sisu_webrick, may +be started on it’s own with the command: sisu_webrick [port] or using the +sisu command with the -W flag: sisu -W [port] +<p> where no port is given and -<p>unchanged the default port is 8081 -<p> 26.5 DOCUMENT PROCESSING COMMAND FLAGS +<p>settings are unchanged the default port is 8081 +<p> 26.5 DOCUMENT PROCESSING -<p> sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> output directories, -on the port provided, or if no port is provided and the defaults have not +<p>COMMAND FLAGS +<p> sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> +output directories, on the port provided, or if no port is provided and -<p>been changed in ~/.sisu/sisurc.yaml then on port 8081 -<p> 26.6 FURTHER INFORMATION +<p>the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 -<p> For more information on <b>SiSU</b> see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> 26.6 FURTHER INFORMATION +<p> For more information on <b>SiSU</b> see: <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +or <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > <p> or man sisu - <p> 26.7 AUTHOR -<p> Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com -<p> +<p> Ralph Amissah ralph@amissah.com -<p>26.8 SEE ALSO +<p>or ralph.amissah@gmail.com +<p> 26.8 SEE ALSO <p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> <br> @@ -2669,19 +2749,19 @@ parts (such as images) will be downloaded and generated locally. <p> Any of the source documents in the sisu examples page can be used in this way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > and use the url -for the desired document. -<p> NOTE: to set up a remote machine to serve <b>SiSU</b> -documents in this way, images should be in the directory relative to the +to the .sst for the desired document.<br> + +<p> NOTE: to set up a remote machine to serve <b>SiSU</b> documents in this way, + +<p>images should be in the directory relative to the document source ../_sisu/image -<p>document source ../_sisu/image <p> <b>sisupod - zipped sisu files</b> -<p> A sisupod is -the zipped content of a sisu marked up text or texts and any other associated -parts to the document such as images. -<p> <b>SiSU</b> can be run against a sisupod -on a (local or) remote machine, provide the processing instruction and -the url, the sisupod will be downloaded and the documents it contains generated -locally. +<p> A sisupod is the zipped content of a sisu +marked up text or texts and any other associated parts to the document +such as images. +<p> <b>SiSU</b> can be run against a sisupod on a (local or) remote +machine, provide the processing instruction and the url, the sisupod will +be downloaded and the documents it contains generated locally. <p> <p> <br> <pre> sisu -3 http://[provide url to valid sisupod.zip or .ssp file] @@ -2711,40 +2791,40 @@ may be used in conjunction with other processing flags, e.g. <dt><b>-R [filename/wildcard]</b> </dt> <dd>copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information -on hostname and username, and that you have your different if -R is used -with other flags from if used alone. Alone the rsync --delete parameter is -sent, useful for cleaning the remote directory (when -R is used together -with other flags, it is not). Also see -r +on hostname and username, and that you have your "keys" and ssh agent in +place. Note the behavior of rsync different if -R is used with other flags +from if used alone. Alone the rsync --delete parameter is sent, useful for +cleaning the remote directory (when -R is used together with other flags, +it is not). Also see -r <p> </dd> <dt><b>-r [filename/wildcard]</b> </dt> -<dd>copies sisu -output files to remote host using scp. This requires that sisurc.yml has -been provided with information on hostname and username, and that you have - -<p>your +<dd>copies sisu output files to +remote host using scp. This requires that sisurc.yml has been provided with +information on hostname and username, and that you have your "keys" and +ssh agent in place. Also see -R <p> </dd> </dl> 28.2 CONFIGURATION -<p> [expand on the setting up of an ssh-agent / keychain] - +<p> [expand on the setting + up of an ssh-agent / keychain] <p> 29. REMOTE SERVERS -<p> As <b>SiSU</b> is generally operated using the command line, -and works within a Unix type environment, <b>SiSU</b> the program and all documents -can just as easily be on a remote server, to which you are logged on using -a terminal, and commands and operations would be pretty much the same as -they would be on your local machine. -<p> 30. QUICKSTART - GETTING STARTED HOWTO - +<p> As <b>SiSU</b> is generally +operated using the command line, and works within a Unix type environment, +<b>SiSU</b> the program and all documents can just as easily be on a remote server, +to which you are logged on using a terminal, and commands and operations +would be pretty much the same as they would be on your local machine. +<p> 30. +QUICKSTART - GETTING STARTED HOWTO <p> 30.1 INSTALLATION -<p> Installation is currently most straightforward and -tested on the <b>Debian</b> platform, as there are packages for the installation -of sisu and all requirements for what it does. +<p> Installation is +currently most straightforward and tested on the <b>Debian</b> platform, as there +are packages for the installation of sisu and all requirements for what +it does. <p> 30.1.1 DEBIAN INSTALLATION - -<p> <b>SiSU</b> is available directly from the <b>Debian</b> Sid and testing archives (and -possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: - +<p> <b>SiSU</b> is available directly from the +<b>Debian</b> Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list +is set accordingly: <p> <p> <br> <pre> aptitude update @@ -2757,7 +2837,6 @@ markup samples: <pre> #/etc/apt/sources.list deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib - d </pre> <p> The aptitude commands become: <p> @@ -2832,10 +2911,11 @@ the root directory of the unpacked <b>SiSU</b> as root type: <p> <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a> ><br> -<p> <b></b> -<p> The root directory of the unpacked <b>SiSU</b> as root type: -<p> ruby install -base<br> +<p> <b>install</b> +<p> The "install" file provided is an installer prepared using +"rant". In the root directory of the unpacked <b>SiSU</b> as root type: +<p> ruby +install base<br> <p> or for a more complete installation: <p> ruby install<br> @@ -2848,8 +2928,7 @@ has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. <p> Further - -<p>information on +information on "rant" is available from: <p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> ><br> @@ -2921,10 +3000,10 @@ create the database and write to it when you run sisu. <p> The man pages are also available online, though not always kept as up to date as within the package itself: -<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> +<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > [^25] -<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> > [^26] <p> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> @@ -2940,29 +3019,35 @@ to date as within the package itself: <p> sisu --help --markup <p> 30.3.3 THE HOME PAGE <p> -<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > <p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> > -<p> 30.4 MARKUP SAMPLES -<p> A number of markup samples (along with output) are available off: +<p> 30.4 MARKUP SAMPLES +<p> A number of markup samples (along with output) are +available off: <p> <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > - -<p> Additional markup samples are packaged separately in the file: +<p> Additional +markup samples are packaged separately in the file: <p> <b>*</b> -<p> -On <b>Debian</b> they are available in non-free[^28] to include them it is necessary -to include non-free in your /etc/apt/source.list or obtain them from the -sisu home site. +<p> On <b>Debian</b> they +are available in non-free[^28] to include them it is necessary to include +non-free in your /etc/apt/source.list or obtain them from the sisu home site. + <p> 31. EDITOR FILES, SYNTAX HIGHLIGHTING <p> The directory: - <p> ./data/sisu/v2/conf/editor-syntax-etc/<br> +<p> ./data/sisu/v3/conf/editor-syntax-etc/<br> + <p> /usr/share/sisu/v2/conf/editor-syntax-etc<br> +<p> /usr/share/sisu/v3/conf/editor-syntax-etc<br> + <p> contains rudimentary sisu syntax highlighting files for: <p> * (g)vim <<a href='http://www.vim.org'>http://www.vim.org</a> @@ -3047,6 +3132,7 @@ breaks<br> <p> to file ~/.emacs add the following 2 lines:<br> <p> (add-to-list ’load-path<br> + "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs")<br> <p> (require ’sisu-mode.el)<br> @@ -3092,29 +3178,29 @@ create new ones). <p> 33. SUMMARY OF FEATURES <p> * sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a -minimalistic mnemonic syntax. Typical literature, documents like headers -are optional. -<p> * markup is easily readable/parsable by the human eye, (basic -markup is simpler and more sparse than the most basic HTML), [this may - also be converted to XML representations of the same input/source document]. - -<p> * markup defines document structure (this may be done once in a header -pattern-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike-through etc.) as required; -and semantic information related to the document (header information, extended -beyond the Dublin core and easily further extended as required); the headers -may also contain processing instructions. <b>SiSU</b> markup is primarily an abstraction -of document structure and document metadata to permit taking advantage -of the basic strengths of existing alternative practical standard ways -of representing documents [be that paper publication, sql search etc.] (html, -epub, xml, odf, latex, pdf, sql) -<p> * for output produces reasonably elegant -output of established industry and institutionally accepted open standard -formats.[3] takes advantage of the different strengths of various standard -formats for representing documents, amongst the output formats currently -supported are: -<p> * html - both as a single scrollable text and a segmented -document<br> +minimalistic mnemonic syntax. Typical literature, documents like "War and +Peace" require almost no markup, and most of the headers are optional. +<p> + * markup is easily readable/parsable by the human eye, (basic markup is +simpler and more sparse than the most basic HTML), [this may also be converted + to XML representations of the same input/source document]. +<p> * markup defines +document structure (this may be done once in a header pattern-match description, +or for heading levels individually); basic text attributes (bold, italics, +underscore, strike-through etc.) as required; and semantic information related +to the document (header information, extended beyond the Dublin core and +easily further extended as required); the headers may also contain processing +instructions. <b>SiSU</b> markup is primarily an abstraction of document structure +and document metadata to permit taking advantage of the basic strengths +of existing alternative practical standard ways of representing documents +[be that paper publication, sql search etc.] (html, epub, xml, odf, latex, +pdf, sql) +<p> * for output produces reasonably elegant output of established +industry and institutionally accepted open standard formats.[3] takes advantage +of the different strengths of various standard formats for representing +documents, amongst the output formats currently supported are: +<p> * html +- both as a single scrollable text and a segmented document<br> <p> * xhtml<br> @@ -3131,8 +3217,8 @@ as<br> <p> * pdf (via LaTeX)<br> <p> * sql - population of an sql database, (at the same object level that -is<br> - used to cite text within a document)<br> +is used<br> + to cite text within a document)<br> <p> Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests @@ -3158,62 +3244,66 @@ the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. -<p> <b>*</b>long<b>term</b>maintainability<b>of</b>document<b>collections</b>in<b>a</b>world<b>of</b>changing -formats, having a very sparsely marked-up source document base. there is -a considerable degree of future-proofing, output representations are upgradeable -(open document text) module in 2006, epub in 2009 and in future html5 output -sometime in future, without modification of existing prepared texts -<p> * -SQL search aside, documents are generated as required and static once generated. - -<p> * documents produced are static files, and may be batch processed, this -needs to be done only once but may be repeated for various reasons as desired -(updated content, addition of new output formats, updated technology document -presentations/representations) -<p> * document source (plaintext utf-8) if - -<p>shared on the net may be used as input and processed locally to produce - -<p>the different document outputs -<p> * document source may be bundled together -(automatically) with associated documents (multiple language versions or -master document with inclusions) and images and sent as a zip file called -a sisupod, if shared on the net these too may be processed locally to produce - -<p>the desired document outputs -<p> * generated document outputs may automatically -be posted to remote sites. -<p> * for basic document generation, the only software -dependency is <b>Ruby</b> , and a few standard Unix tools (this covers plaintext, -HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, -and to convert the LaTeX generated to pdf, a latex processor like tetex -or texlive. -<p> * as a developers tool it is flexible and extensible -<p> Syntax -highlighting for <b>SiSU</b> markup is available for a number of text editors. - -<p> <b>SiSU</b> is less about document layout than about finding a way with little -markup to be able to construct an abstract representation of a document -that makes it possible to produce multiple representations of it which -may be rather different from each other and used for different purposes, -whether layout and publishing, or search of content -<p> i.e. to be able to -take advantage from this minimal preparation starting point of some of -the strengths of rather different established ways of representing documents -for different purposes, whether for search (relational database, or indexed -flat files generated for that purpose whether of complete documents, or -say of files made up of objects), online viewing (e.g. html, xml, pdf), or -paper publication (e.g. pdf)... -<p> the solution arrived at is by extracting structural -information about the document (about headings within the document) and -by tracking objects (which are serialized and also given hash values) in -the manner described. It makes possible representations that are quite different -from those offered at present. For example objects could be saved individually -and identified by their hashes, with an index of how the objects relate -to each other to form a document. +<p> * long +term maintainability of document collections in a world of changing formats, +having a very sparsely marked-up source document base. there is a considerable +degree of future-proofing, output representations are "upgradeable", and +new document formats may be added. e.g. addition of odf (open document text) +module in 2006, epub in 2009 and in future html5 output sometime in future, + +<p>without modification of existing prepared texts +<p> * SQL search aside, documents +are generated as required and static once generated. +<p> * documents produced +are static files, and may be batch processed, this needs to be done only +once but may be repeated for various reasons as desired (updated content, +addition of new output formats, updated technology document presentations/representations) + +<p> * document source (plaintext utf-8) if shared on the net may be used as + +<p>input and processed locally to produce the different document outputs +<p> + * document source may be bundled together (automatically) with associated +documents (multiple language versions or master document with inclusions) +and images and sent as a zip file called a sisupod, if shared on the net + +<p>these too may be processed locally to produce the desired document outputs + +<p> * generated document outputs may automatically be posted to remote sites. + +<p> * for basic document generation, the only software dependency is <b>Ruby</b> +, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, +ODF, LaTeX). To use a database you of course need that, and to convert the +LaTeX generated to pdf, a latex processor like tetex or texlive. +<p> * as + +<p>a developers tool it is flexible and extensible +<p> Syntax highlighting for +<b>SiSU</b> markup is available for a number of text editors. +<p> <b>SiSU</b> is less about +document layout than about finding a way with little markup to be able +to construct an abstract representation of a document that makes it possible +to produce multiple representations of it which may be rather different +from each other and used for different purposes, whether layout and publishing, + +<p>or search of content +<p> i.e. to be able to take advantage from this minimal +preparation starting point of some of the strengths of rather different +established ways of representing documents for different purposes, whether +for search (relational database, or indexed flat files generated for that +purpose whether of complete documents, or say of files made up of objects), +online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... +<p> the +solution arrived at is by extracting structural information about the document +(about headings within the document) and by tracking objects (which are +serialized and also given hash values) in the manner described. It makes +possible representations that are quite different from those offered at +present. For example objects could be saved individually and identified +by their hashes, with an index of how the objects relate to each other +to form a document. <p> 34. HELP SOURCES -<p> For a summary of alternative -ways to get help on <b>SiSU</b> try one of the following: +<p> For a summary of alternative ways +to get help on <b>SiSU</b> try one of the following: <p> <b>man page</b> <p> man sisu_help<br> @@ -3237,6 +3327,28 @@ listed here: <p> 34.1.1 MAN <p> man sisu<br> +<p> man sisu-concordance<br> + +<p> man sisu-epub<br> + +<p> man sisu-git<br> + +<p> man sisu-harvest<br> + +<p> man sisu-html<br> + +<p> man sisu-odf<br> + +<p> man sisu-pdf<br> + +<p> man sisu-pg<br> + +<p> man sisu-po<br> + +<p> man sisu-sqlite<br> + +<p> man sisu-txt<br> + <p> man 7 sisu_complete<br> <p> man 7 sisu_pdf<br> @@ -3252,8 +3364,8 @@ listed here: <p> 34.2 SISU GENERATED OUTPUT - LINKS TO HTML <p> Note <b>SiSU</b> documentation is prepared in <b>SiSU</b> and output is available in multiple formats including -amongst others html, pdf, odf and epub which may be also be accessed via -the html pages[^28] +amongst others html, pdf, odf and epub, which may be also be accessed via +the html pages[^29] <p> 34.2.1 WWW.SISUDOC.ORG <p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> > @@ -3261,94 +3373,19 @@ the html pages[^28] <p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> ><br> -<p> <<a href='http://sisudoc.org/sisu/sisu_commands/index.html'>http://sisudoc.org/sisu/sisu_commands/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_complete/index.html'>http://sisudoc.org/sisu/sisu_complete/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_configuration/index.html'>http://sisudoc.org/sisu/sisu_configuration/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_description/index.html'>http://sisudoc.org/sisu/sisu_description/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_examples/index.html'>http://sisudoc.org/sisu/sisu_examples/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_faq/index.html'>http://sisudoc.org/sisu/sisu_faq/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_filetypes/index.html'>http://sisudoc.org/sisu/sisu_filetypes/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_help/index.html'>http://sisudoc.org/sisu/sisu_help/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_howto/index.html'>http://sisudoc.org/sisu/sisu_howto/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_introduction/index.html'>http://sisudoc.org/sisu/sisu_introduction/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_markup/index.html'>http://sisudoc.org/sisu/sisu_markup/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_output_overview/index.html'>http://sisudoc.org/sisu/sisu_output_overview/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_pdf/index.html'>http://sisudoc.org/sisu/sisu_pdf/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_postgresql/index.html'>http://sisudoc.org/sisu/sisu_postgresql/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_quickstart/index.html'>http://sisudoc.org/sisu/sisu_quickstart/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_remote/index.html'>http://sisudoc.org/sisu/sisu_remote/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_search/index.html'>http://sisudoc.org/sisu/sisu_search/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_skin/index.html'>http://sisudoc.org/sisu/sisu_skin/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_sqlite/index.html'>http://sisudoc.org/sisu/sisu_sqlite/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html'>http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_vim/index.html'>http://sisudoc.org/sisu/sisu_vim/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_webrick/index.html'>http://sisudoc.org/sisu/sisu_webrick/index.html</a> -><br> - <p> 34.3 MAN2HTML <p> 34.3.1 LOCALLY INSTALLED -<p> <file:///usr/share/doc/sisu/v2/html/sisu.1.html> - -<p> <file:///usr/share/doc/sisu/v2/html/sisu_help.1.html> -<p> <file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html> +<p> file:///usr/share/doc/sisu/html/sisu.1.html -<p> /usr/share/doc/sisu/v2/html/sisu.1.html<br> +<p> file:///usr/share/doc/sisu/html/sisu.1.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_pdf.7.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_pdf.7.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_postgresql.7.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_sqlite.7.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_webrick.1.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_webrick.1.html<br> <p> 34.3.2 WWW.JUS.UIO.NO/SISU <p> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> @@ -3417,47 +3454,51 @@ insert multiple asterisks if required </dd> <dt><b>+2.</b> </dt> <dd>editors -notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > -</li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> -> </li><b>.</b><li>Table from the Wealth of Networks by Yochai Benkler -<<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> -> </li><b>.</b><li>.ssc (for composite) -is under consideration but ._sst makes clear that this is not a regular -file to be worked on, and thus less likely that people will have processing. -It may be however that when the resulting file is shared .ssc is an appropriate -suffix to use. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> + +<p> </li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> +> </li><b>.</b><li>Table from the Wealth of Networks by Yochai +Benkler <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> +> </li><b>.</b><li>.ssc +(for composite) is under consideration but ._sst makes clear that this is +not a regular file to be worked on, and thus less likely that people will +have "accidents", working on a .ssc file that is overwritten by subsequent +processing. It may be however that when the resulting file is shared .ssc +is an appropriate suffix to use. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> > <<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> -> <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> > -</li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> +<<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> +> </li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> > <<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> -> </li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> > -</li><b>.</b><li>(which could be extended further with current back-end). As regards scaling -of the database, it is as scalable as the database (here Postgresql) and -hardware allow. </li><b>.</b><li>of this feature when demonstrated to an IBM software innovations -evaluator in 2004 he said to paraphrase: this could be of interest to us. -We have large document management systems, you can search hundreds of thousands -of documents and we can tell you which documents meet your search criteria, -but there is no way we can tell you without opening each document where -within each your matches are found. </li><b>.</b><li>There is nothing to stop MySQL support -being added in future. </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +</li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> +> </li><b>.</b><li>(which could be extended further with current back-end). +As regards scaling of the database, it is as scalable as the database (here +Postgresql) and hardware allow. </li><b>.</b><li>of this feature when demonstrated to an +IBM software innovations evaluator in 2004 he said to paraphrase: this +could be of interest to us. We have large document management systems, you +can search hundreds of thousands of documents and we can tell you which +documents meet your search criteria, but there is no way we can tell you +without opening each document where within each your matches are found. +</li><b>.</b><li>There is nothing to stop MySQL support being added in future. </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +> + +<p> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> > -</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> </li><b>.</b><li>the <b>Debian</b> Free Software guidelines require -that everything distributed within <b>Debian</b> can be changed - and the documents -are authors’ works that while freely distributable are not freely changeable. -</li><b>.</b><li> -<p>named index.html or more extensively through sisu_manifest.html +<p> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +> </li><b>.</b> +<li>the <b>Debian</b> Free Software guidelines require that everything distributed +within <b>Debian</b> can be changed - and the documents are authors’ works that +while freely distributable are not freely changeable. </li><b>.</b><li>named index.html or + +<p>more extensively through sisu_manifest.html <p> </li> </ol> <h2><a name='sect2' href='#toc2'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> -, -<br> +, <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> @@ -3475,12 +3516,10 @@ are authors’ works that while freely distributable are not freely changeab <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> . <br> <a href='http:~/bin/man2html?sisu_vim:7'><i>sisu_vim</i>(7)</a> - <br> -<a href='http:~/bin/man2html?sisu:8'><i>sisu</i>(8)</a> <p> <h2><a name='sect3' href='#toc3'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> >. <p> diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html deleted file mode 100644 index 4c81d9c3..00000000 --- a/data/doc/sisu/html/sisu.8.html +++ /dev/null @@ -1,273 +0,0 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>sisu(8) manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> - -<h2><a name='sect0' href='#toc0'>Name</a></h2> -<b>SiSU</b> - Structured information, Serialized Units - a document -publishing system -<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu</b> <b>[-mhwpxXv...] [</b> <i>filename/wildcard</i> <b>]</b> -<h2><a name='sect2' href='#toc2'>Description</a></h2> -A -document publishing system, that from a simple single marked-up document, -produces a multitude of output formats including: html, latex, pdf, info, -and sql output, which can be cross referenced as having the same document -structure and text object numbering, "object citation numbering". Features -include its’ simple syntax; the semantic tagging of documents; document -management; built to be associated with a revision control system; text -object numbering for the identification of a texts location in any of the -output formats, easy skinning on a site wide, or per document basis; granular -search; a degree of future proofing ... for more see <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> -<p> -<b>SiSU is a way of preparing, publishing, managing and searching documents.</b> - -<h2><a name='sect3' href='#toc3'>Installation</a></h2> -<p> -Up to date information on SiSU downloads, and their installation -should be available from: <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html'>http://www.jus.uio.no/sisu/SiSU/download.html</a> -></i> or -at: <i><<a href='http://www.jus.uio.no/sisu/sisu_download/download.html'>http://www.jus.uio.no/sisu/sisu_download/download.html</a> -></i> <p> -There you should -find links to the latest source tarball, and instructions on how to install -SiSU. <p> -Sample marked up documents are are available at <i>/usr/share/doc/sisu/sisu_markup_samples/dfsg</i> -or equivalent directory, or online, see <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -></i> -<p> -<i>man</i> 1 sisu has a syntax table along with processing commands. <p> -SiSU also -provides some help via the command: <i>sisu</i> --help and selecting an appropriate -subject, e.g. <p> -<i>sisu</i> --help commands <p> -<i>sisu</i> --help markup <p> -<i>sisu</i> --help headers <p> -<i>sisu</i> ---help env <p> -The rest of this note is on post installation setup -<h2><a name='sect4' href='#toc4'>Post Installation -Setup - Quick start</a></h2> -<p> - -<p> After installation of sisu-complete, move to the document -samples directory, <p> - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> - <p> -[this is not where you would normally work but provides sample documents -for testing, you may prefer instead to copy the contents of that directory -to a local directory before proceeding] <p> -and in that directory, initialise -the output directory with the command <p> -<i>sisu</i> -CC <p> -then run: <p> -<i>sisu</i> -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> -or the same: <p> -<i>sisu</i> -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> -look at output results, see the "sisu_manifest" page created for the document -<p> -for an overview of your current sisu setup, type: <p> -<i>sisu</i> --help env <p> -or <p> -<i>sisu</i> --V <p> -To generate a document from a remote url accessible location move to -a writable directory, (create a work directory and cd into it) as the file -will be downloaded there and e.g. <p> -<i>sisu</i> -1 <a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a> - -<p> -<i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a> - -<p> -examine source document, vim has syntax highlighting support <p> -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> -additional markup samples in <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -></i> <p> -it should -also be possible to run sisu against sisupods (prepared zip files, created -by running the command sisu -S [filename]), whether stored locally or remotely. -<p> -<i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a> - <p> -there -is a security issue associated with the running of document skins that -are not your own, so these are turned of by default, and the use of the -following command, which switches on the associated skin is not recommended: -<p> -<i>sisu</i> -3 --trust <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a> - -<p> -For help <i>man</i> sisu <p> -<i>sisu</i> --help <p> -<i>sisu</i> --help env for the way sisu "sees/maps" -your system <p> -<i>sisu</i> --help commands for list of commands and so on <p> - <b>Document -markup directory</b> <p> -Perhaps the easiest way to begin is to create a directory -for sisu marked up documents within your home directory, and copy the file -structure (and document samples) provided in the document sample directory: -<i>mkdir</i> ~/sisu_test <p> -<i>cd</i> ~/sisu_test <p> -<i>cp</i> -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* -~/sisu_test/. <p> -<b>----------</b> <p> -<b>Tip:</b> the markup syntax examples may be of interest <i><<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a> -></i> -<p> -<b>Tip:</b> <i>sisu</i> -U [sisu markup filename] should printout the different possible -outputs and where sisu would place them. <p> -<b>Tip:</b> if you want to toggle ansi -color add <i>c</i> to your flags. <p> -<b>----------</b> <p> - <b>SiSU configuration file search path is:</b> <p> -<i>./_sisu/sisurc.yaml</i> -<p> -<i>~/.sisu/sisurc.yaml</i> <p> -<i>/etc/sisu/sisurc.yaml</i> <p> - -<h2><a name='sect5' href='#toc5'>Debian INSTALLATION Note</a></h2> -<p> -It is best -you see <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> -></i> for up the most -up to date information. <p> -notes taken from the Debian control file (end edited), -gives an idea of additional packages that SiSU can make use of if available, -(the use/requirement of some of which are interdependent for specific actions -by SiSU): <p> -Package: sisu <p> -Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip -<p> -Conflicts: vim-sisu, sisu-vim, sisu-remote <p> -Replaces: vim-sisu, sisu-vim <p> -Recommends: -sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, -openssl, rsync, openssh-client lsh-client, keychain, hyperestraier, kdissert -Suggests: rcs cvs, lv, texinfo, pinfo <p> -Package: sisu-complete <p> -Depends: ruby -(>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite <p> -Recommends: hyperestraier -<p> -Package: sisu-pdf <p> -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, -texlive-latex-recommended, texlive-latex-extra <p> -Suggests: evince, xpdf <p> -Package: -sisu-postgresql <p> -Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql -<p> -Recommends: libfcgi-ruby <p> -Package: sisu-sqlite <p> -Depends: sisu, sqlite, libdbd-sqlite-ruby, -libdbi-ruby, libdbm-ruby <p> -Recommends: libfcgi-ruby <p> -Package: sisu-markup-samples -<p> -Depends: sisu <p> - -<h2><a name='sect6' href='#toc6'>Package Description</a></h2> -<b>sisu</b> <p> -Description: documents - structuring, -publishing in multiple formats and search <p> -SiSU is a lightweight markup -based, command line oriented, document structuring, publishing and search -framework for document collections. <p> -With minimal preparation of a plain-text, -(UTF-8) file, using its native markup syntax in your text editor of choice, -SiSU can generate various document formats (most of which share a common -object numbering system for locating content), including plain text, HTML, -XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate -an SQL database with objects (roughly paragraph-sized chunks) so searches -may be performed and matches returned with that degree of granularity: -your search criteria is met by these documents and at these locations within -each document. Object numbering is particularly suitable for "published" -works (finalized texts as opposed to works that are frequently changed -or updated) for which it provides a fixed means of reference of content. -Document outputs also share semantic meta-data provided. <p> -SiSU also provides -concordance files, document content certificates and manifests of generated -output. <p> -A vim syntax highlighting file and an ftplugin with folds for sisu -markup is provided, as are syntax highlighting files for kate, kwrite, -gedit and diakonos. Vim 7 includes syntax highlighting for SiSU. <p> -man pages, -and interactive help are provided. <p> -Dependencies for various features are -taken care of in sisu related packages. The package sisu-complete installs -the whole of SiSU. <p> -Additional document markup samples are provided in the -package sisu-markup-samples which is found in the non-free archive the licenses -for the substantive content of the marked up documents provided is that -provided by the author or original publisher. <p> -Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> -</pre> -<h2><a name='sect7' href='#toc7'>Document Resource Configuration</a></h2> -<b>sisu</b> resource configuration information -is obtained from sources (where they exist): <br> -<pre>~/.sisu/sisurc.yaml/etc/sisu/[sisu version]/sisurc.yamlsisu program defaults</pre><p> - -<b>Skins</b> <p> -default document appearance may be modified using skins contained -in sub-directories located at the following paths: <br> -<pre>./_sisu/skin~/.sisu/skin/etc/sisu/skin</pre><p> -more specifically, the following locations -(or their /etc/sisu equivalent) should be used: <p> -<i>~/.sisu/skin/doc</i> skins for -individual documents; <p> -<i>~/.sisu/skin/dir</i> skins for directories of matching -names; <p> -<i>~/.sisu/skin/site</i> site-wide skin modifying the site-wide appearance -of documents. <p> -Usually all skin files are placed in the document skin directory: -<i>~/.sisu/skin/doc</i> with softlinks being made to the skins contained there -from other skin directories as required. -<h2><a name='sect8' href='#toc8'>Further Information</a></h2> -<p> -For more information -on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> <p> -or <i>man</i> sisu -<h2><a name='sect9' href='#toc9'>Author</a></h2> -Ralph Amissah <i><ralph@amissah.com></i> -or <i><ralph.amissah@gmail.com></i> -<h2><a name='sect10' href='#toc10'>See Also</a></h2> -<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> -,</b> <a href='http:~/bin/man2html?sisu_examples:1'><b>sisu_examples(1)</a> -,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> -,</b> -<a href='http:~/bin/man2html?sisu_pdf:1'><b>sisu_pdf(1)</b></a> - <a href='http:~/bin/man2html?sisu_sqlite:1'><b>sisu_sqlite(1)</b></a> - <a href='http:~/bin/man2html?sisu_postgresql:1'><b>sisu_postgresql(1)</b></a> - <a href='http:~/bin/man2html?sisu_termsheet:1'><b>sisu_termsheet(1)</a> -,</b> <p> - -<hr><p> -<a name='toc'><b>Table of Contents</b></a><p> -<ul> -<li><a name='toc0' href='#sect0'>Name</a></li> -<li><a name='toc1' href='#sect1'>Synopsis</a></li> -<li><a name='toc2' href='#sect2'>Description</a></li> -<li><a name='toc3' href='#sect3'>Installation</a></li> -<li><a name='toc4' href='#sect4'>Post Installation Setup - Quick start</a></li> -<li><a name='toc5' href='#sect5'>Debian INSTALLATION Note</a></li> -<li><a name='toc6' href='#sect6'>Package Description</a></li> -<li><a name='toc7' href='#sect7'>Document Resource Configuration</a></li> -<li><a name='toc8' href='#sect8'>Further Information</a></li> -<li><a name='toc9' href='#sect9'>Author</a></li> -<li><a name='toc10' href='#sect10'>See Also</a></li> -</ul> -</body> -</html> diff --git a/data/doc/sisu/html/sisu3.1.html b/data/doc/sisu/html/sisu3.1.html new file mode 120000 index 00000000..4b34bf93 --- /dev/null +++ b/data/doc/sisu/html/sisu3.1.html @@ -0,0 +1 @@ +sisu.1.html
\ No newline at end of file diff --git a/data/doc/sisu/html/sisu_vim.7.html b/data/doc/sisu/html/sisu_vim.7.html index f9e18237..b7ee2028 100644 --- a/data/doc/sisu/html/sisu_vim.7.html +++ b/data/doc/sisu/html/sisu_vim.7.html @@ -18,14 +18,9 @@ publishing in multiple standard formats, and search<br> <p> <b>SiSU</b> has syntax highlighting for a number of editors including vim which are documented under: -<p> man sisu_syntax_highlighting<br> +<p> /usr/share/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst<br> -<p> /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html<br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html'>http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html'>http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html</a> ><br> <p> <b>SiSU</b> also provides an ftplugin to provide vim folds for <b>SiSU</b> markup, @@ -51,98 +46,12 @@ on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same with a furthe </pre> <p> FURTHER INFORMATION <p> For more information on <b>SiSU</b> see: -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> <<a href='http://sisudoc.org/'>http://sisudoc.org/</a> > -<p> or man sisu -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest -@ <<a href='http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html</a> -> -<p> <b>Dublin Core</b> -(DC) -<p> <i>DC</i> tags included with this document are provided here. -<p> DC Title: -<i>SiSU</i> - Vim -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> (C) Ralph -Amissah 2008, part of SiSU documentation, License GPL 3 -<p> DC Type: <i>information</i> - -<p> DC Date created: <i>2002-11-12</i> -<p> DC Date issued: <i>2002-11-12</i> -<p> DC Date available: - -<p><i>2002-11-12</i> -<p> DC Date modified: <i>2008-02-12</i> -<p> DC Date: <i>2008-02-12</i> -<p> <b>Version Information</b> - -<p> Sourcefile: <i>sisu_vim.sst</i> -<p> Filetype: <i>SiSU</i> text insert 0.58 -<p> Sourcefile -Digest, MD5(sisu_vim.sst)= <i>b5028f957b128162f7653bbd940042ca</i> -<p> Skin_Digest: -MD5(skin_sisu_manual.rb)= <i>072b2584bedea82ea8a416587b9fa244</i> -<p> <b>Generated</b> -<p> - Document (metaverse) last generated: <i>Thu</i> Feb 14 02:44:14 +0000 2008 -<p> -Generated by: <i>SiSU</i> <i>0.64.4</i> of 2008w06/4 (2008-02-14) -<p> Ruby version: <i>ruby</i> 1.8.6 -(2007-09-24 patchlevel 111) [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: -</dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html</a> -</a> -> </dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_vim/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_vim/toc.html'>http://www.jus.uio.no/sisu/sisu_vim/toc.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf</a> -</a> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -</dt> -<dd></dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> </dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.64.4 of 2008w06/4 (2008-02-14) -</dt> -<dd></dd> - -<dt>* Ruby version: ruby 1.8.6 (2007-09-24 patchlevel 111) [i486-linux] </dt> -<dd></dd> - -<dt>* Last Generated -on: Thu Feb 14 02:44:14 +0000 2008 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> +<p> or man sisu <p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm index 47a029fa..64debc90 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm @@ -1,4 +1,4 @@ -% SiSU master 3.0 +% SiSU master 2.0 @title: SiSU :subtitle: Manual @@ -19,26 +19,26 @@ :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 - :modified: 2011-02-07 + :modified: 2011-03-04 @make: :num_top: 1 :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v1 [operations] + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v3 [operations] . sisu3 [operations] @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~ @title @creator diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index 18620d1b..eb01a388 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -1,4 +1,4 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Commands @@ -21,7 +21,7 @@ :issued: 2002-08-28 :available: 2002-08-28 :published: 2007-09-16 - :modified: 2011-02-07 + :modified: 2011-03-04 @make: :num_top: 1 @@ -30,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -240,12 +240,12 @@ see --urls !_ -u [filename/wildcard] <br> provides url mapping of output files for the flags requested for processing, also see -U -!_ --v1 [filename/wildcard] <br> -invokes the sisu v1 document parser/generator. For use with sisu v1 markup documents. (Markup conversion to v2 involves the modification of document headers) - !_ --v2 [filename/wildcard] <br> invokes the sisu v2 document parser/generator. This is the default and is normally omitted. +!_ --v3 [filename/wildcard] <br> +invokes the sisu v3 document parser/generator. Currently under development and incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. + !_ --verbose [filename/wildcard] <br> provides verbose output of what is being generated, where output is placed (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests. Alias -v diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi index 274a056f..5fe582cd 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi @@ -1,17 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Configuration -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @date: :published: 2007-09-16 @@ -20,24 +16,6 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? Configuration :B~? Configure Environment diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi index 4c3a506a..dedd38f4 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Content Directories, Organising Content -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -20,24 +18,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? Organisation of Content :B~? Content Directories diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi index 2035b7c3..05f940dd 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: CSS - Cascading Style Sheets -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2007-08-28 :issued: 2007-08-28 @@ -20,24 +18,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? CSS 1~css CSS - Cascading Style Sheets (for html, XHTML and XML) diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst index e924c433..9f8c1691 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst @@ -1,9 +1,10 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units :subtitle: Description -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph @classify: :type: information @@ -12,7 +13,8 @@ % SiSU.ssm -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @date: :created: 2002-11-12 @@ -29,22 +31,16 @@ :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i @links: - {What does SiSU do? Summary}../SiSU/1.html#summary - {Book Samples and Markup Examples}../SiSU/examples.html - {SiSU Markup Syntax}../sample - {*Citation System* Object Citation Numbering}../SiSU/1.html#citation - {*Granular Search*}../SiSU/1.html#search - {The Chart (pdf)}../diagram/sisu.chart.pdf - {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf - {Standard}../SiSU/standard.html - {License}../SiSU/license.html - {man pages}../SiSU/3.html#man - {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ - {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html - {Download}../SiSU/download.html - {Changelog}../SiSU/changelog.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -54,7 +50,7 @@ 2~ Outline -SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html for information on this version. Dates related to the development of SiSU are mostly contained within the Chronology section of this document, e.g. http://www.jus.uio.no/sisu/sisu_chronology }~ +SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html or manifest page http://www.jus.uio.no/sisu/SiSU/sisu_manifest.html for information on this version. Dates related to the development of SiSU may be tracked in the http://www.jus.uio.no/sisu/SiSU/changelog.html or the Git repository http://git.sisudoc.org/?p=code/sisu.git;a=summary some of the more significant events may be contained within the Chronology section of this document http://www.jus.uio.no/sisu/sisu_chronology }~ SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),~{ also chosen for the meaning of the Finnish term "sisu". }~ is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search. @@ -90,7 +86,7 @@ For more see the short summary of features provided below. SiSU processes files with minimal tagging to produce various document outputs including html, EPUB, ODF, LaTeX (which is converted to pdf) and if required loads the structured information into an SQL database (PostgreSQL and SQLite have been used for this). SiSU produces an intermediate processing format.~{ This proved to be the easiest way to develop syntax, changes could be made, or alternatives provided for the markup syntax whilst the intermediate markup syntax was largely held constant. There is actually an optional second intermediate markup format in YAML http://www.yaml.org/ }~ -SiSU is used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). +SiSU was originally used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). 2~ Short summary of features *~summary @@ -192,9 +188,7 @@ One of its strengths is that very small amounts of initial tagging is required f This is a basic markup example: -_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ - -_* { view basic markup, as it would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html ~{ http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html as it would appear with syntax highlighting (by vim) }~ +_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/src/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/src/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ Emphasis has been on simplicity and minimalism in markup requirements. Design philosophy is to try keep the amount of markup required low, for whatever has been determined to be acceptable output.~{ seems there are several "smart ASCIIs" available, primarily for ascii to html conversion, that make this, and reasonable looking ascii their goal<br /> http://webseitz.fluxent.com/wiki/SmartAscii <br> http://daringfireball.net/projects/markdown/ <br> http://www.textism.com/tools/textile/ }~ @@ -206,25 +200,29 @@ For each document, there is only one (input, minimalistically marked up) file fr Eg. the markup example: -_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst - -_* {~^ view as syntax would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html +_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/src/un_contracts_international_sale_of_goods_convention_1980.sst Produces the following output: +_* {~^ Manifest of output presentations generated }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sisu_manifest.html + _* {~^ Segmented html version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html _* {~^ Full length html document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/doc.html -_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.pdf +_* {~^ EPUB version of document }http://www.jus.uio.no/sisu/epub/un_contracts_international_sale_of_goods_convention_1980.epub -_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.pdf +_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.letter.pdf -_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt +_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.letter.pdf -_* {~^ /xml/ sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml +_* {~^ odt open document format text version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/opendocument.odt -_* {~^ /xml/ dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml +_* {~^ xml sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml + +_* {~^ xml dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml + +_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt _* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/concordance.html @@ -232,7 +230,7 @@ _* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_o 3~ Syntax relatively easy to read and remember -Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup_table/doc.html#h200306 <br>Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ +Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup/toc.html <br>Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ 3~ Kept simple by having a limited publishing feature set, and features identified as most important, are available across several document types @@ -282,7 +280,7 @@ SiSU is able to use meta tags based on the Dublin Core~{ http://dublincore.org/ This provides the means of providing semantic information about a document, both as computer processable meta-tags, and as human readable information that may be of value for classification purposes. -This information is provided both in html metatags, and (where available) under the section titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html +This information is provided both in html metatags, and (where available) under the section titled "Document Information - Metadata", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html 2~ Easy directory management @@ -371,7 +369,7 @@ Most documents are produced in single and segmented html versions, described bel !_ The Scroll (full length text presentations) -The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un_contracts_international_sale_of_goods_convention_1980/doc <br> The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc or <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ +The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un.contracts.international.sale.of.goods.convention.1980/doc.html <br> The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc.html or <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc.html }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ For various reasons texts may only be provided in this form (such as this one which is short), though most are also provided as segmented texts. @@ -379,7 +377,7 @@ For various reasons texts may only be provided in this form (such as this one wh !_ The Segmented Text -The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980 <br>The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994 <br> The Autonomous Contract http://www.jus.uio.no/sisu/the.autonomous.contract.2000.amissah or <br> WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ +The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/lm/un.contracts.international.sale.of.goods.convention.1980/toc.html <br>The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/toc.html <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/toc.html or <br> WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ If you know exactly what you are looking for, loading a segment of text is faster (the segments being smaller). Occasionally longer documents such as the WTA 1994 http://www.jus.uio.no/lm/wta.1994/toc are only provided in segmented form. @@ -488,25 +486,25 @@ SiSU can provide information on which documents are matched and at what location A few canned searches, showing object numbers. Search for: -{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 +{ English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=index -{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 +{ GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=index -{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 +{ invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=index -{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 +{ copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=index Note that the searches done in this form are case sensitive. Expand those same searches, showing the matching text in each document: -{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 +{ English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=text -{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 +{ GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=text -{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 +{ invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=text -{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 +{ copyright }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=text Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ @@ -554,7 +552,7 @@ Several backup tools exist. At the base level I tend to use rdiff. SiSU documents are prepared / marked up in utf-8 text _{you are free to use the text editor of your choice.}_ -Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.jus.uio.no/sisu/syntax_highlight. {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. +Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.sisudoc.org/sisu/sisu_syntax_highlighting/doc.html {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. 2~ Modular design, need something new add a module diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi index 2d5c6508..2dc2462c 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi @@ -1,16 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units :subtitle: Download, Stable and Development Branches -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph % used_by: SiSU.ssm -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-11-12 :issued: 2002-11-12 @@ -18,31 +15,6 @@ :published: 2009-01-18 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu - :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|atomic search|rant|utf-?8|UTF-?8|WARNING/ - :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|atomic search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i - -@links: - {What does SiSU do? Summary}../SiSU/1.html#summary - { Book Samples and Markup Examples }../SiSU/examples.html - {SiSU Markup Syntax}../sample - {*Citation System* Object Citation Numbering}../SiSU/1.html#citation - {*Granular Search*}../SiSU/1.html#search - {The Chart (pdf)}../diagram/sisu.chart.pdf - {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf - {Standard}../SiSU/standard.html - {License}../SiSU/license.html - {man pages}../SiSU/3.html#man - {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ - {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html - {Download}../SiSU/download.html - {Changelog}../SiSU/changelog.html - :A~? @title @creator :B~? SiSU Downloads, Stable and Development Branches diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi index 1188b109..72939421 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi @@ -1,14 +1,10 @@ -% SiSU 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Markup Samples, Output Examples -@creator: :author: Amissah, Ralph - -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search +@creator: + :author: Amissah, Ralph % used_by: SiSU.ssm @@ -21,24 +17,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual -% :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - {Book Samples and Markup Examples}../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? SiSU Markup and Output Examples @@ -49,6 +27,4 @@ Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html -Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. - For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst index 491f96a4..2fe64318 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst @@ -1,9 +1,10 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Markup Samples, Output Examples -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph @classify: :type: information @@ -12,7 +13,8 @@ % used_by: SiSU.ssm -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @date: :created: 2002-11-12 @@ -28,16 +30,16 @@ % :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - {Book Samples and Markup Examples}../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -49,14 +51,16 @@ Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html -Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. - For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. <:pb> 2~ A few book (and other) examples *~books *~sample *~example *~output +3~viral_spiral /{"Viral Spiral"}/, David Bollier + +{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst + 3~wealth_of_networks- /{"The Wealth of Networks"}/, Yochai Benkler { "The Wealth of Networks", Yochai Benkler [3sS]}the_wealth_of_networks.yochai_benkler.sst @@ -69,6 +73,14 @@ For some documents hardly any markup at all is required at all, other than a hea { "Free Culture", Lawrence Lessig [3sS]}free_culture.lawrence_lessig.sst +3~content- /{"CONTENT"}/, Cory Doctorow *~doctorow + +{ "CONTENT", Cory Doctorow [3sS]}content.cory_doctorow.sst *~content + +3~democratizing_innovation- /{"Democratizing Innovation"}/, by Eric von Hippel + +{ "Democratizing Innovation", by Eric von Hippel [3sS]}democratizing_innovation.eric_von_hippel.sst + 3~free_as_in_freedom- /{"Free as in Freedom: Richard Stallman's Crusade for Free Software"}/, by Sam Williams { "Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams [3sS]}free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst @@ -81,10 +93,18 @@ For some documents hardly any markup at all is required at all, other than a hea { "The Cathedral and the Bazaar", by Eric S. Raymond [3sS]}the_cathedral_and_the_bazaar.eric_s_raymond.sst -3~littlebrother- /{"Little Brother"}/, Cory Doctorow *~doctorow +3~magickingdom- /{"Down and out in the Magic Kingdom"}/, Cory Doctorow *~doctorow + +{ "Down and out in the Magic Kingdom", Cory Doctorow [3sS]}down_and_out_in_the_magic_kingdom.cory_doctorow.sst *~magickingdom + +3~littlebrother- /{"Little Brother"}/, Cory Doctorow { "Little Brother", Cory Doctorow [3sS]}little_brother.cory_doctorow.sst *~littlebrother +3~ftw- /{"For the Win"}/, Cory Doctorow + +{ "For the Win", Cory Doctorow [3sS]}for_the_win.cory_doctorow.sst *~ftw + 3~accelerando- /{"Accelerando"}/, Charles Stross *~stross { "Accelerando", Charles Stross [3sS]}accelerando.charles_stross.sst *~accelerando @@ -175,25 +195,25 @@ A Sample search form is available at http://search.sisudoc.org A few canned searches, showing object numbers. Search for: -_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=index -_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 +_1 { GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=index -_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 +_1 { invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=index -_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 +_1 { copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=index Note that the searches done in this form are case sensitive. Expand those same searches, showing the matching text in each document: -_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 +_1 { Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=text -_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 +_1 { GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=text -_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 +_1 { invention OR innovation in English language }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=text -_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 +_1 { copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=text Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ @@ -211,9 +231,7 @@ http://lexmercatoria.org/treaties.and.organisations/lm.chronological ~{ http://w SiSU is not optimised for table making, but does handle simple tables. -_* {~^ SiSU marked up file with tables }http://www.jus.uio.no/sisu/sample/syntax/un_conventions_membership_status.sst.html ~{ <br> http://www.jus.uio.no/sisu/sample/markup/un_conventions_membership_status.sst }~ - -_* {~^ Output of table file example }http://www.jus.uio.no/lm/un_conventions_membership_status/toc.html +_* {~^ Output of table file example }http://www.jus.uio.no/lm/un.conventions.membership.status/toc.html 2~ And a link to the output of a reported case diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst index 44a5a590..76a594ac 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst @@ -1,9 +1,10 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: FAQ - Frequently Asked/Answered Questions -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph @classify: :type: information @@ -12,7 +13,8 @@ % used_by: manual SiSU.ssm -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @date: :published: 2008-03-12 @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -205,17 +207,14 @@ None. In the early days of its release a Mac friend built and run the ruby code It should however be possible, much of the output relies on plain ruby, and the system commands to latex etc. could be made appropriate for the underlying OS. -2~ Where is version 1.0? +2~ Where is version 1? -Most of SiSU is mature and stable. -Version 1.0 will be based on the current markup, (more likely with optional additions rather than significant changes) and directory structure. -At this point (semantic tagging apart) it is largely a matter of choice as to when the version change is made. +Version 1 was finally released on December 21, 2009, and largely to make a version 1 branch available as version 2 was in the pipeline with an imminent release. Most of SiSU was mature and stable long before the release of version 1. -The feature set for html,~{ html w3c compliance has been largely met. }~ LaTeX/pdf and opendocument is in place. -XML, and plaintext are in order. +2~ What is the difference between version 1 and 2? -html and LaTeX/pdf may be regarded as reference copy outputs +Input and output of version 1 and 2 are largely the same with the following significant exceptions. On the input side, document headers, that is metadata and processing instructions have changed in version 2. On the output side, version 2 was introduced with EPUB documents as a possible output, and over time is likely to be developed further. -With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done. +Version 2 introduces a new processing layer, which relies more on the programming language Ruby's objects (and regular expressions), than version 1 does which relies on regular expressions. The thinking behind version 1 use of regular expressions was that it made it more straightforward to switch languages for processing, as many languages support regular expressions; the thinking behind version 2 was version 1 was more complicated than it need be, and since Ruby was the language used, why not make programming more straightforward, as it would be easier to develop further. -We are still almost there. +Version 1 was removed with the introduction of the version 3 development branch diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst index 4e46323c..acf09499 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Filetypes -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -59,9 +61,9 @@ _1 sisu -s [filename] The most common form of document in SiSU, see the section on SiSU markup. -http://www.jus.uio.no/sisu/sisu_markup +http://www.sisudoc.org/sisu/sisu_markup -http://www.jus.uio.no/sisu/sisu_manual +http://www.sisudoc.org/sisu/sisu_manual 3~ sisu master files (.ssm) @@ -73,9 +75,9 @@ Note: Master documents may be prepared in a similar way to regular documents, an Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst ~{ .ssc (for composite) is under consideration but ._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will have "accidents", working on a .ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared .ssc is an appropriate suffix to use. }~ -http://www.jus.uio.no/sisu/sisu_markup +http://www.sisudoc.org/sisu/sisu_markup -http://www.jus.uio.no/sisu/sisu_manual +http://www.sisudoc.org/sisu/sisu_manual 3~ sisu insert files (.ssi) @@ -99,9 +101,9 @@ _1 sisu -S SiSU processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. -http://www.jus.uio.no/sisu/sisu_commands +http://www.sisudoc.org/sisu/sisu_commands -http://www.jus.uio.no/sisu/sisu_manual +http://www.sisudoc.org/sisu/sisu_manual 1~alt Experimental Alternative Input Representations diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst index a49b3522..4f273f4a 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Help -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -54,9 +56,9 @@ _1 http://sisudoc.org/sisu/sisu_manual/ The manual can be generated from source, found respectively, either within the SiSU tarball or installed locally at: -_1 ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ +_1 ./data/doc/sisu/markup-samples/sisu_manual -_1 /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/ +_1 /usr/share/doc/sisu/markup-samples/sisu_manual move to the respective directory and type e.g.: @@ -76,17 +78,17 @@ _1 man sisu_commands Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: -_1 ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ +_1 ./data/doc/sisu/markup-samples/sisu_manual Once installed, directory equivalent to: -_1 /usr/share/doc/sisu/sisu_manual/ +_1 /usr/share/doc/sisu/markup-samples/sisu_manual Available man pages are converted back to html using man2html: -_1 /usr/share/doc/sisu/v2/html/ +_1 /usr/share/doc/sisu/html/ -_1 ./data/doc/sisu/v2/html/ +_1 ./data/doc/sisu/html An online version of the sisu man page is available here: @@ -126,6 +128,4 @@ _1 man sisu_help_sources !_ man2html -_1 /usr/share/doc/sisu/v2/html/sisu.1.html - -_1 http://sisudoc.org/sisu/sisu_help_sources/index.html +_1 /usr/share/doc/sisu/html/sisu.1.html diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst index 90a0efc6..2cf2ba10 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst @@ -1,11 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: References -@creator: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -117,73 +119,21 @@ http://sisudoc.org/sisu/sisu_manual/index.html _1 http://sisudoc.org/sisu/sisu_manual/index.html -_1 http://sisudoc.org/sisu/sisu_commands/index.html - -_1 http://sisudoc.org/sisu/sisu_complete/index.html - -_1 http://sisudoc.org/sisu/sisu_configuration/index.html - -_1 http://sisudoc.org/sisu/sisu_description/index.html - -_1 http://sisudoc.org/sisu/sisu_examples/index.html - -_1 http://sisudoc.org/sisu/sisu_faq/index.html - -_1 http://sisudoc.org/sisu/sisu_filetypes/index.html - -_1 http://sisudoc.org/sisu/sisu_help/index.html - -_1 http://sisudoc.org/sisu/sisu_help_sources/index.html - -_1 http://sisudoc.org/sisu/sisu_howto/index.html - -_1 http://sisudoc.org/sisu/sisu_introduction/index.html - -_1 http://sisudoc.org/sisu/sisu_manual/index.html - -_1 http://sisudoc.org/sisu/sisu_markup/index.html - -_1 http://sisudoc.org/sisu/sisu_output_overview/index.html - -_1 http://sisudoc.org/sisu/sisu_pdf/index.html - -_1 http://sisudoc.org/sisu/sisu_postgresql/index.html - -_1 http://sisudoc.org/sisu/sisu_quickstart/index.html - -_1 http://sisudoc.org/sisu/sisu_remote/index.html - -_1 http://sisudoc.org/sisu/sisu_search/index.html - -_1 http://sisudoc.org/sisu/sisu_skin/index.html - -_1 http://sisudoc.org/sisu/sisu_sqlite/index.html - -_1 http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html - -_1 http://sisudoc.org/sisu/sisu_vim/index.html - -_1 http://sisudoc.org/sisu/sisu_webrick/index.html - 2~ man2html 3~ locally installed -file:///usr/share/doc/sisu/v2/html/sisu.1.html - -file:///usr/share/doc/sisu/v2/html/sisu_help.1.html - -file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html +file:///usr/share/doc/sisu/html/sisu.1.html -_1 /usr/share/doc/sisu/v2/html/sisu.1.html +_1 file:///usr/share/doc/sisu/html/sisu.1.html -_1 /usr/share/doc/sisu/v2/html/sisu_pdf.7.html +_1 file:///usr/share/doc/sisu/html/sisu_pdf.7.html -_1 /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html +_1 file:///usr/share/doc/sisu/html/sisu_postgresql.7.html -_1 /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html +_1 file:///usr/share/doc/sisu/html/sisu_sqlite.7.html -_1 /usr/share/doc/sisu/v2/html/sisu_webrick.1.html +_1 file:///usr/share/doc/sisu/html/sisu_webrick.1.html 3~ www.jus.uio.no/sisu diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi index 0fd681fa..c7bb119a 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Homepages -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual.ssm sisu.ssm -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :published: 2007-09-16 :created: 2007-08-28 @@ -20,24 +18,6 @@ :available: 2007-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? Setting up of homepages diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi index bd7f15d8..d59a8bc5 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi @@ -1,18 +1,16 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: How Does SiSU Work? -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: manual -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -20,24 +18,6 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? Description diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst index 8dfee20b..34a4eab1 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst @@ -1,11 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Technical, Howto -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -69,8 +71,6 @@ _* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html _* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html -_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html - _* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html 2~ SiSU built-in help @@ -139,7 +139,11 @@ aptitude install sisu-sqlite ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) -cp -rv /usr/share/doc/sisu-markup-samples/v2/samples /. +cp -rv /usr/share/doc/sisu/markup-samples/samples . + +you are better off installing the package sisu-markup-samples which will make the following available + +cp -rv /usr/share/doc/sisu/markup-samples-non-free/samples . !_ (3) use sisu to create an sqlite database @@ -165,7 +169,9 @@ sisu -W within the sisu-examples directory -sisu -F webrick +sisu -F webserv=webrick + +and follow the instructions provided #here i run into a problem, you are working from a read only #directory..., not my usual mode of operation, to complete the example @@ -178,11 +184,11 @@ sisu -F webrick !_ (7) copy the search form to the cgi directory -the string should be provided as output from the previous command +sisu -F webserv=webrick -sudo cp -vi /usr/share/doc/sisu-markup-samples/v2/samples/sisu_sqlite.cgi /usr/lib/cgi-bin +and follow the instructions provided -sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi +% sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi !_ (8) open up the form in your browser and query it @@ -267,24 +273,36 @@ _1 sisu -vR[and processing flags] [filename/wildcard] Sample provided, on untarring the source tarball: -_1 conf/sisu/sisurc.yaml +_1 conf/sisu/v2/sisurc.yml + +_1 conf/sisu/v3/sisurc.yml and on installation under: -_1 /etc/sisu/sisurc.yaml +_1 /etc/sisu/v2/sisurc.yml + +_1 /etc/sisu/v3/sisurc.yml The following paths are searched: -_1 ./_sisu/sisurc.yaml +_1 ./_sisu/v2/sisurc.yml or ./_sisu/v3/sisurc.yml -_1 ~/.sisu/sisurc.yaml +_1 ./_sisu/sisurc.yml -_1 ./etc/sisu/sisurc.yaml +_1 ~/.sisu/v2/sisurc.yml or ~/.sisu/v3/sisurc.yml + +_1 ~/.sisu/sisurc.yml + +_1 /etc/sisu/v2/sisurc.yml /etc/sisu/v3/sisurc.yml + +_1 /etc/sisu/sisurc.yml 1~howto_markup Markup See sample markup provided on +http://www.sisudoc.org/ + http://www.jus.uio.no/sisu http://www.jus.uio.no/sisu_markup @@ -293,15 +311,21 @@ http://www.jus.uio.no/sisu/SiSU in particular for each of the document output samples provided, the source document is provided as well -http://www.jus.uio.no/sisu/SiSU/2#books +http://www.jus.uio.no/sisu/SiSU/examples.html on untarring the source tarball: -_1 data/sisu-examples/sample/document_samples_sisu_markup/ +_1 data/doc/sisu/markup-samples or the same once source is installed (or sisu-examples) under: -_1 /usr/share/doc/sisu-markup-samples/v2/samples +_1 /usr/share/doc/sisu/markup-samples/ + +and if you have sisu-markup-samples installed, under + +_1 data/doc/sisu/markup-samples-non-free/ + +_1 /usr/share/doc/sisu/markup-samples-non-free/ Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* @@ -385,19 +409,19 @@ here\~^ 2~ Links -{ SiSU }http://sisudoc.org +{ SiSU }http://www.sisudoc.org code{ -{ SiSU }http://sisudoc.org +{ SiSU }http://www.sisudoc.org }code -{sisu.png }http://sisudoc.org +{sisu.png }http://www.sisudoc.org code{ -{sisu.png }http://sisudoc.org +{sisu.png }http://www.sisudoc.org }code @@ -409,11 +433,11 @@ code{ }code -{~^ SiSU }http://sisudoc.org +{~^ SiSU }http://www.sisudoc.org code{ -{~^ SiSU }http://sisudoc.org +{~^ SiSU }http://www.sisudoc.org }code @@ -421,17 +445,17 @@ is equivalent to: code{ -{ SiSU }http://sisudoc.org ~{ http://sisudoc.org }~ +{ SiSU }http://www.sisudoc.org ~{ http://www.sisudoc.org }~ }code the same can be done with an image: -{~^ sisu.png "SiSU" }http://sisudoc.org +{~^ sisu.png "SiSU" }http://www.sisudoc.org code{ -{~^ sisu.png "SiSU" }http://sisudoc.org +{~^ sisu.png "SiSU" }http://www.sisudoc.org }code @@ -624,7 +648,9 @@ A document may specify its own/bespoke css file using the css header. SiSU 0.55 2007w27/6 2007-07-07 -Homepage: http://www.jus.uio.no/sisu +Homepage: http://www.sisudoc.org + +old homepage: http://www.jus.uio.no/sisu !_ Description @@ -646,7 +672,9 @@ Dependencies for various features are taken care of in sisu related packages. Th Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. -Homepage: http://www.jus.uio.no/sisu +Homepage: http://www.sisudoc.org + +old homepage: http://www.jus.uio.no/sisu SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works. @@ -674,6 +702,8 @@ Once set up it is simple to use. 2~ Online Information, places to look +http://www.sisudoc.org + http://www.jus.uio.no/sisu Download Sources: @@ -816,74 +846,51 @@ Once installed see 'man 8 sisu' for some information on additional programs that The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU). -The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. +The following is from the debian/control file of sisu-3.0.2, which amongst other things provides the dependencies of sisu within Debian. code{ -Package: sisu -Architecture: all -Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip -Conflicts: vim-sisu, sisu-vim, sisu-remote -Replaces: vim-sisu, sisu-vim -Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, -tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, -hyperestraier, kdissert, vim-addon-manager -Suggests: rcs | cvs, lv, texinfo, pinfo - -Package: sisu-complete -Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite -Recommends: hyperestraier - -Package: sisu-pdf -Architecture: all -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, -texlive-latex-recommended, texlive-latex-extra -Suggests: evince, xpdf - -Package: sisu-postgresql -Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby -Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 - -Package: sisu-sqlite -Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby -Suggests: libdbd-sqlite - -Package: sisu-markup-samples -Depends: sisu +Source: sisu +Section: text +Priority: optional +Maintainer: SiSU Project <sisu@lists.sisudoc.org> +Uploaders: Ralph Amissah <ralph@amissah.com> +Build-Depends: debhelper (>= 8) +Standards-Version: 3.9.1 +Homepage: http://www.sisudoc.org/ +Vcs-Browser: http://git.sisudoc.org/?p=code/sisu.git +Vcs-Git: git://git.sisudoc.org/git/code/sisu.git +XS-Dm-Upload-Allowed: yes }code code{ -Source: sisu -Section: text -Priority: optional -Maintainer: Ralph Amissah <ralph@amissah.com> -Build-Depends: debhelper (>= 5) -Standards-Version: 3.7.2 - Package: sisu Architecture: all -Depends: ruby (>= 1.8.2), ruby (<< 1.9), libwebrick-ruby, unzip, zip -Conflicts: vim-sisu, sisu-vim, sisu-remote -Replaces: vim-sisu, sisu-vim -Recommends: sisu-doc, sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager -Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang +Depends: ${misc:Depends}, ruby (>= 1.8.2), libwebrick-ruby, rsync, unzip, zip +Recommends: + sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick, keychain, librmagick-ruby, + librexml-ruby, openssl, openssh-client | lsh-client, tidy, vim-addon-manager +Suggests: lv, calibre, pinfo, texinfo, trang +Conflicts: sisu-markup-samples (<= 1.0.11) +Replaces: sisu-markup-samples (<= 1.0.11) Description: documents - structuring, publishing in multiple formats and search SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. . With minimal preparation of a plain-text, (UTF-8) file, using its native -markup syntax in your text editor of choice, SiSU can generate various document -formats (most of which share a common object numbering system for locating -content), including plain text, HTML, XHTML, EPUB, XML, OpenDocument text -(ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly -paragraph-sized chunks) so searches may be performed and matches returned with -that degree of granularity: your search criteria is met by these documents and -at these locations within each document. Object numbering is particularly -suitable for "published" works (finalized texts as opposed to works that are -frequently changed or updated) for which it provides a fixed means of reference -of content. Document outputs also share semantic meta-data provided. + markup syntax in your text editor of choice, SiSU can generate various + document formats (most of which share a common object numbering system for + locating content), including plain text, HTML, XHTML, XML, EPUB, OpenDocument + text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects + (roughly paragraph-sized chunks) so searches may be performed and matches + returned with that degree of granularity: your search criteria is met by these + documents and at these locations within each document. Object numbering is + particularly suitable for "published" works (finalized texts as opposed to + works that are frequently changed or updated) for which it provides a fixed + means of reference of content. Document outputs also share semantic meta-data + provided. . SiSU also provides concordance files, document content certificates and manifests of generated output. @@ -901,8 +908,6 @@ of content. Document outputs also share semantic meta-data provided. sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. - . - Homepage: <http://www.jus.uio.no/sisu> }code @@ -910,35 +915,35 @@ code{ Package: sisu-complete Architecture: all -Depends: ruby (>= 1.8.2), ruby (<< 1.9), sisu, sisu-doc, sisu-pdf, sisu-postgresql, sisu-sqlite -Recommends: hyperestraier +Depends: + ${misc:Depends}, ruby (>= 1.8.2), sisu (= ${source:Version}), + sisu-pdf (= ${source:Version}), sisu-postgresql (= ${source:Version}), + sisu-sqlite (= ${source:Version}) Description: installs all SiSU related packages - This package installs SiSU and related packages that enable sisu to produce - pdf and to populate postgresql and sqlite databases. - . SiSU is a lightweight markup based document structuring, publishing and search framework for document collections. . - See sisu for a description of the package. + This package installs SiSU and related packages that enable sisu to produce + pdf and to populate PostgreSQL and sqlite databases. . - Homepage: <http://www.jus.uio.no/sisu> + See sisu for a description of the package. }code code{ -Package: sisu-doc +Package: sisu-pdf Architecture: all -Depends: sisu -Recommends: sisu-pdf, sisu-postgresql, sisu-sqlite -Description: sisu manual and other documentation for sisu - Multiple file formats generated output of sisu documentation generated from - sisu markup source documents included in the main package - . +Depends: + ${misc:Depends}, sisu, texlive-latex-base, texlive-fonts-recommended, + texlive-latex-recommended, texlive-latex-extra, texlive-xetex, lmodern, + ttf-liberation +Suggests: evince | pdf-viewer +Description: dependencies to convert SiSU LaTeX output to pdf SiSU is a lightweight markup based document structuring, publishing and search framework for document collections. . - Homepage: <http://www.jus.uio.no/sisu> + This package enables the conversion of SiSU LaTeX output to pdf. }code @@ -946,15 +951,16 @@ code{ Package: sisu-pdf Architecture: all -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, texlive-latex-extra -Recommends: sisu-doc +Depends: + ${misc:Depends}, sisu, texlive-latex-base, texlive-fonts-recommended, + texlive-latex-recommended, texlive-latex-extra, texlive-xetex, lmodern, + ttf-liberation +Suggests: evince | pdf-viewer Description: dependencies to convert SiSU LaTeX output to pdf - This package enables the conversion of SiSU LaTeX output to pdf. - . SiSU is a lightweight markup based document structuring, publishing and search framework for document collections. . - Homepage: <http://www.jus.uio.no/sisu> + This package enables the conversion of SiSU LaTeX output to pdf. }code @@ -962,11 +968,15 @@ code{ Package: sisu-postgresql Architecture: all -Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql -Recommends: sisu-doc, libfcgi-ruby +Depends: + ${misc:Depends}, sisu, libdbd-pg-ruby, libdbd-pg-ruby1.8, libdbi-ruby, + libdbi-ruby1.8, libdbm-ruby, postgresql, libfcgi-ruby1.8 | libfcgi-ruby1.9.1 Suggests: postgresql-contrib -Description: SiSU dependencies for use with postgresql database - This package enables SiSU to populate a postgresql database. This is done at +Description: SiSU dependencies for use with PostgreSQL database + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + This package enables SiSU to populate a PostgreSQL database. This is done at an object/paragraph level, making granular searches of documents possible. . This relational database feature of SiSU is not required but provides @@ -974,11 +984,6 @@ Description: SiSU dependencies for use with postgresql database for matching units of text, primarily paragraphs that can be displayed or identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: <http://www.jus.uio.no/sisu> }code @@ -986,10 +991,15 @@ code{ Package: sisu-sqlite Architecture: all -Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby -Recommends: sisu-doc, libfcgi-ruby -Description: SiSU dependencies for use with sqlite database - This package enables SiSU to populate an sqlite database. This is done at an +Depends: + ${misc:Depends}, sisu, sqlite3, libsqlite3-ruby, libdbd-sqlite3-ruby, + libdbd-sqlite3-ruby1.8, libdbi-ruby, libdbi-ruby1.8, libdbm-ruby, + libfcgi-ruby1.8 | libfcgi-ruby1.9.1 +Description: SiSU dependencies for use with SQLite database + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + This package enables SiSU to populate an SQLite database. This is done at an object/paragraph level, making granular searches of documents possible. . This relational database feature of SiSU is not required but provides @@ -997,11 +1007,6 @@ Description: SiSU dependencies for use with sqlite database for matching units of text, primarily paragraphs that can be displayed or identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: <http://www.jus.uio.no/sisu> }code @@ -1027,7 +1032,7 @@ look at output results, see the "sisu_manifest" page created for the document or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. -sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst +sisu -3 http://www.jus.uio.no/sisu/src/free_culture.lawrence_lessig.sst the database stuff is extra perhaps, the latex stuff could be considered extra perhaps but neither needs to be installed for most of sisu output to work @@ -1168,11 +1173,11 @@ _1 ./data/doc/sisu/sisu_markup_samples/dfsg These are installed on the system usually at: -_1 /usr/share/doc/sisu/v2/sisu_markup_samples/samples +_1 /usr/share/doc/sisu/markup-samples/samples -More markup samples are available in the package sisu-markup-samples +More markup samples are available in the package sisu-markup-samples, which if installed should be available at: -_1 http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples +_1 /usr/share/doc/sisu/markup-samples-non-free/samples Many more are available online off: @@ -1182,11 +1187,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html There is syntax support for some editors provided (together with a README file) in -_1 ./data/sisu/conf/syntax +_1 ./data/sisu/v2/conf/editor-syntax-etc usually installed to: -_1 /usr/share/sisu/v2/conf/syntax +_1 /usr/share/sisu/v2/conf/editor-syntax-etc 2~ License @@ -1260,9 +1265,9 @@ _1 sisu -V To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g. -_1 sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst +_1 sisu -1 http://www.jus.uio.no/sisu/src/gpl.fsf.sst -_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst +_1 sisu -3 http://www.jus.uio.no/sisu/src/free_culture.lawrence_lessig.sst examine source document, vim has syntax highlighting support @@ -1274,11 +1279,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely. -_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip +_1 sisu -3 http://www.jus.uio.no/sisu/pod/free_culture.lawrence_lessig.sst.zip there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended: -_1 sisu -3 --trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip +_1 sisu -3 --trust http://www.jus.uio.no/sisu/pod/free_culture.lawrence_lessig.sst.zip For help @@ -1302,12 +1307,16 @@ _1 mkdir ~/sisu_test _1 cd ~/sisu_test -_1 cp -a /usr/share/doc/sisu/v2/sisu_markup_samples/samples/* ~/sisu_test/. +_1 cp -a /usr/share/doc/sisu/markup-samples/samples/* ~/sisu_test/. -!_ Tip: -the markup syntax examples may be of interest +better if you have installed sisu-markup-samples -_1 http://www.jus.uio.no/sisu/sample/ +_1 cp -a /usr/share/doc/sisu/markup-samples-non-free/samples/* ~/sisu_test/. + +% !_ Tip: +% the markup syntax examples may be of interest +% +% _1 http://www.jus.uio.no/sisu/sample/ !_ Tip: @@ -1360,7 +1369,9 @@ Dependencies for various features are taken care of in sisu related packages. Th Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. -Homepage: http://www.jus.uio.no/sisu +Homepage: http://www.sisudoc.org + +old homepage: http://www.jus.uio.no/sisu 3~ Document Resource Configuration diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi index 5674b4b4..d1a902e7 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Hyperestraier Search -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -20,24 +18,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? SiSU Search - Hyperestraier diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi index cde444ed..acffb07e 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Installation -@creator: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual.ssm SiSU.ssm -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :published: 2007-09-16 :created: 2002-11-12 @@ -20,31 +18,13 @@ :available: 2002-11-12 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? SiSU Installation notes :C~ Installation 1~installation Installation -See the {~^ download pages }http://www.jus.uio.no/sisu/SiSU/download ~{ <br> http://www.jus.uio.no/sisu/sisu_download }~ for information related to installation. +See the {~^ download pages }http://www.jus.uio.no/sisu/SiSU/download.html for information related to installation. 2~ Debian diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi index 3c8b12b0..304046f8 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi @@ -1,18 +1,16 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Who Might Be Interested? -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: manual -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -20,24 +18,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? Who might SiSU interest? diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst index b01eed59..a94e9145 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Introduction -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: manual @@ -27,16 +29,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -66,6 +68,8 @@ SiSU also provides other features such as concordance files and document content SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. +http://www.sisudoc.org/ + http://www.jus.uio.no/sisu % SiSU is a way of preparing, publishing, managing and searching documents. diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm index 7622d0b0..ca96daa1 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm @@ -1,11 +1,13 @@ -% SiSU master 3.0 +% SiSU master 2.0 @title: SiSU :subtitle: Manual -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~ @title @creator diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index be36fc79..90cce5ca 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -1,4 +1,4 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Markup @@ -31,16 +31,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -254,7 +254,7 @@ code{ code{ -@links: { SiSU }http://www.jus.uio.no/sisu/ +@links: { SiSU }http://www.sisudoc.org { FSF }http://www.fsf.org }code @@ -526,13 +526,13 @@ urls found within text are marked up automatically. A url within text is automat code{ -normal text http://www.jus.uio.no/sisu continues +normal text http://www.sisudoc.org/ continues }code !_ resulting output: -normal text http://www.jus.uio.no/sisu continues +normal text http://www.sisudoc.org/ continues An escaped url without decoration @@ -540,7 +540,7 @@ An escaped url without decoration code{ -normal text _http://www.jus.uio.no/sisu continues +normal text _http://www.sisudoc.org/ continues deb http://www.jus.uio.no/sisu/archive unstable main non-free @@ -548,7 +548,7 @@ deb http://www.jus.uio.no/sisu/archive unstable main non-free !_ resulting output: -normal text _http://www.jus.uio.no/sisu continues +normal text _http://www.sisudoc.org/ continues deb _http://www.jus.uio.no/sisu/archive unstable main non-free @@ -577,7 +577,7 @@ about { SiSU }http://url.org markup !_ resulting output: -about { SiSU }http://www.jus.uio.no/sisu/ markup +about { SiSU }http://www.sisudoc.org/ markup A shortcut notation is available so the url link may also be provided automatically as a footnote @@ -591,7 +591,7 @@ about {~^ SiSU }http://url.org markup !_ resulting output: -about {~^ SiSU }http://www.jus.uio.no/sisu/ markup +about {~^ SiSU }http://www.sisudoc.org/ markup Internal document links to a tagged location, including an ocn @@ -631,9 +631,9 @@ code{ % various url linked images -{tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/ +{tux.png 64x80 "a better way" }http://www.sisudoc.org/ -{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ @@ -643,9 +643,9 @@ code{ { tux.png 64x80 }image -{tux.png 64x80 "Gnu/Linux - a better way" }http://www.jus.uio.no/sisu/ +{tux.png 64x80 "Gnu/Linux - a better way" }http://www.sisudoc.org/ -{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst index 9664a189..0ecbd692 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: SiSU overview of status of features available in various outputs -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ % :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst index 9d226d66..9b3f075f 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Search -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :topic_register: electronic documents:SiSU:document:postgresql;SiSU:manual:postgresql;electronic documents:SiSU:manual:postgresql;SiSU:document:postgresql;SiSU:document:postgresql; @@ -29,16 +31,16 @@ :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -Dv [filename/wildcard ]\n sisu -Dv [instruction] @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst index 0752264e..6557a0cd 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Quickstart, installation and use -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -237,9 +239,9 @@ _1 man sisu The man pages are also available online, though not always kept as up to date as within the package itself: -_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1 +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html -_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8 +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html _* {~^ man directory }http://www.jus.uio.no/sisu/man @@ -255,6 +257,8 @@ sisu --help --markup 3~ The home page +http://www.sisudoc.org/ + http://www.jus.uio.no/sisu http://www.jus.uio.no/sisu/SiSU diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst index 0782a290..b9f1b1a8 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Remote Operations -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -57,7 +59,7 @@ sisu -3 http://[provide url to valid .sst or .ssm file] }code -Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url for the desired document. +Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url to the .sst for the desired document. NOTE: to set up a remote machine to serve SiSU documents in this way, images should be in the directory relative to the document source ../_sisu/image diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm index e2d8c459..406c8c1d 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm @@ -1,11 +1,13 @@ -% SiSU master 3.0 +% SiSU master 2.0 @title: SiSU :subtitle: Search -@creator: :author: Ralph Amissah +@creator: + :author: Ralph Amissah -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -25,16 +27,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi index dd5f1b54..fde97254 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Search -@creator: :author: Ralph Amissah +@creator: + :author: Ralph Amissah -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual.ssm sisu.ssm -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -20,24 +18,6 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi index da18f3fc..cd9e241c 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi @@ -1,18 +1,16 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Search -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual.ssm -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -26,18 +24,6 @@ :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi index baf0c6bb..063d5caa 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi @@ -1,44 +1,23 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Summary of Features -@creator: :author: Ralph Amissah +@creator: + :author: Ralph Amissah -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: manual -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 + :published: 2007-09-16 :modified: 2011-02-07 -@date: :published: 2007-09-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? What is SiSU? diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_skin.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_skin.sst index c1035824..02858593 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_skin.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_skin.sst @@ -1,11 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Skins -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -92,13 +94,13 @@ A site skin, modifies the program default skin. With SiSU installed sample skins may be found in: -_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc +_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc (or equivalent directory) and if sisu-markup-samples is installed also under: -_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc +_1 /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) +_1 /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml (or equivalent directory) diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi index c68fcbc6..818ed871 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi @@ -1,11 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: SQL and Search -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 % used_by: sisu_manual.ssm @@ -20,24 +22,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst index c3f7e0ef..45d51f06 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Sqlite / search -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -29,16 +31,16 @@ :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -dv [filename/wildcard ]\n sisu -dv [instruction] @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi index 9fac39a8..722a8b29 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi @@ -7,11 +7,6 @@ @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - % used_by: sisu_manual SiSU.ssm @date: @@ -21,24 +16,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? SiSU Commands diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst index 924abf11..2cbd26f4 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst @@ -1,11 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Syntax Highlighting -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -47,9 +49,13 @@ The directory: -_1 ./data/sisu/conf/editor-syntax-etc/ +_1 ./data/sisu/v2/conf/editor-syntax-etc/ + +_1 ./data/sisu/v3/conf/editor-syntax-etc/ + +_1 /usr/share/sisu/v2/conf/editor-syntax-etc -_1 /usr/share/sisu/conf/editor-syntax-etc +_1 /usr/share/sisu/v3/conf/editor-syntax-etc contains rudimentary sisu syntax highlighting files for: @@ -145,7 +151,7 @@ _1 files: sisu-mode.el _1 to file ~/.emacs add the following 2 lines: -_2 (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") +_2 (add-to-list 'load-path "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs") _2 (require 'sisu-mode.el) diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst index 282513d7..e6239d02 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst @@ -1,11 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: sisu_webrick -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -29,15 +31,16 @@ :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W @links: - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -75,7 +78,7 @@ sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, 2~ Further information -For more information on SiSU see: http://www.jus.uio.no/sisu +For more information on SiSU see: http://www.sisudoc.org/ or http://www.jus.uio.no/sisu or man sisu @@ -89,5 +92,3 @@ _1 sisu(1) _1 sisu_vim(7) -_1 sisu(8) - diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi index 42e3b93c..4ef78580 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi @@ -1,15 +1,13 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU :subtitle: Work Needed and Wishlist -@creator: :author: Ralph Amissah +@creator: + :author: Ralph Amissah -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @date: :created: 2002-08-28 @@ -18,24 +16,6 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - :A~? @title @creator :B~? Work Needed and Wishlist diff --git a/data/doc/sisu/sisu_user_txt/configuration_sisurc.txt b/data/doc/sisu/sisu_user_txt/configuration_sisurc.txt index 62a2ce02..d5fda20d 100644 --- a/data/doc/sisu/sisu_user_txt/configuration_sisurc.txt +++ b/data/doc/sisu/sisu_user_txt/configuration_sisurc.txt @@ -8,130 +8,7 @@ be modified in sisurc.yml sisurc.yml can be located in one of the following locations: /etc/sisu/sisurc.yml ~/.sisu/sisurc.yml and ./_sisu/sisurc.yml -if sisu versions 1 and 2 are both in use, the v2 sisurc.yml can be placed a the +and if sisu versions 2 and 3 are both in use, the v2 sisurc.yml can be placed a the following locations: /etc/sisu/v2/sisurc.yml ~/.sisu/v2/sisurc.yml and ./_sisu/v2/sisurc.yml - -# Name: SiSU - Simple information Structuring Universe -# Author: Ralph@Amissah.com -# Description: Site wide envionment defaults set here -# system environment info / resource configuration file, for sisu -# License: GPL v3 or later -# site environment configuration file -# this file should be configured and live in -# /etc/sisu #per environment settings, overridden by: -# ~/.sisu #per user settings, overridden by: -# ./_sisu #per local markup directory settings -#% #image source directory, main path and subdirectories -#image: -# path: 'sisu_working' -# public: '_sisu/image' -#% presentation/web directory, main path and subdirectories (most subdirectories are created automatically based on markup directory name) -#webserv: -# url_root: 'http://www.your.url' #without dir stub -# path: '/var/www' #either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home -# images: '_sisu/image' -# man: 'man' -# cgi: '/usr/lib/cgi-bin' -# feed: 'feed' -# sqlite: 'sisu/sqlite' -# webrick_url: true -#show_output_on: 'filesystem' #for -v and -u url information, alternatives: 'filesystem','webserver','remote_webserver','local:8111','localhost','localhost:8080','webrick','path' -#show_output_on: 'local:8111' -#webserv_cgi: -# host: localhost -# base_path: ~ -# port: '8081' -# user: ~ -show_output_on: 'filesystem_url' -#texinfo display output -#texinfo: -# stub: 'texinfo' -##% processing directories, main path and subdirectories (appended to $HOME), using defaults set in sysenv -#processing: -# path: '~' -# dir: '.sisu_processing~' -# metaverse: 'metaverse' -# tune: 'tune' -# latex: 'tex' -# texinfo: 'texinfo' -# concord_max: 400000 -#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default) -flag: - color: true # making colour default -c is toggle, and will now toggle colour off - default: '-NhwepoabxXyYv' # -m run by default; includes verbose - i: '-hwpoay' # -m run by default - ii: '-NhwepoabxXy' # -m run by default - iii: '-NhwepoabxXyY' # -m run by default - iv: '-NhwepoabxXYDy --update' # -m run by default - v: '-NhwepoabxXYDyv --update' # -m run by default; includes verbose -#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal -default: - papersize: 'A4,letter' - #text_wrap: 78 - #emphasis: 'bold' #make *{emphasis}* 'bold', 'italics' or 'underscore', default if not configured is 'bold' - #digest: 'sha' #sha is sha256, default is md5 - #multilingual: false - #language_file: 2 - #language: 'English' -#% markup, make *{emphasis}* 'bold' or 'italics', default if not configured is 'bold' -#% settings used by ssh scp -#remote: -# - -# user: '[usrname]' -# host: '[remote.hostname]' -# path: '.' #no trailing slash eg 'sisu/www' -# - -# user: '[usrname]' -# host: '[remote.hostname]' -# path: '.' #no trailing slash eg 'sisu/www' -#% webrick information -#webrick: -# port: '8081' -#% sql database info, postgresql and sqlite -#db: -# share_source: false # boolean, default is false -# postgresql: -# port: # '[port (default is 5432)]' -# host: # '[if not localhost, provide host tcp/ip address or domain name]'' -# user: # '[(if different from user) provide username]' -# password: # '[password if required]' -# sqlite: -# path: ~ # './sisu_sqlite.db' -# port: "**" -#% possible values ~, true, false, or command instruction e.g. editor: 'gvim -c :R -c :S'. -#will only ignore if value set to false, absence or nil will not remove program as should operate without rc file -#ie in case of ~ will ignore and use hard coded defaults within program), true, false, or command instruction e.g. editor: 'gvim -c :R -c :S' -#on value true system defaults used, to change, e.g. editor specify -permission_set: - zap: false - css_modify: false -# remote_base_site: true -program_set: - rmagick: false -# wc: true -# editor: true -# postgresql: true -# sqlite: true -# tidy: true -# rexml: true -# pdflatex: true -#program_select: -# editor: 'gvim -c :R -c :S' -# pdf_viewer: 'evince' -# web_browser: 'firefox' #'iceweasel' #'epiphany' #'galeon' #'konqueror' #'kazehakase' -# console_www_browser: 'links2' #'elinks' -# odf_viewer: 'oowriter' #'abiword' -# xml_viewer: 'xml-viewer' -# man: 'nroff -man' #'groff -man -Tascii' # 'nroff -man' -#promo: sisu_icon, sisu, sisu_search_libre, open_society, fsf, ruby -#search: -# sisu: -# flag: true -## action: http://localhost:8081/cgi-bin/sisu_pgsql.cgi -# action: http://search.sisudoc.org -# db: sisu -# title: sample search form -# hyperestraier: -# flag: true -# action: http://search.sisudoc.org/cgi-bin/estseek.cgi? +/etc/sisu/v3/sisurc.yml ~/.sisu/v3/sisurc.yml and ./_sisu/v3/sisurc.yml diff --git a/data/doc/sisu/sisu_user_txt/markup_content.txt b/data/doc/sisu/sisu_user_txt/markup_content.txt index 326fabe1..edac0170 100644 --- a/data/doc/sisu/sisu_user_txt/markup_content.txt +++ b/data/doc/sisu/sisu_user_txt/markup_content.txt @@ -180,10 +180,10 @@ To link text or an image to a url the markup is as follows Where it is wished to include the url for the linked text in a footnote, the long form of markup would be: -{ SiSU }http://www.jus.uio.no/sisu/ ~{ http://www.jus.uio.no/sisu/ }~ +{ SiSU }http://www.sisudoc.org/ ~{ http://www.sisudoc.org/ }~ A short form is provided for achieving the same: - {~^ SiSU }http://www.jus.uio.no/sisu/ + {~^ SiSU }http://www.sisudoc.org/ %% images ---------------------------------------------------------------------- @@ -194,9 +194,9 @@ The following are examples of links to images { tux.png 64x80 }image -{tux.png 64x80 "Gnu/Linux - a better way" }http://www.jus.uio.no/sisu/ +{tux.png 64x80 "Gnu/Linux - a better way" }http://www.sisudoc.org/ -{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ The 64x80 in the first example is the image dimension, (width x height). This may be omitted if imagemagick or graphicsmagick are installed, as they will diff --git a/data/doc/sisu/sisu_user_txt/markup_headers_metadata.txt b/data/doc/sisu/sisu_user_txt/markup_headers_metadata.txt index c24789c8..3dd42444 100644 --- a/data/doc/sisu/sisu_user_txt/markup_headers_metadata.txt +++ b/data/doc/sisu/sisu_user_txt/markup_headers_metadata.txt @@ -27,8 +27,13 @@ :modified: 2010-05-25 @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU diff --git a/data/sisu/v3/v/version.yml b/data/sisu/v3/v/version.yml index 419fa794..463b8e59 100644 --- a/data/sisu/v3/v/version.yml +++ b/data/sisu/v3/v/version.yml @@ -1,5 +1,5 @@ --- :version: 3.0.2-beta-rb1.9.2p180 -:date_stamp: 2011w09/2 -:date: "2011-03-01" +:date_stamp: 2011w09/6 +:date: "2011-03-05" :project: SiSU diff --git a/lib/sisu/v2/defaults.rb b/lib/sisu/v2/defaults.rb index 2c3cf207..31cc449e 100644 --- a/lib/sisu/v2/defaults.rb +++ b/lib/sisu/v2/defaults.rb @@ -7,7 +7,7 @@ * Author: Ralph Amissah - * Copyright: (C) 1997 - 2010, Ralph Amissah, All Rights Reserved. + * Copyright: (C) 1997 - 2011, Ralph Amissah, All Rights Reserved. * License: GPL 3 or later: @@ -1776,6 +1776,14 @@ for search</title> </h1> <h2 class="top_band_tiny"> Structured information, Serialized Units + + <a href="http://www.sisudoc.org" target="_top" > + <www.sisudoc.org> + </a> + or + <a href="http://www.jus.uio.no/sisu/" target="_top" > + <www.jus.uio.no/sisu/> + </a> </h2> <h2 class="top_band_tiny"> software for electronic texts, document collections, books, digital libraries, and search, @@ -1871,110 +1879,15 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/license.html" target="_top" > - License + License, SiSU is licensed under + <a href="http://www.gnu.org/licenses/gpl.html" target="_top" > + GPLv3 or later </a> </p> <p class="tiny"> Gnu / Linux / Unix </p> <p class="tiny"> - ============= -</p> -<p class="small"> -<a href="http://www.sisudoc.org/sisu/sisu_markup/" target="_top" > - sisu markup - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_commands/" target="_top" > - sisu commands - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_manual/" target="_top" > - sisu manual - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/man" target="_top" > - sisu man pages - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="tiny"> - document preparation can be on any platform, in any editor: - (syntax highlight support currently for: vim, kate, write, gedit, diakonos) -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/syntax_highlight" target="_top" > - Syntax highlighting - </a> -</p> -<p class="tiny"> - ============= -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU" target="_top" > - * Composite document - </a> -</p> -<p class="tiny"> - the composite document is a superset of the following documents: -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_description" target="_top" > - SiSU description - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_examples" target="_top" > - SiSU examples - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_chronology" target="_top" > - SiSU chronology - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_technical_info" target="_top" > - SiSU technical - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_faq" target="_top" > - SiSU FAQ - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_download" target="_top" > - SiSU download - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_changelog" target="_top" > - SiSU changelog - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_license" target="_top" > - SiSU license - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_standard" target="_top" > - SiSU standard - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_provisional_patent_application_200408" target="_top" > - SiSU abandoned provisional patent - </a> -</p> -<p class="tiny"> Note: the placement of SiSU documents on the Net predate the release of SiSU. </p> </div> @@ -1989,7 +1902,7 @@ SiSU is a comprehensive future-proofing electronic document management system. Potential users of SiSU include individual authors who want to publish their books or articles electronically to reach a broad audience, web publishers who want to provide multiple channels of access to their electronic documents, or any organizations which centrally manage a medium or large set of electronic documents, especially governmental organizations which may prefer to keep their documents in easily accessible yet non-proprietary formats. </p> <p> -SiSU is an Open Source project initiated and led by Ralph Amissah (<a href="mailto:ralph.amissah@gmail.com">ralph.amissah@gmail.com</a>) and can be contacted via mailing list <a href="http://lists.sisudoc.org/listinfo/sisu">http://lists.sisudoc.org/listinfo/sisu</a> at <a href="mailto:sisu@lists.sisudoc.org">sisu@lists.sisudoc.org</a>. SiSU is licensed under the GNU General Public License. +SiSU is an Open Source project initiated and led by Ralph Amissah <a href="mailto:ralph.amissah@gmail.com"><ralph.amissah@gmail.com></a> and can be contacted via mailing list <a href="http://lists.sisudoc.org/listinfo/sisu"><http://lists.sisudoc.org/listinfo/sisu></a> at <a href="mailto:sisu@lists.sisudoc.org"><sisu@lists.sisudoc.org></a>. SiSU is licensed under the GNU General Public License. </p> <p class="bold"> For less markup than the most elementary HTML you can have more. @@ -2107,7 +2020,7 @@ as a developers tool it is flexible and extensible </p> <br /> <p class="small"> -More information on <a href="http://www.sisudoc.org/sisu/SiSU/"><b>SiSU</b></a> provided at <a href="http://www.sisudoc.org/sisu/SiSU/">www.sisudoc.org/sisu/SiSU</a></p> +<a href="http://www.sisudoc.org"><b>SiSU</b></a> at <a href="http://www.sisudoc.org"><www.sisudoc.org></a> or <a href="http://www.jus.uio.no/sisu/"><www.jus.uio.no/sisu/></a></p> </div> <div id="column_right"> <p class="tiny"> @@ -2120,7 +2033,7 @@ More information on <a href="http://www.sisudoc.org/sisu/SiSU/"><b>SiSU</b></a> <input type="hidden" name="a" value="1" /> <input type="radio" name="view" value="index" checked="checked" /> idx <input type="radio" name="view" value="text" /> txt -<a href="http://search.sisudoc.org" target="_top" >search.sisudoc.org</a> +<a href="http://search.sisudoc.org" target="_top" ><search.sisudoc.org></a> </form> <!-- Search SiSU --> </p> @@ -2144,7 +2057,7 @@ SiSU markup is fairly minimalistic, it consists of: a (largely optional) documen <p class="small"> More information on <a href="http://www.sisudoc.org/sisu/SiSU/"><b>SiSU</b></a> provided at: <a href="http://www.sisudoc.org/sisu/SiSU/"> - www.sisudoc.org/sisu/SiSU + <www.sisudoc.org/sisu/SiSU> </a> <p class="tiny"> SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...(humanities, law and part of the social sciences)). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time.</p> @@ -2152,22 +2065,22 @@ SiSU was developed in relation to legal documents, and is strong across a wide v SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored.</p> <p class="small"> <a href="mailto:ralph@amissah.com"> -ralph@amissah.com +<ralph@amissah.com> </a> </p> <p class="small"> <a href="mailto:ralph.amissah@gmail.com"> -ralph.amissah@gmail.com +<ralph.amissah@gmail.com> </a> </p> <p class="small"> <a href="mailto:sisu@lists.sisudoc.org"> -sisu@lists.sisudoc.org. +<sisu@lists.sisudoc.org> </a> </p> <p class="small"> <a href="http://lists.sisudoc.org/listinfo/sisu"> -http://lists.sisudoc.org/listinfo/sisu +<http://lists.sisudoc.org/listinfo/sisu> </a> </p> <p class="small"> diff --git a/lib/sisu/v2/manpage.rb b/lib/sisu/v2/manpage.rb index 2d13793b..18670e2a 100644 --- a/lib/sisu/v2/manpage.rb +++ b/lib/sisu/v2/manpage.rb @@ -7,7 +7,7 @@ * Author: Ralph Amissah - * Copyright: (C) 1997 - 2010, Ralph Amissah, All Rights Reserved. + * Copyright: (C) 1997 - 2011, Ralph Amissah, All Rights Reserved. * License: GPL 3 or later: @@ -139,7 +139,6 @@ module SiSU_Manpage if wrap =~ /^\s*[\d*+]+\s+.+?\s*\Z/m wrap.gsub!(/(^| |#{Mx[:nbsp]}|\s|\*)\\\*/,'\1\\\\\*') #man page requires wrap.gsub!(/\s\.(\S+)/,' \\.\1') - wrap.gsub!(/(["''])/,"\\\\\\1") # quotation marks need escape wrap.gsub!(/^\s*([\d*+]+)\s+(.+?)\s*\Z/m, <<GSUB .TP .BI \\1. @@ -301,9 +300,9 @@ WOK dob.obj.gsub!(/(?:#{Mx[:br_line]}|#{Mx[:br_nl]})+\s*/,"\n") # watch end dob.obj.gsub!(/(^| |#{Mx[:nbsp]}|\s|\*)\\\*/,'\1\\\\\*') #man page requires + dob.obj.gsub!(/┆/,'|') dob.obj.gsub!(/\s\.(\S+)/,' \\.\1') dob.obj.gsub!(/(\n\.)(\S\S\S+)/m,'\1\\.\2') - dob.obj.gsub!(/-/,'\-') #manpages use this dob.obj.gsub!(/~/,'~') if dob.obj #manpages use this if dob.is =~/group|verse|alt|code/ if dob.is =='code' diff --git a/lib/sisu/v3/defaults.rb b/lib/sisu/v3/defaults.rb index 87e8c577..2079da47 100644 --- a/lib/sisu/v3/defaults.rb +++ b/lib/sisu/v3/defaults.rb @@ -1777,6 +1777,14 @@ for search</title> </h1> <h2 class="top_band_tiny"> Structured information, Serialized Units + + <a href="http://www.sisudoc.org" target="_top" > + <www.sisudoc.org> + </a> + or + <a href="http://www.jus.uio.no/sisu/" target="_top" > + <www.jus.uio.no/sisu/> + </a> </h2> <h2 class="top_band_tiny"> software for electronic texts, document collections, books, digital libraries, and search, @@ -1872,110 +1880,15 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/license.html" target="_top" > - License + License, SiSU is licensed under + <a href="http://www.gnu.org/licenses/gpl.html" target="_top" > + GPLv3 or later </a> </p> <p class="tiny"> Gnu / Linux / Unix </p> <p class="tiny"> - ============= -</p> -<p class="small"> -<a href="http://www.sisudoc.org/sisu/sisu_markup/" target="_top" > - sisu markup - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_commands/" target="_top" > - sisu commands - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_manual/" target="_top" > - sisu manual - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/man" target="_top" > - sisu man pages - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="tiny"> - document preparation can be on any platform, in any editor: - (syntax highlight support currently for: vim, kate, write, gedit, diakonos) -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/syntax_highlight" target="_top" > - Syntax highlighting - </a> -</p> -<p class="tiny"> - ============= -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU" target="_top" > - * Composite document - </a> -</p> -<p class="tiny"> - the composite document is a superset of the following documents: -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_description" target="_top" > - SiSU description - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_examples" target="_top" > - SiSU examples - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_chronology" target="_top" > - SiSU chronology - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_technical_info" target="_top" > - SiSU technical - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_faq" target="_top" > - SiSU FAQ - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_download" target="_top" > - SiSU download - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_changelog" target="_top" > - SiSU changelog - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_license" target="_top" > - SiSU license - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_standard" target="_top" > - SiSU standard - </a> -</p> -<p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_provisional_patent_application_200408" target="_top" > - SiSU abandoned provisional patent - </a> -</p> -<p class="tiny"> Note: the placement of SiSU documents on the Net predate the release of SiSU. </p> </div> @@ -1990,7 +1903,7 @@ SiSU is a comprehensive future-proofing electronic document management system. Potential users of SiSU include individual authors who want to publish their books or articles electronically to reach a broad audience, web publishers who want to provide multiple channels of access to their electronic documents, or any organizations which centrally manage a medium or large set of electronic documents, especially governmental organizations which may prefer to keep their documents in easily accessible yet non-proprietary formats. </p> <p> -SiSU is an Open Source project initiated and led by Ralph Amissah (<a href="mailto:ralph.amissah@gmail.com">ralph.amissah@gmail.com</a>) and can be contacted via mailing list <a href="http://lists.sisudoc.org/listinfo/sisu">http://lists.sisudoc.org/listinfo/sisu</a> at <a href="mailto:sisu@lists.sisudoc.org">sisu@lists.sisudoc.org</a>. SiSU is licensed under the GNU General Public License. +SiSU is an Open Source project initiated and led by Ralph Amissah <a href="mailto:ralph.amissah@gmail.com"><ralph.amissah@gmail.com></a> and can be contacted via mailing list <a href="http://lists.sisudoc.org/listinfo/sisu"><http://lists.sisudoc.org/listinfo/sisu></a> at <a href="mailto:sisu@lists.sisudoc.org"><sisu@lists.sisudoc.org></a>. SiSU is licensed under the GNU General Public License. </p> <p class="bold"> For less markup than the most elementary HTML you can have more. @@ -2108,7 +2021,7 @@ as a developers tool it is flexible and extensible </p> <br /> <p class="small"> -More information on <a href="http://www.sisudoc.org/sisu/SiSU/"><b>SiSU</b></a> provided at <a href="http://www.sisudoc.org/sisu/SiSU/">www.sisudoc.org/sisu/SiSU</a></p> +<a href="http://www.sisudoc.org"><b>SiSU</b></a> at <a href="http://www.sisudoc.org"><www.sisudoc.org></a> or <a href="http://www.jus.uio.no/sisu/"><www.jus.uio.no/sisu/></a></p> </div> <div id="column_right"> <p class="tiny"> @@ -2121,7 +2034,7 @@ More information on <a href="http://www.sisudoc.org/sisu/SiSU/"><b>SiSU</b></a> <input type="hidden" name="a" value="1" /> <input type="radio" name="view" value="index" checked="checked" /> idx <input type="radio" name="view" value="text" /> txt -<a href="http://search.sisudoc.org" target="_top" >search.sisudoc.org</a> +<a href="http://search.sisudoc.org" target="_top" ><search.sisudoc.org></a> </form> <!-- Search SiSU --> </p> @@ -2145,7 +2058,7 @@ SiSU markup is fairly minimalistic, it consists of: a (largely optional) documen <p class="small"> More information on <a href="http://www.sisudoc.org/sisu/SiSU/"><b>SiSU</b></a> provided at: <a href="http://www.sisudoc.org/sisu/SiSU/"> - www.sisudoc.org/sisu/SiSU + <www.sisudoc.org/sisu/SiSU> </a> <p class="tiny"> SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...(humanities, law and part of the social sciences)). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time.</p> @@ -2153,22 +2066,22 @@ SiSU was developed in relation to legal documents, and is strong across a wide v SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored.</p> <p class="small"> <a href="mailto:ralph@amissah.com"> -ralph@amissah.com +<ralph@amissah.com> </a> </p> <p class="small"> <a href="mailto:ralph.amissah@gmail.com"> -ralph.amissah@gmail.com +<ralph.amissah@gmail.com> </a> </p> <p class="small"> <a href="mailto:sisu@lists.sisudoc.org"> -sisu@lists.sisudoc.org. +<sisu@lists.sisudoc.org> </a> </p> <p class="small"> <a href="http://lists.sisudoc.org/listinfo/sisu"> -http://lists.sisudoc.org/listinfo/sisu +<http://lists.sisudoc.org/listinfo/sisu> </a> </p> <p class="small"> diff --git a/lib/sisu/v3/manpage.rb b/lib/sisu/v3/manpage.rb index 3810a969..e4cb6906 100644 --- a/lib/sisu/v3/manpage.rb +++ b/lib/sisu/v3/manpage.rb @@ -138,7 +138,6 @@ module SiSU_Manpage if wrap =~ /^\s*[\d*+]+\s+.+?\s*\Z/m wrap.gsub!(/(^| |#{Mx[:nbsp]}|\s|\*)\\\*/,'\1\\\\\*') #man page requires wrap.gsub!(/\s\.(\S+)/,' \\.\1') - wrap.gsub!(/(["''])/,"\\\\\\1") # quotation marks need escape wrap.gsub!(/^\s*([\d*+]+)\s+(.+?)\s*\Z/m, <<GSUB .TP .BI \\1. @@ -300,9 +299,9 @@ WOK dob.obj.gsub!(/(?:#{Mx[:br_line]}|#{Mx[:br_nl]})+\s*/,"\n") # watch end dob.obj.gsub!(/(^| |#{Mx[:nbsp]}|\s|\*)\\\*/,'\1\\\\\*') #man page requires + dob.obj.gsub!(/┆/,'|') dob.obj.gsub!(/\s\.(\S+)/,' \\.\1') dob.obj.gsub!(/(\n\.)(\S\S\S+)/m,'\1\\.\2') - dob.obj.gsub!(/-/,'\-') #manpages use this dob.obj.gsub!(/~/,'~') if dob.obj #manpages use this if dob.is =~/block|group|verse|alt|code/ if dob.is =='code' diff --git a/man/man1/sisu-concordance.1 b/man/man1/sisu-concordance.1 index d21c7a02..cccb57f5 100644 --- a/man/man1/sisu-concordance.1 +++ b/man/man1/sisu-concordance.1 @@ -1,41 +1,41 @@ -.TH SISU\-CONCORDANCE 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-CONCORDANCE 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-concordance\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-concordance\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-concordance\fR command is an alias for \fBsisu \-\-concordance\fR (or \fBsisu \-w\fR) which produces an HTML concordance file (wordlist) of a SiSU markup file. +The \fBsisu-concordance\fR command is an alias for \fBsisu --concordance\fR (or \fBsisu -w\fR) which produces an HTML concordance file (wordlist) of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-epub.1 b/man/man1/sisu-epub.1 index 216ff352..ddc3e5f3 100644 --- a/man/man1/sisu-epub.1 +++ b/man/man1/sisu-epub.1 @@ -1,41 +1,41 @@ -.TH SISU\-EPUB 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-EPUB 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-epub\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-epub\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-epub\fR command is an alias for \fBsisu \-\-epub\fR (or \fBsisu \-e\fR) which produces EPUB output of a SiSU markup file. +The \fBsisu-epub\fR command is an alias for \fBsisu --epub\fR (or \fBsisu -e\fR) which produces EPUB output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-git.1 b/man/man1/sisu-git.1 index 21907f17..c0d8a229 100644 --- a/man/man1/sisu-git.1 +++ b/man/man1/sisu-git.1 @@ -1,39 +1,39 @@ -.TH SISU\-GIT 1 2010\-07\-27 2.6.0 SiSU +.TH SISU-GIT 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-git\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-git\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-git\fR command is an alias for \fBsisu \-\-git\fR (or \fBsisu \-g\fR) which produces a git repository of the sisu source document and associated parts (images, ). +The \fBsisu-git\fR command is an alias for \fBsisu --git\fR (or \fBsisu -g\fR) which produces a git repository of the sisu source document and associated parts (images, ). .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-harvest.1 b/man/man1/sisu-harvest.1 index 6a521cee..79b1116c 100644 --- a/man/man1/sisu-harvest.1 +++ b/man/man1/sisu-harvest.1 @@ -1,41 +1,41 @@ -.TH SISU\-HARVEST 1 2010\-07\-12 2.6.0 SiSU +.TH SISU-HARVEST 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-harvest\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-harvest\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-harvest\fR command is an alias for \fBsisu \-\-harvest\fR which based on the @classify: :topic_register: headers in each SiSU markup file, produces HTML output in the form of an index of authors and their texts and an index of topics and related texts. +The \fBsisu-harvest\fR command is an alias for \fBsisu --harvest\fR which based on the @classify: :topic_register: headers in each SiSU markup file, produces HTML output in the form of an index of authors and their texts and an index of topics and related texts. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-html.1 b/man/man1/sisu-html.1 index 9226016d..4b5e9888 100644 --- a/man/man1/sisu-html.1 +++ b/man/man1/sisu-html.1 @@ -1,41 +1,41 @@ -.TH SISU\-HTML 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-HTML 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-html\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-html\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-html\fR command is an alias for \fBsisu \-\-html\fR (or \fBsisu \-h\fR) which produces HTML output of a SiSU markup file. +The \fBsisu-html\fR command is an alias for \fBsisu --html\fR (or \fBsisu -h\fR) which produces HTML output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-odf.1 b/man/man1/sisu-odf.1 index 6573f7c8..8fe09344 100644 --- a/man/man1/sisu-odf.1 +++ b/man/man1/sisu-odf.1 @@ -1,41 +1,41 @@ -.TH SISU\-ODF 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-ODF 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-odf\fR command is an alias for \fBsisu \-\-odt\fR (or \fBsisu \-o\fR) which produces OpenDocument output of a SiSU markup file. +The \fBsisu-odf\fR command is an alias for \fBsisu --odt\fR (or \fBsisu -o\fR) which produces OpenDocument output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pdf.1 b/man/man1/sisu-pdf.1 index 65309edb..28e9dff1 100644 --- a/man/man1/sisu-pdf.1 +++ b/man/man1/sisu-pdf.1 @@ -1,41 +1,41 @@ -.TH SISU\-PDF 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-PDF 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-pdf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-pdf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-pdf\fR command is an alias for \fBsisu \-\-pdf\fR (or \fBsisu \-p\fR) which produces PDF output of a SiSU markup file. +The \fBsisu-pdf\fR command is an alias for \fBsisu --pdf\fR (or \fBsisu -p\fR) which produces PDF output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pg.1 b/man/man1/sisu-pg.1 index 4df0d792..55bac1b4 100644 --- a/man/man1/sisu-pg.1 +++ b/man/man1/sisu-pg.1 @@ -1,41 +1,41 @@ -.TH SISU\-PG 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-PG 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-pq\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-pq\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-pq\fR command is an alias for \fBsisu \-\-pg\fR (or \fBsisu \-D\fR) which populates a PostgreSQL database with SiSU content (for search) from a SiSU markup file. +The \fBsisu-pq\fR command is an alias for \fBsisu --pg\fR (or \fBsisu -D\fR) which populates a PostgreSQL database with SiSU content (for search) from a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-po.1 b/man/man1/sisu-po.1 index dc0460bf..e8da6c16 100644 --- a/man/man1/sisu-po.1 +++ b/man/man1/sisu-po.1 @@ -1,42 +1,42 @@ -.TH SISU\-ODF 1 2011\-02\-07 3.0.0 SiSU +.TH SISU-PO 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-po\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-po\fR command is an alias for \fBsisu \-\-po4a\fR (or \fBsisu \-o\fR) which provided two sisu markup files of the same document in different languages produces .pot and .po output of a SiSU markup file. Experimental, and under development. +The \fBsisu-po\fR command is an alias for \fBsisu --po4a\fR (or \fBsisu -o\fR) which provided two sisu markup files of the same document in different languages produces .pot and .po output of a SiSU markup file. Experimental, and under development. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-sqlite.1 b/man/man1/sisu-sqlite.1 index 2916cd8a..91041900 100644 --- a/man/man1/sisu-sqlite.1 +++ b/man/man1/sisu-sqlite.1 @@ -1,41 +1,41 @@ -.TH SISU\-SQLITE 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-SQLITE 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-sqlite\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-sqlite\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-sqlite\fR command is an alias for \fBsisu \-\-sqlite\fR (or \fBsisu \-d\fR) which populates a SQLite database with SiSU content (for search) from a SiSU markup file. +The \fBsisu-sqlite\fR command is an alias for \fBsisu --sqlite\fR (or \fBsisu -d\fR) which populates a SQLite database with SiSU content (for search) from a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-txt.1 b/man/man1/sisu-txt.1 index 79c36daf..e606123a 100644 --- a/man/man1/sisu-txt.1 +++ b/man/man1/sisu-txt.1 @@ -1,41 +1,41 @@ -.TH SISU\-TXT 1 2010\-07\-07 2.6.0 SiSU +.TH SISU-TXT 1 "2011-03-05" "2.8.1" "SiSU" .SH NAME -\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system +\fBSiSU\fR - Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -\fBsisu\-txt\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR +\fBsisu-txt\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR .SH DESCRIPTION \fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. .PP -The \fBsisu\-txt\fR command is an alias for \fBsisu \-\-txt\fR (or \fBsisu \-t\fR) which produces plain text output of a SiSU markup file. +The \fBsisu-txt\fR command is an alias for \fBsisu --txt\fR (or \fBsisu -t\fR) which produces plain text output of a SiSU markup file. .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-concordance\fR(1), +\fIsisu-concordance\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-git\fR(1), +\fIsisu-git\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-po\fR(1), +\fIsisu-po\fR(1), .br -\fIsisu\-sqlite\fR(1). +\fIsisu-sqlite\fR(1). .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 3dd8f71a..e90d76c0 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,22 +1,25 @@ -.TH "sisu" "1" "2010-09-17" "2.6.3" "SiSU" +.TH "sisu" "1" "2011-03-05" "2.8.1" "SiSU" .SH NAME -sisu \- documents: markup, structuring, publishing in multiple standard formats, and search +sisu - documents: markup, structuring, publishing in multiple standard formats, and search .SH SYNOPSIS -sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard] +sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] .BR -sisu [\-Ddcv] [instruction] [filename/wildcard] +sisu [-Ddcv] [instruction] [filename/wildcard] .BR -sisu [\-CcFLSVvW] +sisu [-CcFLSVvW] .BR -sisu \-\-v2 [operations] +sisu --v2 [operations] .BR -sisu \-\-v1 [operations] +sisu --v3 [operations] + +.BR +sisu3 [operations] .SH -SISU \- MANUAL, +SISU - MANUAL, RALPH AMISSAH .BR @@ -25,7 +28,7 @@ WHAT IS SISU? .BR .SH -1. INTRODUCTION \- WHAT IS SISU? +1. INTRODUCTION - WHAT IS SISU? .BR .BR @@ -45,7 +48,7 @@ case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output formats. Various output formats (including search related -output) share a common mechanism for cross\-output\-format citation. +output) share a common mechanism for cross-output-format citation. .BR .B SiSU @@ -71,21 +74,20 @@ Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be -generated by re\-running the engine against the prepared source. Using +generated by re-running the engine against the prepared source. Using .B SiSU markup applied to a document, .B SiSU custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an -SQL database with objects[^1] (equating generally to paragraph\-sized chunks) -so searches may be performed and matches returned with that degree of -granularity ( e.g. your search criteria is met by these documents and at these -locations within each document). Document output formats share a common object -numbering system for locating content. This is particularly suitable for -"published" works (finalized texts as opposed to works that are frequently -changed or updated) for which it provides a fixed means of reference of -content. +SQL database with objects[^1] (equating generally to paragraph-sized chunks) so +searches may be performed and matches returned with that degree of granularity +( e.g. your search criteria is met by these documents and at these locations +within each document). Document output formats share a common object numbering +system for locating content. This is particularly suitable for "published" +works (finalized texts as opposed to works that are frequently changed or +updated) for which it provides a fixed means of reference of content. .BR In preparing a @@ -123,7 +125,7 @@ have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. .B SiSU -provides the flexibility of producing documents in multiple non\-proprietary +provides the flexibility of producing documents in multiple non-proprietary open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst .B SiSU relies on software, the markup is uncomplicated and minimalistic which @@ -148,7 +150,7 @@ which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). .BR -The document formats are written to the file\-system and available for indexing +The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. @@ -174,6 +176,9 @@ content prepared in . .BR +<http://www.sisudoc.org/> + +.BR <http://www.jus.uio.no/sisu> .SH @@ -186,7 +191,7 @@ content prepared in .BR .B SiSU .B SiSU -is a document publishing system, that from a simple single marked\-up +is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and @@ -197,104 +202,104 @@ the same document structure information. For more see: 2.2 DOCUMENT PROCESSING COMMAND FLAGS .TP -.B \-a [filename/wildcard] +.B -a [filename/wildcard] produces plaintext with Unix linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them [ \ \-A -\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for -footnotes at the end of each paragraph \-\-unix for unix linefeed (default) -\-\-msdos for msdos linefeed) +are omitted), has footnotes at end of each paragraph that contains them [ \ -A +\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ -e \ for \ +endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes +at the end of each paragraph --unix for unix linefeed (default) --msdos for +msdos linefeed) .TP -.B \-b [filename/wildcard] -see \-\-xhtml +.B -b [filename/wildcard] +see --xhtml .TP -.B \-\-color\-toggle [filename/wildcard] +.B --color-toggle [filename/wildcard] screen toggle ansi screen colour on or off depending on default set (unless -\-c flag is used: if sisurc colour default is set to 'true', output to screen +-c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined -screen output will be without colour). Alias \-c +screen output will be without colour). Alias -c .TP -.B \-\-concordance [filename/wildcard] +.B --concordance [filename/wildcard] produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 -words unless this limit is increased in the file sisurc.yml). Alias \-w +words unless this limit is increased in the file sisurc.yml). Alias -w .TP -.B \-C [\-\-init\-site] +.B -C [--init-site] configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). \-C \-\-init\-site configure/initialise -site more extensive than \-C on its own, shared output directory files/force +already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. .TP -.B \-CC +.B -CC configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). The equivalent of: \-C \-\-init\-site -configure/initialise site, more extensive than \-C on its own, shared output +already exist unless modifier is used). The equivalent of: -C --init-site +configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css -and dtd files are updated if \-CC is used. +and dtd files are updated if -CC is used. .TP -.B \-c [filename/wildcard] -see \-\-color\-toggle +.B -c [filename/wildcard] +see --color-toggle .TP -.B \-\-dal [filename/wildcard/url] +.B --dal [filename/wildcard/url] assumed for most other flags, creates new intermediate files for processing (document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see \-n. -Alias \-m +output. This step is assumed for most processing flags. To skip it see -n. +Alias -m .TP -.B \-\-delete [filename/wildcard] -see \-\-zap +.B --delete [filename/wildcard] +see --zap .TP -.B \-D [instruction] [filename] -see \-\-pg +.B -D [instruction] [filename] +see --pg .TP -.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] -see \-\-sqlite +.B -d [--db-[database \ type \ (sqlite|pg)]] --[instruction] [filename] +see --sqlite .TP -.B \-\-epub [filename/wildcard] +.B --epub [filename/wildcard] produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias -\-e +-e .TP -.B \-e [filename/wildcard] -see \-\-epub +.B -e [filename/wildcard] +see --epub .TP -.B \-F [\-\-webserv=webrick] -see \-\-sample\-search\-form +.B -F [--webserv=webrick] +see --sample-search-form .TP -.B \-\-git [filename/wildcard] +.B --git [filename/wildcard] produces or updates markup source file structure in a git repo (experimental -and subject to change). Alias \-g +and subject to change). Alias -g .TP -.B \-g [filename/wildcard] -see \-\-git +.B -g [filename/wildcard] +see --git .TP -.B \-\-harvest *.ss[tm] +.B --harvest *.ss[tm] makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, -title, date, topic_register). Can be used with maintenance (\-M) and remote -placement (\-R) flags. +title, date, topic_register). Can be used with maintenance (-M) and remote +placement (-R) flags. .TP -.B \-\-help [topic] +.B --help [topic] provides help on the selected topic, where topics (keywords) include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, tables, example, customise, skin, (dir)ectories, path, @@ -302,160 +307,175 @@ headings, endnotes, tables, example, customise, skin, (dir)ectories, path, features, license .TP -.B \-\-html [filename/wildcard] +.B --html [filename/wildcard] produces html output, segmented text with table of contents (toc.html and -index.html) and the document in a single file (scroll.html). Alias \-h +index.html) and the document in a single file (scroll.html). Alias -h .TP -.B \-h [filename/wildcard] -see \-\-html +.B -h [filename/wildcard] +see --html .TP -.B \-I [filename/wildcard] -see \-\-texinfo +.B -I [filename/wildcard] +see --texinfo .TP -.B \-i [filename/wildcard] -see \-\-manpage +.B -i [filename/wildcard] +see --manpage .TP -.B \-L +.B -L prints license information. .TP -.B \-\-machine [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) +.B --machine [filename/wildcard/url] +see --dal (document abstraction level/layer) .TP -.B \-\-maintenance [filename/wildcard/url] +.B --maintenance [filename/wildcard/url] maintenance mode files created for processing preserved and their locations -indicated. (also see \-V). Alias \-M +indicated. (also see -V). Alias -M .TP -.B \-\-manpage [filename/wildcard] -produces man page of file, not suitable for all outputs. Alias \-i +.B --manpage [filename/wildcard] +produces man page of file, not suitable for all outputs. Alias -i .TP -.B \-M [filename/wildcard/url] -see \-\-maintenance +.B -M [filename/wildcard/url] +see --maintenance .TP -.B \-m [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) +.B -m [filename/wildcard/url] +see --dal (document abstraction level/layer) .TP -.B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html or -LaTeX/pdf output. +.B --no-ocn +[with \ --html \ --pdf \ or \ --epub] switches off object citation numbering. +Produce output without identifying numbers in margins of html or LaTeX/pdf +output. .TP -.B \-N [filename/wildcard/url] +.B -N [filename/wildcard/url] document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions -that produced it) (digest.txt). \-NV for verbose digest output to screen. +that produced it) (digest.txt). -NV for verbose digest output to screen. .TP -.B \-n [filename/wildcard/url] +.B -n [filename/wildcard/url] skip the creation of intermediate processing files (document abstraction) if -they already exist, this skips the equivalent of \-m which is otherwise assumed +they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags. .TP -.B \-\-odf [filename/wildcard/url] -see \-\-odt +.B --odf [filename/wildcard/url] +see --odt .TP -.B \-\-odt [filename/wildcard/url] +.B --odt [filename/wildcard/url] output basic document in opendocument file format (opendocument.odt). Alias -\-o +-o .TP -.B \-o [filename/wildcard/url] -see \-\-odt +.B -o [filename/wildcard/url] +see --odt .TP -.B \-\-pdf [filename/wildcard] +.B --pdf [filename/wildcard] produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line -parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and -'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p +parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and +'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias -p + +.TP +.B --pg [instruction] [filename] +database postgresql ( --pgsql may be used instead) possible instructions, +include: --createdb; --create; --dropall; --import [filename]; --update +[filename]; --remove [filename]; see database section below. Alias -D + +.TP +.B --po [language_directory/filename \ language_directory] +see --po4a .TP -.B \-\-pg [instruction] [filename] -database postgresql ( \-\-pgsql may be used instead) possible instructions, -include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; -\-\-update [filename]; \-\-remove [filename]; see database section below. Alias -\-D +.B --po4a [language_directory/filename \ language_directory] +produces \.pot and po files for the file in the languages specified by the +language directory. +.B SiSU +markup is placed in subdirectories named with the language code, e.g. en/ fr/ +es/. The sisu config file must set the output directory structure to +multilingual. v3, experimental + +.TP +.B -P [language_directory/filename \ language_directory] +see --po4a .TP -.B \-p [filename/wildcard] -see \-\-pdf +.B -p [filename/wildcard] +see --pdf .TP -.B \-\-quiet [filename/wildcard] +.B --quiet [filename/wildcard] quiet less output to screen. .TP -.B \-q [filename/wildcard] -see \-\-quiet +.B -q [filename/wildcard] +see --quiet .TP -.B \-\-rsync [filename/wildcard] +.B --rsync [filename/wildcard] copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync -different if \-R is used with other flags from if used alone. Alone the rsync -\-\-delete parameter is sent, useful for cleaning the remote directory (when -\-R is used together with other flags, it is not). Also see \-\-scp. Alias \-R +different if -R is used with other flags from if used alone. Alone the rsync +--delete parameter is sent, useful for cleaning the remote directory (when -R +is used together with other flags, it is not). Also see --scp. Alias -R .TP -.B \-R [filename/wildcard] -see \-\-rsync +.B -R [filename/wildcard] +see --rsync .TP -.B \-r [filename/wildcard] -see \-\-scp +.B -r [filename/wildcard] +see --scp .TP -.B \-\-sample\-search\-form [\-\-webserv=webrick] +.B --sample-search-form [--webserv=webrick] generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -\-d \-D and the database section below. If the optional parameter -\-\-webserv=webrick is passed, the cgi examples created will be set up to use -the default port set for use by the webrick server, (otherwise the port is left +-d -D and the database section below. If the optional parameter +--webserv=webrick is passed, the cgi examples created will be set up to use the +default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given -that they be copied to the cgi\-bin directory). \-Fv (in addition to the above) -provides some information on setting up hyperestraier for sisu. Alias \-F +that they be copied to the cgi-bin directory). -Fv (in addition to the above) +provides some information on setting up hyperestraier for sisu. Alias -F .TP -.B \-\-scp [filename/wildcard] +.B --scp [filename/wildcard] copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r +that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r .TP -.B \-\-sqlite \-\-[instruction] [filename] -database type default set to sqlite, (for which \-\-sqlite may be used -instead) or to specify another database \-\-db\-[pgsql, \ sqlite] (however see -\-D) possible instructions include: \-\-createdb; \-\-create; \-\-dropall; -\-\-import [filename]; \-\-update [filename]; \-\-remove [filename]; see -database section below. Alias \-d +.B --sqlite --[instruction] [filename] +database type default set to sqlite, (for which --sqlite may be used instead) +or to specify another database --db-[pgsql, \ sqlite] (however see -D) possible +instructions include: --createdb; --create; --dropall; --import [filename]; +--update [filename]; --remove [filename]; see database section below. Alias -d .TP -.B \-\-sisupod +.B --sisupod produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in - \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this -option is tested only with zsh). Alias \-S + \./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option +is tested only with zsh). Alias -S .TP -.B \-\-sisupod [filename/wildcard] +.B --sisupod [filename/wildcard] produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension \.ssp This provides a quick way of gathering the @@ -467,192 +487,191 @@ images and skin. commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag -\-\-trust or \-\-trusted is added to the command instruction, it is recommended +--trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the -individual files for sending). See the \-S option without [filename/wildcard]. -Alias \-S +individual files for sending). See the -S option without [filename/wildcard]. +Alias -S .TP -.B \-\-source [filename/wildcard] -copies sisu markup file to output directory. Alias \-s +.B --source [filename/wildcard] +copies sisu markup file to output directory. Alias -s .TP -.B \-S -see \-\-sisupod +.B -S +see --sisupod .TP -.B \-S [filename/wildcard] -see \-\-sisupod +.B -S [filename/wildcard] +see --sisupod .TP -.B \-s [filename/wildcard] -see \-\-source +.B -s [filename/wildcard] +see --source .TP -.B \-\-texinfo [filename/wildcard] -produces texinfo and info file, (view with pinfo). Alias \-I +.B --texinfo [filename/wildcard] +produces texinfo and info file, (view with pinfo). Alias -I .TP -.B \-\-txt [filename/wildcard] +.B --txt [filename/wildcard] produces plaintext with Unix linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them [ \ \-A -\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for -footnotes at the end of each paragraph \-\-unix for unix linefeed (default) -\-\-msdos for msdos linefeed). Alias \-t +are omitted), has footnotes at end of each paragraph that contains them [ \ -A +\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ -e \ for \ +endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes +at the end of each paragraph --unix for unix linefeed (default) --msdos for +msdos linefeed). Alias -t .TP -.B \-T [filename/wildcard \ (*.termsheet.rb)] +.B -T [filename/wildcard \ (*.termsheet.rb)] standard form document builder, preprocessing feature .TP -.B \-t [filename/wildcard] -see \-\-txt +.B -t [filename/wildcard] +see --txt .TP -.B \-\-urls [filename/wildcard] +.B --urls [filename/wildcard] prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the -output that would be produced), \-u provides url output mapping for those flags +output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to -file system paths in sisurc.yml. Alias \-U +file system paths in sisurc.yml. Alias -U .TP -.B \-U [filename/wildcard] -see \-\-urls +.B -U [filename/wildcard] +see --urls .TP -.B \-u [filename/wildcard] +.B -u [filename/wildcard] provides url mapping of output files for the flags requested for processing, -also see \-U - -.TP -.B \-\-v1 [filename/wildcard] -invokes the sisu v1 document parser/generator. For use with sisu v1 markup -documents. (Markup conversion to v2 involves the modification of document -headers) +also see -U .TP -.B \-\-v2 [filename/wildcard] +.B --v2 [filename/wildcard] invokes the sisu v2 document parser/generator. This is the default and is normally omitted. .TP -.B \-\-verbose [filename/wildcard] +.B --v3 [filename/wildcard] +invokes the sisu v3 document parser/generator. Currently under development +and incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. + +.TP +.B --verbose [filename/wildcard] provides verbose output of what is being generated, where output is placed -(and error messages if any), as with \-u flag provides a url mapping of files -created for each of the processing flag requests. Alias \-v +(and error messages if any), as with -u flag provides a url mapping of files +created for each of the processing flag requests. Alias -v .TP -.B \-V +.B -V on its own, provides .B SiSU -version and environment information (sisu \-\-help env) +version and environment information (sisu --help env) .TP -.B \-V [filename/wildcard] -even more verbose than the \-v flag. +.B -V [filename/wildcard] +even more verbose than the -v flag. .TP -.B \-v +.B -v on its own, provides .B SiSU version information .TP -.B \-v [filename/wildcard] -see \-\-verbose +.B -v [filename/wildcard] +see --verbose .TP -.B \-\-webrick +.B --webrick starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html -\ output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \ -\-H \ ; \ also, \ note \ \-F \ webrick \ ]. Alias \-W +\ output \ should \ be \ created \ using \ the \ -h \ option \ rather \ than \ +-H \ ; \ also, \ note \ -F \ webrick \ ]. Alias -W .TP -.B \-W -see \-\-webrick +.B -W +see --webrick .TP -.B \-\-wordmap [filename/wildcard] -see \-\-concordance +.B --wordmap [filename/wildcard] +see --concordance .TP -.B \-w [filename/wildcard] -see \-\-concordance +.B -w [filename/wildcard] +see --concordance .TP -.B \-\-xhtml [filename/wildcard] -produces xhtml/XML output for browser viewing (sax parsing). Alias \-b +.B --xhtml [filename/wildcard] +produces xhtml/XML output for browser viewing (sax parsing). Alias -b .TP -.B \-\-xml\-dom [filename/wildcard] +.B --xml-dom [filename/wildcard] produces XML output with deep document structure, in the nature of dom. Alias -\-X +-X .TP -.B \-\-xml\-sax [filename/wildcard] -produces XML output shallow structure (sax parsing). Alias \-x +.B --xml-sax [filename/wildcard] +produces XML output shallow structure (sax parsing). Alias -x .TP -.B \-X [filename/wildcard] -see \-\-xml\-dom +.B -X [filename/wildcard] +see --xml-dom .TP -.B \-x [filename/wildcard] -see \-\-xml\-sax +.B -x [filename/wildcard] +see --xml-sax .TP -.B \-Y [filename/wildcard] +.B -Y [filename/wildcard] produces a short sitemap entry for the document, based on html output and the -sisu_manifest. \-\-sitemaps generates/updates the sitemap index of existing +sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m \ announcement \ this \ week]) .TP -.B \-y [filename/wildcard] +.B -y [filename/wildcard] produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. .TP -.B \-\-zap [filename/wildcard] +.B --zap [filename/wildcard] Zap, if used with other processing flags deletes output files of the type -about to be processed, prior to processing. If \-Z is used as the lone -processing related flag (or in conjunction with a combination of \-[mMvVq]), -will remove the related document output directory. Alias \-Z +about to be processed, prior to processing. If -Z is used as the lone +processing related flag (or in conjunction with a combination of -[mMvVq]), +will remove the related document output directory. Alias -Z .TP -.B \-Z [filename/wildcard] -see \-\-zap +.B -Z [filename/wildcard] +see --zap .SH 3. COMMAND LINE MODIFIERS .BR .TP -.B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html or -LaTeX/pdf output. +.B --no-ocn +[with \ --html \ --pdf \ or \ --epub] switches off object citation numbering. +Produce output without identifying numbers in margins of html or LaTeX/pdf +output. .TP -.B \-\-no\-annotate +.B --no-annotate strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus sign .TP -.B \-\-no\-asterisk +.B --no-asterisk strips output text of editor endnotes[^*2] denoted by asterisk sign .TP -.B \-\-no\-dagger +.B --no-dagger strips output text of editor endnotes[^+1] denoted by dagger/plus sign .SH @@ -660,101 +679,101 @@ strips output text of editor endnotes[^+1] denoted by dagger/plus sign .BR .BR -dbi \- database interface +dbi - database interface .BR -\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite -\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] +-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is +modifiable with --db=[database \ type \ (pgsql \ or \ sqlite)] .TP -.B \-\-pg \-v \-\-createall +.B --pg -v --createall initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same -name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \ -sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb -initially NOTE: at the present time for postgresql it may be necessary to -manually create the database. The command would be 'createdb [database \ name]' -where database name would be SiSU_[present \ working \ directory \ name \ -(without \ path)]. Please use only alphanumerics and underscores. +name as working directory, as requested) (rb.dbi) [ \ -dv \ --createall \ +sqlite \ equivalent] it may be necessary to run sisu -Dv --createdb initially +NOTE: at the present time for postgresql it may be necessary to manually create +the database. The command would be 'createdb [database \ name]' where database +name would be SiSU_[present \ working \ directory \ name \ (without \ path)]. +Please use only alphanumerics and underscores. .TP -.B \-\-pg \-v \-\-import -[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv -\ \-\-import \ sqlite \ equivalent] +.B --pg -v --import +[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ -dv +\ --import \ sqlite \ equivalent] .TP -.B \-\-pg \-v \-\-update +.B --pg -v --update [filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) -[ \ \-dv \ \-\-update \ sqlite \ equivalent] +[ \ -dv \ --update \ sqlite \ equivalent] .TP -.B \-\-pg \-\-remove -[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d -\ \-\-remove \ sqlite \ equivalent] +.B --pg --remove +[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ -d \ +--remove \ sqlite \ equivalent] .TP -.B \-\-pg \-\-dropall -kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ -\-\-dropall \ sqlite \ equivalent] +.B --pg --dropall +kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ -d \ +--dropall \ sqlite \ equivalent] .BR -The \-v is for verbose output. +The -v is for verbose output. .SH 5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS .BR .TP -.B \-\-update [filename/wildcard] +.B --update [filename/wildcard] Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous -runs, only the \-hp files will be applied, and only these will be generated -this time, together with the summary. This can be very convenient, if you offer +runs, only the -hp files will be applied, and only these will be generated this +time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. .TP -.B \-0 to \-5 [filename \ or \ wildcard] +.B -0 to -5 [filename \ or \ wildcard] Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): .TP -.B \-0 -\-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ +.B -0 +-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]'] .TP -.B \-1 -\-mhewpy +.B -1 +-mhewpy .TP -.B \-2 -\-mhewpaoy +.B -2 +-mhewpaoy .TP -.B \-3 -\-mhewpAobxXyY +.B -3 +-mhewpAobxXyY .TP -.B \-4 -\-mhewpAobxXDyY \-\-import +.B -4 +-mhewpAobxXDyY --import .TP -.B \-5 -\-mhewpAobxXDyY \-\-update +.B -5 +-mhewpAobxXDyY --update .BR -add \-v for verbose mode and \-c for color, e.g. sisu \-2vc [filename \ or \ +add -v for verbose mode and -c for color, e.g. sisu -2vc [filename \ or \ wildcard] .BR -consider \-u for appended url info or \-v for verbose output +consider -u for appended url info or -v for verbose output .SH -5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING +5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING .BR -In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h -cisg.sst" or "sisu \-h *.{sst,ssm}" to produce html version of all documents. +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. .BR Running sisu (alone without any flags, filenames or wildcards) brings up the @@ -781,10 +800,10 @@ The manual can be generated from source, found respectively, either within the tarball or installed locally at: .BR - ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ + ./data/doc/sisu/markup-samples/sisu_manual .BR - /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/ + /usr/share/doc/sisu/markup-samples/sisu_manual .BR move to the respective directory and type e.g.: @@ -818,22 +837,22 @@ the sisu manual, the sources files for which are located within the tarball at: .BR - ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ + ./data/doc/sisu/markup-samples/sisu_manual .BR Once installed, directory equivalent to: .BR - /usr/share/doc/sisu/sisu_manual/ + /usr/share/doc/sisu/markup-samples/sisu_manual .BR Available man pages are converted back to html using man2html: .BR - /usr/share/doc/sisu/v2/html/ + /usr/share/doc/sisu/html/ .BR - ./data/doc/sisu/v2/html/ + ./data/doc/sisu/html .BR An online version of the sisu man page is available here: @@ -845,38 +864,38 @@ An online version of the sisu man page is available here: * sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^9] .SH -6.3 SISU BUILT\-IN INTERACTIVE HELP +6.3 SISU BUILT-IN INTERACTIVE HELP .BR This is particularly useful for getting the current sisu setup/environment information: .BR - sisu \-\-help + sisu --help .BR - sisu \-\-help [subject] + sisu --help [subject] .BR - sisu \-\-help commands + sisu --help commands .BR - sisu \-\-help markup + sisu --help markup .BR - sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \ + sisu --help env [for \ feedback \ on \ the \ way \ your \ system \ is \ setup \ with \ regard \ to \ sisu] .BR - sisu \-V [environment \ information, \ same \ as \ above \ command] + sisu -V [environment \ information, \ same \ as \ above \ command] .BR sisu (on its own provides version and some help information) .BR -Apart from real\-time information on your current configuration the +Apart from real-time information on your current configuration the .B SiSU -manual and man pages are likely to contain more up\-to\-date information than +manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). .BR @@ -914,7 +933,7 @@ For lists of alternative help sources, see: .BR .B SiSU -source documents are plaintext (UTF\-8)[^11] files +source documents are plaintext (UTF-8)[^11] files .BR All paragraphs are separated by an empty line. @@ -923,7 +942,7 @@ All paragraphs are separated by an empty line. Markup is comprised of: .BR -* at the top of a document, the document header made up of semantic meta\-data +* at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) @@ -949,29 +968,29 @@ primary outline of the document structure. Markup of substantive text includes: * linked text and images .BR - * paragraph actions, such as indent, bulleted, numbered\-lists, etc. + * paragraph actions, such as indent, bulleted, numbered-lists, etc. .BR Some interactive help on markup is available, by typing sisu and selecting -markup or sisu \-\-help markup +markup or sisu --help markup .BR To check the markup in a file: .BR - sisu \-\-identify [filename].sst + sisu --identify [filename].sst .BR For brief descriptive summary of markup history .BR - sisu \-\-query\-history + sisu --query-history .BR or if for a particular version: .BR - sisu \-\-query\-0.38 + sisu --query-0.38 .SH 7.2 MARKUP EXAMPLES @@ -1005,15 +1024,15 @@ With .B SiSU installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if -sisu\-markup\-samples is installed also under: -/usr/share/doc/sisu/sisu_markup_samples/non\-free +sisu-markup-samples is installed also under: +/usr/share/doc/sisu/sisu_markup_samples/non-free .SH 8. MARKUP OF HEADERS .BR .BR -Headers contain either: semantic meta\-data about a document, which can be used +Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions. .BR @@ -1048,27 +1067,27 @@ to this one: electronic document, electronic citation, data structure, citation systems, search % used_by: manual - @date: :published: 2008\-05\-22 - :created: 2002\-08\-28 - :issued: 2002\-08\-28 - :available: 2002\-08\-28 - :modified: 2010\-03\-03 + @date: :published: 2008-05-22 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2010-03-03 @make: :num_top: 1 :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu \- documents: markup, structuring, publishing + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; - synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ] - . sisu \ [\-Ddcv] \ [instruction] - . sisu \ [\-CcFLSVvW] - . sisu \-\-v2 \ [operations] - . sisu \-\-v1 \ [operations] + synopsis=sisu \ [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] \ [filename/wildcard \ ] + . sisu \ [-Ddcv] \ [instruction] + . sisu \ [-CcFLSVvW] + . sisu --v2 \ [operations] + . sisu --v1 \ [operations] @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html @@ -1082,8 +1101,9 @@ to this one: .BR Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the -document as a whole is to be processed. All header instructions take either the -form @headername: or 0~headername. All Dublin Core meta tags are available +document as a whole is to be processed. All header instructions take the form +@headername: or on the next line and indented by once space :subheadername: All +Dublin Core meta tags are available .BR .B @indentifier: @@ -1103,7 +1123,7 @@ This is a sample header .nf - % SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version] + % SiSU 2.0 \ [declared \ file-type \ identifier \ with \ markup \ version] .fi .nf @@ -1120,14 +1140,14 @@ This is a sample header .fi .nf - @date: :published: \ [year \ or \ yyyy\-mm\-dd] - :created: \ [year \ or \ yyyy\-mm\-dd] - :issued: \ [year \ or \ yyyy\-mm\-dd] - :available: \ [year \ or \ yyyy\-mm\-dd] - :modified: \ [year \ or \ yyyy\-mm\-dd] - :valid: \ [year \ or \ yyyy\-mm\-dd] - :added_to_site: \ [year \ or \ yyyy\-mm\-dd] - :translated: \ [year \ or \ yyyy\-mm\-dd] + @date: :published: \ [year \ or \ yyyy-mm-dd] + :created: \ [year \ or \ yyyy-mm-dd] + :issued: \ [year \ or \ yyyy-mm-dd] + :available: \ [year \ or \ yyyy-mm-dd] + :modified: \ [year \ or \ yyyy-mm-dd] + :valid: \ [year \ or \ yyyy-mm-dd] + :added_to_site: \ [year \ or \ yyyy-mm-dd] + :translated: \ [year \ or \ yyyy-mm-dd] .fi .nf @@ -1153,7 +1173,7 @@ This is a sample header .fi .nf - @links: { SiSU }http://www.jus.uio.no/sisu/ + @links: { SiSU }http://www.sisudoc.org { FSF }http://www.fsf.org .fi @@ -1188,11 +1208,10 @@ This is a sample header 9.1 HEADING LEVELS .BR -Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section -headings, followed by other heading levels, and 1 \-6 being headings followed -by substantive text or sub\-headings. :A~ usually the title :A~? conditional -level 1 heading (used where a stand\-alone document may be imported into -another) +Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A - :C being part / section +headings, followed by other heading levels, and 1 -6 being headings followed by +substantive text or sub-headings. :A~ usually the title :A~? conditional level +1 heading (used where a stand-alone document may be imported into another) .BR .B :A~ [heading \ text] @@ -1210,7 +1229,7 @@ Third level heading [this \ is \ a \ heading \ level \ divider] .BR .B 1~ [heading \ text] -Top level heading preceding substantive text of document or sub\-heading 2, +Top level heading preceding substantive text of document or sub-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), @@ -1218,9 +1237,9 @@ otherwise takes the form 1~my_filename_for_this_segment .BR .B 2~ [heading \ text] -Second level heading preceding substantive text of document or sub\-heading -3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 -etc. in a document. +Second level heading preceding substantive text of document or sub-heading 3 +, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. +in a document. .BR .B 3~ [heading \ text] @@ -1244,13 +1263,12 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .nf normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\- #{monospace}# -.BR + ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text .BR - !{emphasis}! + *{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] .BR - *{bold text}* + !{bold text}! .BR _{underscore}_ .BR @@ -1273,12 +1291,16 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .B resulting output: .BR -normal text +normal text, .B emphasis +, .B bold text -.I underscore +, .I italics -"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- monospace +, +.I underscore +, "citation", ^superscript^, [subscript], ++inserted text++, +--strikethrough--, monospace .BR normal text @@ -1310,7 +1332,7 @@ normal text ++inserted text++ .BR -\-\-strikethrough\-\- +--strikethrough-- .BR monospace @@ -1388,9 +1410,9 @@ Numbered List (not to be confused with headings/titles, (document structure)) 9.4 FOOTNOTES / ENDNOTES .BR -Footnotes and endnotes not distinguished in markup. They are automatically -numbered. Depending on the output file format (html, EPUB, odf, pdf etc.), the -document output selected will have either footnotes or endnotes. +Footnotes and endnotes are marked up at the location where they would be +indicated within a text. They are automatically numbered. The output type +determines whether footnotes or endnotes will be produced .BR .B markup example: @@ -1463,8 +1485,7 @@ normal text [^+2] continues .nf - % note the endnote marker \"~^\" -.BR + % note the endnote marker "~^" normal text~^ continues .BR ^~ endnote text following the paragraph in which the marker occurs @@ -1491,14 +1512,14 @@ decoration is omitted). .nf - normal text http://www.jus.uio.no/sisu continues + normal text http://www.sisudoc.org/ continues .fi .BR .B resulting output: .BR -normal text <http://www.jus.uio.no/sisu> continues +normal text <http://www.sisudoc.org/> continues .BR An escaped url without decoration @@ -1508,18 +1529,18 @@ An escaped url without decoration .nf - normal text _http://www.jus.uio.no/sisu continues - deb http://www.jus.uio.no/sisu/archive unstable main non\-free + normal text _http://www.sisudoc.org/ continues + deb http://www.jus.uio.no/sisu/archive unstable main non-free .fi .BR .B resulting output: .BR -normal text <_http://www.jus.uio.no/sisu> continues +normal text <_http://www.sisudoc.org/> continues .BR -deb <_http://www.jus.uio.no/sisu/archive> unstable main non\-free +deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free .BR where a code block is used there is neither decoration nor hyperlinking, code @@ -1530,11 +1551,14 @@ blocks are discussed later in this document .nf - deb http://www.jus.uio.no/sisu/archive unstable main non\-free + deb http://www.jus.uio.no/sisu/archive unstable main non-free .BR - deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free .fi +.SH +9.5.2 LINKING TEXT + .BR To link text or an image to a url the markup is as follows @@ -1546,14 +1570,11 @@ To link text or an image to a url the markup is as follows about { SiSU }http://url.org markup .fi -.SH -9.5.2 LINKING TEXT - .BR .B resulting output: .BR -about SiSU <http://www.jus.uio.no/sisu/> markup +aboutSiSU <http://www.sisudoc.org/> markup .BR A shortcut notation is available so the url link may also be provided @@ -1571,7 +1592,7 @@ automatically as a footnote .B resulting output: .BR -abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup +about SiSU <http://www.sisudoc.org/> [^14] markup .SH 9.5.3 LINKING IMAGES @@ -1585,13 +1606,13 @@ abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup .BR % various url linked images .BR - {tux.png 64x80 \"a better way\" }http://www.jus.uio.no/sisu/ + {tux.png 64x80 "a better way" }http://www.sisudoc.org/ .BR .BR - {GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian and Ruby\" }http://www.jus.uio.no/sisu/ + {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ .BR .BR - {~^ ruby_logo.png \"Ruby\" }http://www.ruby\-lang.org/en/ + {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ .BR .BR .fi @@ -1603,14 +1624,14 @@ abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup [ tux.png ] .BR -tux.png 64x80 \"Gnu/Linux \- a better way\" <http://www.jus.uio.no/sisu/> +tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/> .BR [ \ ruby_logo \ (png \ missing) \ ] [^15] .BR -GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian -and Ruby\" <http://www.jus.uio.no/sisu/> +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +and Ruby" <http://www.jus.uio.no/sisu/> .BR .B linked url footnote shortcut @@ -1619,7 +1640,7 @@ and Ruby\" <http://www.jus.uio.no/sisu/> .nf {~^ \ [text \ to \ link] }http://url.org % maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~ - % which produces hyper\-linked text within a document/paragraph, + % which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink .fi @@ -1631,7 +1652,7 @@ and Ruby\" <http://www.jus.uio.no/sisu/> .BR note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of -auto\-heading numbering, without further intervention. +auto-heading numbering, without further intervention. .SH 9.6 GROUPED TEXT @@ -1660,7 +1681,7 @@ Tables may be prepared in two either of two forms .BR .B resulting output: - \ [table \ omitted, \ see \ other \ document \ formats] + [table omitted, see other document formats] .BR a second form may be easier to work with in cases where there is not much @@ -1672,7 +1693,7 @@ information in each column .nf - !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 + !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 {table~h 24; 12; 12; 12; 12; 12; 12;} |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 @@ -1687,9 +1708,9 @@ information in each column .B resulting output: .BR -.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 +.B Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 - \ [table \ omitted, \ see \ other \ document \ formats] + [table omitted, see other document formats] .BR * Contributed at least ten times; ** at least 5 times in last month; *** more @@ -1706,7 +1727,7 @@ than 100 times in last month. poem{ Your poem here }poem - Each verse in a poem is given a separate object number. + Each verse in a poem is given an object number. .fi .BR @@ -1715,26 +1736,26 @@ than 100 times in last month. .nf poem{ - \`Fury said to a + `Fury said to a mouse, That he met in the house, - \"Let us + "Let us both go to law: I will prosecute - YOU. \-\-Come, - I\'ll take no + YOU. --Come, + I'll take no denial; We must have a trial: For really this - morning I\'ve + morning I've nothing - to do.\" + to do." Said the mouse to the - cur, \"Such + cur, "Such a trial, dear Sir, With @@ -1743,14 +1764,14 @@ than 100 times in last month. would be wasting our - breath.\" - \"I\'ll be - judge, I\'ll - be jury,\" + breath." + "I'll be + judge, I'll + be jury," Said cunning old Fury: - \"I\'ll + "I'll try the whole cause, @@ -1758,14 +1779,14 @@ than 100 times in last month. condemn you to - death.\"\' + death."' }poem .fi .BR .B resulting output: - \'Fury said to a + `Fury said to a .BR mouse, That he .BR @@ -1773,7 +1794,7 @@ than 100 times in last month. .BR house, .BR - \"Let us + "Let us .BR both go to .BR @@ -1781,9 +1802,9 @@ than 100 times in last month. .BR prosecute .BR - YOU. \-\-Come, + YOU. --Come, .BR - I\'ll take no + I'll take no .BR denial; We .BR @@ -1793,17 +1814,17 @@ than 100 times in last month. .BR really this .BR - morning I\'ve + morning I've .BR nothing .BR - to do.\" + to do." .BR Said the .BR mouse to the .BR - cur, \"Such + cur, "Such .BR a trial, .BR @@ -1821,13 +1842,13 @@ than 100 times in last month. .BR our .BR - breath.\" + breath." .BR - \"I\'ll be + "I'll be .BR - judge, I\'ll + judge, I'll .BR - be jury,\" + be jury," .BR Said .BR @@ -1835,7 +1856,7 @@ than 100 times in last month. .BR old Fury: .BR - \"I\'ll + "I'll .BR try the .BR @@ -1851,7 +1872,7 @@ than 100 times in last month. .BR to .BR - death.\"\' + death."' .BR .SH @@ -1878,26 +1899,26 @@ than 100 times in last month. .nf group{ .BR - \'Fury said to a + 'Fury said to a mouse, That he met in the house, - \"Let us + "Let us both go to law: I will prosecute - YOU. \-\-Come, - I\'ll take no + YOU. --Come, + I'll take no denial; We must have a trial: For really this - morning I\'ve + morning I've nothing - to do.\" + to do." Said the mouse to the - cur, \"Such + cur, "Such a trial, dear Sir, With @@ -1906,14 +1927,14 @@ than 100 times in last month. would be wasting our - breath.\" - \"I\'ll be - judge, I\'ll - be jury,\" + breath." + "I'll be + judge, I'll + be jury," Said cunning old Fury: - \"I\'ll + "I'll try the whole cause, @@ -1921,14 +1942,14 @@ than 100 times in last month. condemn you to - death.\"\' + death."' }group .fi .BR .B resulting output: - \'Fury said to a + `Fury said to a .BR mouse, That he .BR @@ -1936,7 +1957,7 @@ than 100 times in last month. .BR house, .BR - \"Let us + "Let us .BR both go to .BR @@ -1944,9 +1965,9 @@ than 100 times in last month. .BR prosecute .BR - YOU. \-\-Come, + YOU. --Come, .BR - I\'ll take no + I'll take no .BR denial; We .BR @@ -1956,17 +1977,17 @@ than 100 times in last month. .BR really this .BR - morning I\'ve + morning I've .BR nothing .BR - to do.\" + to do." .BR Said the .BR mouse to the .BR - cur, \"Such + cur, "Such .BR a trial, .BR @@ -1984,13 +2005,13 @@ than 100 times in last month. .BR our .BR - breath.\" + breath." .BR - \"I\'ll be + "I'll be .BR - judge, I\'ll + judge, I'll .BR - be jury,\" + be jury," .BR Said .BR @@ -1998,7 +2019,7 @@ than 100 times in last month. .BR old Fury: .BR - \"I\'ll + "I'll .BR try the .BR @@ -2014,21 +2035,22 @@ than 100 times in last month. .BR to .BR - death.\"\' + death."' .BR .SH 9.6.4 CODE .BR -Code tags are used to escape regular sisu markup, and have been used -extensively within this document to provide examples of +Code tags code{ \... }code (used as with other group tags described above) are +used to escape regular sisu markup, and have been used extensively within this +document to provide examples of .B SiSU markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. .BR -A code\-block is treated as an object and given a single object number. [an \ +A code-block is treated as an object and given a single object number. [an \ option \ to \ number \ each \ line \ of \ code \ may \ be \ considered \ at \ some \ later \ time] @@ -2037,26 +2059,26 @@ some \ later \ time] .nf - \'Fury said to a + `Fury said to a mouse, That he met in the house, - \"Let us + "Let us both go to law: I will prosecute - YOU. \-\-Come, - I\'ll take no + YOU. --Come, + I'll take no denial; We must have a trial: For really this - morning I\'ve + morning I've nothing - to do.\" + to do." Said the mouse to the - cur, \"Such + cur, "Such a trial, dear Sir, With @@ -2065,14 +2087,14 @@ some \ later \ time] would be wasting our - breath.\" - \"I\'ll be - judge, I\'ll - be jury,\" + breath." + "I'll be + judge, I'll + be jury," Said cunning old Fury: - \"I\'ll + "I'll try the whole cause, @@ -2080,7 +2102,61 @@ some \ later \ time] condemn you to - death.\"\' + death."' +.fi + +.BR +From +.B SiSU +2.7.7 on you can number codeblocks by placing a hash after the opening code +tag code{# as demonstrated here: + + +.nf +1 | `Fury said to a +2 | mouse, That he +3 | met in the +4 | house, +5 | "Let us +6 | both go to +7 | law: I will +8 | prosecute +9 | YOU. --Come, +10 | I'll take no +11 | denial; We +12 | must have a +13 | trial: For +14 | really this +15 | morning I've +16 | nothing +17 | to do." +18 | Said the +19 | mouse to the +20 | cur, "Such +21 | a trial, +22 | dear Sir, +23 | With +24 | no jury +25 | or judge, +26 | would be +27 | wasting +28 | our +29 | breath." +30 | "I'll be +31 | judge, I'll +32 | be jury," +33 | Said +34 | cunning +35 | old Fury: +36 | "I'll +37 | try the +38 | whole +39 | cause, +40 | and +41 | condemn +42 | you +43 | to +44 | death."' .fi .SH @@ -2091,13 +2167,13 @@ To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. .BR -Currently two levels are provided, a main term and if needed a sub\-term. -Sub\-terms are separated from the main term by a colon. +Currently two levels are provided, a main term and if needed a sub-term. +Sub-terms are separated from the main term by a colon. .nf - Paragraph containing main term and sub\-term. - ={Main term:sub\-term} + Paragraph containing main term and sub-term. + ={Main term:sub-term} .fi .BR @@ -2110,7 +2186,7 @@ The structure of the resulting index would be: .nf Main term, 1 - sub\-term, 1 + sub-term, 1 .fi .BR @@ -2119,8 +2195,8 @@ the term refers to more than one paragraph, indicate the number of paragraphs. .nf - Paragraph containing main term, second term and sub\-term. - ={first term; second term: sub\-term} + Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} .fi .BR @@ -2130,29 +2206,29 @@ The structure of the resulting index would be: .nf First term, 1, Second term, 1, - sub\-term, 1 + sub-term, 1 .fi .BR -If multiple sub\-terms appear under one paragraph, they are separated under the +If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. .nf - Paragraph containing main term, second term and sub\-term. - ={Main term:sub\-term+1|second sub\-term - A paragraph that continues discussion of the first sub\-term + Paragraph containing main term, second term and sub-term. + ={Main term:sub-term+1|second sub-term + A paragraph that continues discussion of the first sub-term .fi .BR -The plus one in the example provided indicates the first sub\-term spans one +The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: .nf Main term, 1, - sub\-term, 1\-3, - second sub\-term, 1, + sub-term, 1-3, + second sub-term, 1, .fi .SH @@ -2209,9 +2285,11 @@ MARKUP SYNTAX HISTORY 11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX .BR +2.0 introduced new headers and is therefore incompatible with 1.0 though +otherwise the same with the addition of a couple of tags (i.e. a superset) + .BR -0.38 is substantially current, depreciated 0.16 supported, though file names -were changed at 0.37 +0.38 is substantially current for version 1.0 .BR * sisu \-\-query=[sisu \ version \ [0.38] or \'history] @@ -2251,9 +2329,9 @@ or, backward compatible using the comment marker: 0.38 .BR -variations include \' +variations include ' .B SiSU -(text|master|insert) [version]\' and \'sisu\-[version]\' +(text|master|insert) [version]' and 'sisu-[version]' .BR .B 0.51 @@ -2329,8 +2407,8 @@ The internal document markup of .BR .B SiSU -has in effect two sets of levels to be considered, using 0.38 notation A\-C -headings/levels, pre\-ordinary paragraphs /pre\-substantive text, and 1\-3 +has in effect two sets of levels to be considered, using 0.38 notation A-C +headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 @@ -2341,7 +2419,7 @@ alternative makes explicit an aspect of structuring documents in .B SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); -the substantive text follows levels 1,2,3 and it is \'nice\' to do most work in +the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels .BR @@ -2355,13 +2433,13 @@ those levels \.ssm and \.ssi to replace \.s1 \.s2 \.s3 \.r1 \.r2 \.r3 and \.si .BR -this is captured by the following file \'rename\' instruction: +this is captured by the following file 'rename' instruction: .nf - rename \'s/\.s[123]$/\.sst/\' *.s{1,2,3} - rename \'s/\.r[123]$/\.ssm/\' *.r{1,2,3} - rename \'s/\.si$/\.ssi/\' *.si + rename 's/\.s[123]$/\.sst/' *.s{1,2,3} + rename 's/\.r[123]$/\.ssm/' *.r{1,2,3} + rename 's/\.si$/\.ssi/' *.si .fi .BR @@ -2375,7 +2453,7 @@ The internal document markup remains unchanged, from .BR .B 0.23 -(2005w36/2) utf\-8 for markup file +(2005w36/2) utf-8 for markup file .BR .B 0.22 @@ -2389,8 +2467,8 @@ relied upon .BR .B 0.16 (2005w25/2) substantial changes introduced to make markup cleaner, header -0~title type, and headings [1\-6]~ introduced, also percentage sign (%) at -start of a text line as comment marker +0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start +of a text line as comment marker .BR .B SiSU @@ -2420,7 +2498,7 @@ has plaintext and binary filetypes, and can process either type of document. .BR .B SiSU -documents are prepared as plain\-text (utf\-8) files with +documents are prepared as plain-text (utf-8) files with .B SiSU markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. @@ -2441,10 +2519,10 @@ located locally or on a remote server for which a url is provided. source markup can be shared with the command: .BR - sisu \-s [filename] + sisu -s [filename] .SH -12.1.1 SISU TEXT \- REGULAR FILES (.SST) +12.1.1 SISU TEXT - REGULAR FILES (.SST) .BR The most common form of document in @@ -2454,10 +2532,10 @@ The most common form of document in markup. .BR -<http://www.jus.uio.no/sisu/sisu_markup> +<http://www.sisudoc.org/sisu/sisu_markup> .BR -<http://www.jus.uio.no/sisu/sisu_manual> +<http://www.sisudoc.org/sisu/sisu_manual> .SH 12.1.2 SISU MASTER FILES (.SSM) @@ -2489,10 +2567,10 @@ Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix \._sst [^17] .BR -<http://www.jus.uio.no/sisu/sisu_markup> +<http://www.sisudoc.org/sisu/sisu_markup> .BR -<http://www.jus.uio.no/sisu/sisu_manual> +<http://www.sisudoc.org/sisu/sisu_manual> .SH 12.1.3 SISU INSERT FILES (.SSI) @@ -2515,13 +2593,13 @@ A sisupod is a zipped text file or set of .B SiSU text files and any associated images that they contain (this will be extended -to include sound and multimedia\-files) +to include sound and multimedia-files) .BR .B SiSU plaintext files rely on a recognised directory structure to find contents such as images associated with documents, but all images for example for all -documents contained in a directory are located in the sub\-directory +documents contained in a directory are located in the sub-directory _sisu/image. Without the ability to create a sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned @@ -2539,13 +2617,13 @@ documents. The command to create a sisupod is: .BR - sisu \-S [filename] + sisu -S [filename] .BR Alternatively, make a pod of the contents of a whole directory: .BR - sisu \-S + sisu -S .BR .B SiSU @@ -2553,10 +2631,10 @@ processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. .BR -<http://www.jus.uio.no/sisu/sisu_commands> +<http://www.sisudoc.org/sisu/sisu_commands> .BR -<http://www.jus.uio.no/sisu/sisu_manual> +<http://www.sisudoc.org/sisu/sisu_manual> .SH 13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS @@ -2575,25 +2653,25 @@ incomplete and should be handled with care. .B convert from sst to simple xml representations (sax, dom and node): .BR - sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] + sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] .BR - sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] + sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] .BR - sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] + sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] .BR .B convert to sst from any sisu xml representation (sax, dom and node): .BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .BR or the same: .BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 13.1.1 XML SAX REPRESENTATION @@ -2602,19 +2680,19 @@ or the same: To convert from sst to simple xml (sax) representation: .BR - sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] + sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] .BR To convert from any sisu xml representation back to sst .BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .BR or the same: .BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 13.1.2 XML DOM REPRESENTATION @@ -2623,19 +2701,19 @@ or the same: To convert from sst to simple xml (dom) representation: .BR - sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] + sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] .BR To convert from any sisu xml representation back to sst .BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .BR or the same: .BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 13.1.3 XML NODE REPRESENTATION @@ -2644,19 +2722,19 @@ or the same: To convert from sst to simple xml (node) representation: .BR - sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] + sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] .BR To convert from any sisu xml representation back to sst .BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .BR or the same: .BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] + sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] .SH 14. CONFIGURATION @@ -2671,13 +2749,13 @@ Information on the current configuration of should be available with the help command: .BR - sisu \-v + sisu -v .BR which is an alias for: .BR - sisu \-\-help env + sisu --help env .BR Either of these should be executed from within a directory that contains sisu @@ -2747,7 +2825,7 @@ directory, or site wide basis. Skins are looked for in the following locations: .BR .B Within the skin directory -are the following the default sub\-directories for document skins: +are the following the default sub-directories for document skins: .BR ./skin/doc @@ -2807,24 +2885,24 @@ installed sample skins may be found in: .BR /etc/sisu/skin/doc and - /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc + /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc .BR -(or equivalent directory) and if sisu\-markup\-samples is installed also under: +(or equivalent directory) and if sisu-markup-samples is installed also under: .BR - /usr/share/doc/sisu\-markup\-samples/v2/samples/_sisu/skin/doc + /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc .BR Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: .BR - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent - directory) + /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml (or + equivalent directory) .SH -16. CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) +16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) .BR .BR @@ -2832,7 +2910,7 @@ CSS files to modify the appearance of .B SiSU html, XHTML or XML may be placed in the configuration directory: \./_sisu/css ; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output -directories with the command sisu \-CC. +directories with the command sisu -CC. .BR The basic CSS file for html output is html.css, placing a file of that name in @@ -2877,7 +2955,7 @@ subdirectory of the same name as the document with the filetype identifier stripped (.sst \.ssm) .BR -The last part of a directory path, representing the sub\-directory in which a +The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type @@ -2900,14 +2978,14 @@ appearance. .BR .B SiSU -is about the ability to auto\-generate documents. Home pages are regarded as +is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by .B SiSU . More accurately, .B SiSU has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways -as part of a site\'s configuration, these being: +as part of a site's configuration, these being: .BR 1. through placing your home page and other custom built documents in the @@ -2923,7 +3001,7 @@ subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. .SH -18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY +18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY .BR Custom built pages, including the home page index.html may be placed within the @@ -2932,7 +3010,7 @@ for the configuration directory, namely \./_sisu ; ~/_sisu ; /etc/sisu From there they are copied to the root of the output directory with the command: .BR - sisu \-CC + sisu -CC .SH 18.2 HOME PAGE WITHIN A SKIN @@ -2979,16 +3057,12 @@ Current markup examples and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/examples.html> .BR -Some markup with syntax highlighting may be found under -<http://www.jus.uio.no/sisu/sample/syntax> but is not as up to date. - -.BR For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. .SH -20. SISU SEARCH \- INTRODUCTION +20. SISU SEARCH - INTRODUCTION .BR .BR @@ -3036,14 +3110,14 @@ four tables: subject, (the Dublin Core...); .BR - * another the substantive texts by individual "paragraph" (or object) \- - along with structural information, each paragraph being identifiable by its + * another the substantive texts by individual "paragraph" (or object) - along + with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and .BR - * a third containing endnotes cross\-referenced back to the paragraph from + * a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). @@ -3088,7 +3162,7 @@ that as well). .BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system, +- Structured information, Serialized Units - a document publishing system, postgresql dependency package .SH @@ -3101,16 +3175,16 @@ dependencies needed for .B SiSU to populate a postgresql database, this being part of .B SiSU -\- man sisu). +- man sisu). .SH 22.3 SYNOPSIS .BR - sisu \-D [instruction] [filename/wildcard \ if \ required] + sisu -D [instruction] [filename/wildcard \ if \ required] .BR - sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] + sisu -D --pg --[instruction] [filename/wildcard \ if \ required] .SH 22.4 COMMANDS @@ -3118,54 +3192,54 @@ to populate a postgresql database, this being part of .BR Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +alternatively --sqlite or --pgsql may be used .BR -.B \-D or \-\-pgsql +.B -D or --pgsql may be used interchangeably. .SH 22.4.1 CREATE AND DESTROY DATABASE .TP -.B \-\-pgsql \-\-createall +.B --pgsql --createall initial step, creates required relations (tables, indexes) in existing (postgresql) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) .TP -.B sisu \-D \-\-createdb +.B sisu -D --createdb creates database where no database existed before .TP -.B sisu \-D \-\-create +.B sisu -D --create creates database tables where no database tables existed before .TP -.B sisu \-D \-\-Dropall +.B sisu -D --Dropall destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). .TP -.B sisu \-D \-\-recreate +.B sisu -D --recreate destroys existing database and builds a new empty database structure .SH 22.4.2 IMPORT AND REMOVE DOCUMENTS .TP -.B sisu \-D \-\-import \-v [filename/wildcard] +.B sisu -D --import -v [filename/wildcard] populates database with the contents of the file. Imports documents(s) specified to a postgresql database (at an object level). .TP -.B sisu \-D \-\-update \-v [filename/wildcard] +.B sisu -D --update -v [filename/wildcard] updates file contents in database .TP -.B sisu \-D \-\-remove \-v [filename/wildcard] +.B sisu -D --remove -v [filename/wildcard] removes specified document from postgresql database. .SH @@ -3177,7 +3251,7 @@ removes specified document from postgresql database. .BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system. +- Structured information, Serialized Units - a document publishing system. .SH 23.2 DESCRIPTION @@ -3188,17 +3262,16 @@ dependency package, which is a dummy package to install dependencies needed for .B SiSU to populate an sqlite database, this being part of .B SiSU -\- man sisu). +- man sisu). .SH 23.3 SYNOPSIS .BR - sisu \-d [instruction] [filename/wildcard \ if \ required] + sisu -d [instruction] [filename/wildcard \ if \ required] .BR - sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ - required] + sisu -d --(sqlite|pg) --[instruction] [filename/wildcard \ if \ required] .SH 23.4 COMMANDS @@ -3206,54 +3279,54 @@ to populate an sqlite database, this being part of .BR Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +alternatively --sqlite or --pgsql may be used .BR -.B \-d or \-\-sqlite +.B -d or --sqlite may be used interchangeably. .SH 23.4.1 CREATE AND DESTROY DATABASE .TP -.B \-\-sqlite \-\-createall +.B --sqlite --createall initial step, creates required relations (tables, indexes) in existing (sqlite) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) .TP -.B sisu \-d \-\-createdb +.B sisu -d --createdb creates database where no database existed before .TP -.B sisu \-d \-\-create +.B sisu -d --create creates database tables where no database tables existed before .TP -.B sisu \-d \-\-dropall +.B sisu -d --dropall destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). .TP -.B sisu \-d \-\-recreate +.B sisu -d --recreate destroys existing database and builds a new empty database structure .SH 23.4.2 IMPORT AND REMOVE DOCUMENTS .TP -.B sisu \-d \-\-import \-v [filename/wildcard] +.B sisu -d --import -v [filename/wildcard] populates database with the contents of the file. Imports documents(s) specified to an sqlite database (at an object level). .TP -.B sisu \-d \-\-update \-v [filename/wildcard] +.B sisu -d --update -v [filename/wildcard] updates file contents in database .TP -.B sisu \-d \-\-remove \-v [filename/wildcard] +.B sisu -d --remove -v [filename/wildcard] removes specified document from sqlite database. .SH @@ -3261,12 +3334,12 @@ removes specified document from sqlite database. .BR .SH -24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, +24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .BR Sample search frontend <http://search.sisudoc.org> [^21] A small database and -sample query front\-end (search from) that makes use of the citation system, +sample query front-end (search from) that makes use of the citation system, .I object citation numbering to demonstrates functionality.[^22] @@ -3286,7 +3359,7 @@ the names of the documents matched along with the objects (paragraphs) that meet the search criteria.[^23] .TP -.B sisu \-F \-\-webserv\-webrick +.B sisu -F --webserv-webrick builds a cgi web search frontend for the database created .BR @@ -3294,7 +3367,7 @@ The following is feedback on the setup on a machine provided by the help command: .BR - sisu \-\-help sql + sisu --help sql .nf @@ -3323,21 +3396,21 @@ necessary] 24.2 SEARCH FORM .TP -.B sisu \-F -generates a sample search form, which must be copied to the web\-server cgi +.B sisu -F +generates a sample search form, which must be copied to the web-server cgi directory .TP -.B sisu \-F \-\-webserv\-webrick +.B sisu -F --webserv-webrick generates a sample search form for use with the webrick server, which must be -copied to the web\-server cgi directory +copied to the web-server cgi directory .TP -.B sisu \-Fv +.B sisu -Fv as above, and provides some information on setting up hyperestraier .TP -.B sisu \-W +.B sisu -W starts the webrick server which should be available wherever sisu is properly installed @@ -3369,7 +3442,7 @@ directory /home/ralph/sisu_www (A) to generate the index within the webserver directory to be indexed: .BR - estcmd gather \-sd [index \ name] [directory \ path \ to \ index] + estcmd gather -sd [index \ name] [directory \ path \ to \ index] .BR the following are examples that will need to be tailored according to your @@ -3379,15 +3452,15 @@ needs: cd /home/ralph/sisu_www .BR - estcmd gather \-sd casket /home/ralph/sisu_www + estcmd gather -sd casket /home/ralph/sisu_www .BR -you may use the \'find\' command together with \'egrep\' to limit indexing to +you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: .BR - find /home/ralph/sisu_www \-type f | egrep - \'/home/ralph/sisu_www/sisu/.+?.html$\' |estcmd gather \-sd casket \- + find /home/ralph/sisu_www -type f | egrep + '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - .BR Check which directories in the webserver/output directory (~/sisu_www or @@ -3396,25 +3469,24 @@ elsewhere depending on configuration) you wish to include in the search index. .BR As sisu duplicates output in multiple file formats, it it is probably preferable to limit the estraier index to html output, and as it may also be -desirable to exclude files \'plain.txt\', \'toc.html\' and -\'concordance.html\', as these duplicate information held in other html output -e.g. +desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as +these duplicate information held in other html output e.g. .BR - find /home/ralph/sisu_www \-type f | egrep - \'/sisu_www/(sisu|bookmarks)/.+?.html$\' | egrep \-v - \'(doc|concordance).html$\' |estcmd gather \-sd casket \- + find /home/ralph/sisu_www -type f | egrep + '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' + |estcmd gather -sd casket - .BR from your current document preparation/markup directory, you would construct a rune along the following lines: .BR - find /home/ralph/sisu_www \-type f | egrep \'/home/ralph/sisu_www/([specify \ + find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify \ first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \ - inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$\' | - egrep \-v \'(doc|concordance).html$\' |estcmd gather \-sd - /home/ralph/sisu_www/casket \- + inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$' | + egrep -v '(doc|concordance).html$' |estcmd gather -sd + /home/ralph/sisu_www/casket - .BR (B) to set up the search form @@ -3423,20 +3495,20 @@ rune along the following lines: (i) copy estseek.cgi to your cgi directory and set file permissions to 755: .BR - sudo cp \-vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi\-bin + sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin .BR - sudo chmod \-v 755 /usr/lib/cgi\-bin/estseek.cgi + sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi .BR - sudo cp \-v /usr/share/hyperestraier/estseek.* /usr/lib/cgi\-bin + sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin .BR [see \ estraier \ documentation \ for \ paths] .BR -(ii) edit estseek.conf, with attention to the lines starting \'indexname:\' and -\'replace:\': +(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and +'replace:': .BR indexname: /home/ralph/sisu_www/casket @@ -3451,10 +3523,10 @@ rune along the following lines: (C) to test using webrick, start webrick: .BR - sisu \-W + sisu -W .BR -and try open the url: <http://localhost:8081/cgi\-bin/estseek.cgi> +and try open the url: <http://localhost:8081/cgi-bin/estseek.cgi> .SH 26. SISU_WEBRICK @@ -3465,7 +3537,7 @@ and try open the url: <http://localhost:8081/cgi\-bin/estseek.cgi> .BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system +- Structured information, Serialized Units - a document publishing system .SH 26.2 SYNOPSIS @@ -3477,7 +3549,7 @@ sisu_webrick [port] or .BR -sisu \-W [port] +sisu -W [port] .SH 26.3 DESCRIPTION @@ -3487,7 +3559,7 @@ sisu_webrick is part of .B SiSU (man sisu) sisu_webrick starts .B Ruby -\'s Webrick web\-server and points it to the directories to which +' s Webrick web-server and points it to the directories to which .B SiSU output is written, providing a list of these directories (assuming .B SiSU @@ -3502,8 +3574,8 @@ yaml file: ~/.sisu/sisurc.yml a sample of which is provided as 26.4 SUMMARY OF MAN PAGE .BR -sisu_webrick, may be started on it\'s own with the command: sisu_webrick [port] -or using the sisu command with the \-W flag: sisu \-W [port] +sisu_webrick, may be started on it's own with the command: sisu_webrick [port] +or using the sisu command with the -W flag: sisu -W [port] .BR where no port is given and settings are unchanged the default port is 8081 @@ -3512,9 +3584,9 @@ where no port is given and settings are unchanged the default port is 8081 26.5 DOCUMENT PROCESSING COMMAND FLAGS .BR -sisu \-W [port] starts +sisu -W [port] starts .B Ruby -Webrick web\-server, serving +Webrick web-server, serving .B SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 @@ -3525,7 +3597,7 @@ defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 .BR For more information on .B SiSU -see: <http://www.jus.uio.no/sisu> +see: <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu> .BR or man sisu @@ -3562,7 +3634,7 @@ documents can either be sisu marked up files in plaintext \.sst or \.ssm or; zipped sisu files, sisupod.zip or filename.ssp .BR -.B \.sst / \.ssm \- sisu text files +.B \.sst / \.ssm - sisu text files .BR .B SiSU @@ -3572,13 +3644,13 @@ processing instruction and the url. The source file and any associated parts .nf - sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] + sisu -3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] .fi .BR Any of the source documents in the sisu examples page can be used in this way, -see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url for the -desired document. +see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url to the + \.sst for the desired document. .BR NOTE: to set up a remote machine to serve @@ -3587,7 +3659,7 @@ documents in this way, images should be in the directory relative to the document source \../_sisu/image .BR -.B sisupod \- zipped sisu files +.B sisupod - zipped sisu files .BR A sisupod is the zipped content of a sisu marked up text or texts and any other @@ -3601,7 +3673,7 @@ documents it contains generated locally. .nf - sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] + sisu -3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] .fi .BR @@ -3626,37 +3698,37 @@ machine using either rsync, or scp. .BR In order to do this some ssh authentication agent and keychain or similar tool will need to be configured. Once that is done the placement on a remote host -can be done seamlessly with the \-r (for scp) or \-R (for rsync) flag, which -may be used in conjunction with other processing flags, e.g. +can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may +be used in conjunction with other processing flags, e.g. .nf - sisu \-3R sisu_remote.sst + sisu -3R sisu_remote.sst .fi .SH 28.1 COMMANDS .TP -.B \-R [filename/wildcard] +.B -R [filename/wildcard] copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your \"keys\" and ssh agent in place. Note the behavior of rsync -different if \-R is used with other flags from if used alone. Alone the rsync -\-\-delete parameter is sent, useful for cleaning the remote directory (when -\-R is used together with other flags, it is not). Also see \-r +that you have your "keys" and ssh agent in place. Note the behavior of rsync +different if -R is used with other flags from if used alone. Alone the rsync +--delete parameter is sent, useful for cleaning the remote directory (when -R +is used together with other flags, it is not). Also see -r .TP -.B \-r [filename/wildcard] +.B -r [filename/wildcard] copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your \"keys\" and ssh agent in place. Also see \-R +that you have your "keys" and ssh agent in place. Also see -R .SH 28.2 CONFIGURATION .BR -[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain] +[expand \ on \ the \ setting \ up \ of \ an \ ssh-agent \ / \ keychain] .SH 29. REMOTE SERVERS @@ -3673,7 +3745,7 @@ which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine. .SH -30. QUICKSTART \- GETTING STARTED HOWTO +30. QUICKSTART - GETTING STARTED HOWTO .BR .SH @@ -3698,8 +3770,7 @@ Sid and testing archives (and possibly Ubuntu), assuming your .nf aptitude update -.BR - aptitude install sisu\-complete + aptitude install sisu-complete .fi .BR @@ -3710,11 +3781,11 @@ markup samples: .nf #/etc/apt/sources.list .BR - deb http://ftp.fi.debian.org/debian/ unstable main non\-free contrib + deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib .BR - deb\-src http://ftp.fi.debian.org/debian/ unstable main non\-free contrib + deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib .BR - d + .fi .BR @@ -3724,7 +3795,7 @@ The aptitude commands become: .nf aptitude update .BR - aptitude install sisu\-complete sisu\-markup\-samples + aptitude install sisu-complete sisu-markup-samples .fi .BR @@ -3738,8 +3809,8 @@ archives, they will be available by adding the following to your .nf #/etc/apt/sources.list - deb http://www.jus.uio.no/sisu/archive unstable main non\-free - deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free + deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free .fi .BR @@ -3748,11 +3819,11 @@ repeat the aptitude commands .nf aptitude update - aptitude install sisu\-complete sisu\-markup\-samples + aptitude install sisu-complete sisu-markup-samples .fi .BR -Note however that it is not necessary to install sisu\-complete if not all +Note however that it is not necessary to install sisu-complete if not all components of sisu are to be used. Installing just the package sisu will provide basic functionality. @@ -3773,7 +3844,7 @@ They may be downloaded from: as root type: .BR - rpm \-i [rpm \ package \ name] + rpm -i [rpm \ package \ name] .SH 30.1.3 INSTALLATION FROM SOURCE @@ -3837,11 +3908,11 @@ further information on setup.rb is available from: <http://i.loveruby.net/en/projects/setup/doc/usage.html> .BR -.B \"install\" +.B "install" .BR -The \"install\" file provided is an installer prepared using \"rant\". In the -root directory of the unpacked +The "install" file provided is an installer prepared using "rant". In the root +directory of the unpacked .B SiSU as root type: @@ -3864,10 +3935,10 @@ or This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, -such as tetex\-extra are not taken care of for you. +such as tetex-extra are not taken care of for you. .BR -Further information on \"rant\" is available from: +Further information on "rant" is available from: .BR <http://make.rubyforge.org/> @@ -3882,7 +3953,7 @@ For a list of alternative actions you may type: ruby install help .BR - ruby install \-T + ruby install -T .SH 30.2 TESTING SISU, GENERATING OUTPUT @@ -3891,7 +3962,7 @@ For a list of alternative actions you may type: To check which version of sisu is installed: .BR -sisu \-v +sisu -v .BR Depending on your mode of installation one or a number of markup sample files @@ -3920,7 +3991,7 @@ Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it .BR -sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst .BR this will generate html including a concordance file, opendocument text format, @@ -3931,7 +4002,7 @@ plaintext, XHTML and various forms of XML, and OpenDocument text .BR Assuming a LaTeX engine such as tetex or texlive is installed with the required -modules (done automatically on selection of sisu\-pdf in +modules (done automatically on selection of sisu-pdf in .B Debian ) @@ -3940,10 +4011,10 @@ Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it .BR -sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst .BR -sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst .BR should generate most available output formats: html including a concordance @@ -3951,27 +4022,27 @@ file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf .SH -30.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE +30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE .BR -Relational databases need some setting up \- you must have permission to create +Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. .BR Assuming you have the database installed and the requisite permissions .BR -sisu \-\-sqlite \-\-recreate +sisu --sqlite --recreate .BR -sisu \-\-sqlite \-v \-\-import +sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst .BR -sisu \-\-pgsql \-\-recreate +sisu --pgsql --recreate .BR -sisu \-\-pgsql \-v \-\-import +sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst .SH @@ -3991,10 +4062,10 @@ The man pages are also available online, though not always kept as up to date as within the package itself: .BR -* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1> [^25] +* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^25] .BR -* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8> [^26] +* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> [^26] .BR * man directory <http://www.jus.uio.no/sisu/man> [^27] @@ -4003,21 +4074,24 @@ as within the package itself: 30.3.2 BUILT IN HELP .BR -sisu \-\-help +sisu --help .BR -sisu \-\-help \-\-env +sisu --help --env .BR -sisu \-\-help \-\-commands +sisu --help --commands .BR -sisu \-\-help \-\-markup +sisu --help --markup .SH 30.3.3 THE HOME PAGE .BR +<http://www.sisudoc.org/> + +.BR <http://www.jus.uio.no/sisu> .BR @@ -4041,9 +4115,9 @@ Additional markup samples are packaged separately in the file: .BR On .B Debian -they are available in non\-free[^28] to include them it is necessary to -include non\-free in your /etc/apt/source.list or obtain them from the sisu -home site. +they are available in non-free[^28] to include them it is necessary to +include non-free in your /etc/apt/source.list or obtain them from the sisu home +site. .SH 31. EDITOR FILES, SYNTAX HIGHLIGHTING @@ -4053,10 +4127,16 @@ home site. The directory: .BR - \./data/sisu/v2/conf/editor\-syntax\-etc/ + \./data/sisu/v2/conf/editor-syntax-etc/ + +.BR + \./data/sisu/v3/conf/editor-syntax-etc/ + +.BR + /usr/share/sisu/v2/conf/editor-syntax-etc .BR - /usr/share/sisu/v2/conf/editor\-syntax\-etc + /usr/share/sisu/v3/conf/editor-syntax-etc .BR contains rudimentary sisu syntax highlighting files for: @@ -4065,7 +4145,7 @@ contains rudimentary sisu syntax highlighting files for: * (g)vim <http://www.vim.org> .BR - package: sisu\-vim + package: sisu-vim .BR status: largely done @@ -4086,13 +4166,13 @@ status: largely done place in: .BR - /usr/share/gtksourceview\-1.0/language\-specs + /usr/share/gtksourceview-1.0/language-specs .BR or .BR - ~/.gnome2/gtksourceview\-1.0/language\-specs + ~/.gnome2/gtksourceview-1.0/language-specs .BR status: very basic syntax highlighting @@ -4101,7 +4181,7 @@ or comments: this editor features display line wrap and is used by Goby! .BR -* nano <http://www.nano\-editor.org> +* nano <http://www.nano-editor.org> .BR file: nanorc @@ -4116,7 +4196,7 @@ save as: status: basic syntax highlighting .BR - comments: assumes dark background; no display line\-wrap; does line breaks + comments: assumes dark background; no display line-wrap; does line breaks .BR * diakonos (an editor written in ruby) <http://purepistos.net/diakonos> @@ -4137,7 +4217,7 @@ includes: status: basic syntax highlighting .BR -comments: assumes dark background; no display line\-wrap +comments: assumes dark background; no display line-wrap .BR * kate & kwrite <http://kate.kde.org> @@ -4170,7 +4250,7 @@ comments: assumes dark background; no display line\-wrap file: sisu_nedit.pats .BR - nedit \-import sisu_nedit.pats + nedit -import sisu_nedit.pats .BR status: a very clumsy first attempt [not \ really \ done] @@ -4182,16 +4262,17 @@ comments: assumes dark background; no display line\-wrap * emacs <http://www.gnu.org/software/emacs/emacs.html> .BR - files: sisu\-mode.el + files: sisu-mode.el .BR to file ~/.emacs add the following 2 lines: .BR - (add\-to\-list \'load\-path \"/usr/share/sisu/v1/conf/editor\-syntax\-etc/emacs\") + (add-to-list 'load-path + "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs") .BR - (require \'sisu\-mode.el) + (require 'sisu-mode.el) .BR [not \ done \ / \ not \ yet \ included] @@ -4218,7 +4299,7 @@ NOTE: .BR [ \ .B \ SiSU \ parses \ files \ with \ long \ lines \ or \ line \ breaks, \ -but, \ display \ linewrap \ (without \ line\-breaks) \ is \ a \ convenient \ +but, \ display \ linewrap \ (without \ line-breaks) \ is \ a \ convenient \ editor \ feature \ to \ have \ for \ sisu \ markup] .SH @@ -4237,7 +4318,7 @@ must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of -information on the document\'s structure and its objects,[2] which the program +information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in @@ -4251,9 +4332,9 @@ ways of representing documents, (or indeed to create new ones). .BR .BR -* sparse/minimal markup (clean utf\-8 source texts). Documents are prepared in -a single UTF\-8 file using a minimalistic mnemonic syntax. Typical literature, -documents like \"War and Peace\" require almost no markup, and most of the +* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a +single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, +documents like "War and Peace" require almost no markup, and most of the headers are optional. .BR @@ -4263,8 +4344,8 @@ and more sparse than the most basic HTML), [this \ may \ also \ be \ converted .BR * markup defines document structure (this may be done once in a header -pattern\-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike\-through etc.) as required; and +pattern-match description, or for heading levels individually); basic text +attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. @@ -4282,7 +4363,7 @@ different strengths of various standard formats for representing documents, amongst the output formats currently supported are: .BR - * html \- both as a single scrollable text and a segmented document + * html - both as a single scrollable text and a segmented document .BR * xhtml @@ -4291,21 +4372,21 @@ amongst the output formats currently supported are: * epub .BR - * XML \- both in sax and dom style xml structures for further development as + * XML - both in sax and dom style xml structures for further development as required .BR - * ODF \- open document format, the iso standard for document storage + * ODF - open document format, the iso standard for document storage .BR - * LaTeX \- used to generate pdf + * LaTeX - used to generate pdf .BR * pdf (via LaTeX) .BR - * sql \- population of an sql database, (at the same object level that is - used to cite text within a document) + * sql - population of an sql database, (at the same object level that is used + to cite text within a document) .BR Also produces: concordance files; document content certificates (md5 or sha256 @@ -4336,10 +4417,11 @@ also possible to look at just the matching paragraphs of the documents in the database; [output \ indexing \ also \ work \ well \ with \ search \ indexing \ tools \ like \ hyperestraier]. -.BR * long term maintainability of document collections in a world of changing -formats, having a very sparsely marked\-up source document base. there is a -considerable degree of future\-proofing, output representations are -\"upgradeable\", and new document formats may be added. e.g. addition of odf +.BR +* long term maintainability of document collections in a world of changing +formats, having a very sparsely marked-up source document base. there is a +considerable degree of future-proofing, output representations are +"upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts @@ -4354,7 +4436,7 @@ to be done only once but may be repeated for various reasons as desired presentations/representations) .BR -* document source (plaintext utf\-8) if shared on the net may be used as input +* document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs .BR @@ -4428,7 +4510,7 @@ try one of the following: <http://www.jus.uio.no/sisu/man/sisu_help.1.html> .BR -.B sisu generated output \- links to html +.B sisu generated output - links to html .BR <http://sisudoc.org/sisu/sisu_help/index.html> @@ -4455,114 +4537,75 @@ Alternative sources for this help sources page listed here: man sisu .BR - man 7 sisu_complete - -.BR - man 7 sisu_pdf - -.BR - man 7 sisu_postgresql - -.BR - man 7 sisu_sqlite - -.BR - man sisu_termsheet - -.BR - man sisu_webrick - -.SH -34.2 SISU GENERATED OUTPUT \- LINKS TO HTML + man sisu-concordance .BR -Note -.B SiSU -documentation is prepared in -.B SiSU -and output is available in multiple formats including amongst others html, -pdf, odf and epub which may be also be accessed via the html pages[^28] - -.SH -34.2.1 WWW.SISUDOC.ORG + man sisu-epub .BR -<http://sisudoc.org/sisu/sisu_manual/index.html> + man sisu-git .BR - <http://sisudoc.org/sisu/sisu_manual/index.html> + man sisu-harvest .BR - <http://sisudoc.org/sisu/sisu_commands/index.html> + man sisu-html .BR - <http://sisudoc.org/sisu/sisu_complete/index.html> + man sisu-odf .BR - <http://sisudoc.org/sisu/sisu_configuration/index.html> + man sisu-pdf .BR - <http://sisudoc.org/sisu/sisu_description/index.html> + man sisu-pg .BR - <http://sisudoc.org/sisu/sisu_examples/index.html> + man sisu-po .BR - <http://sisudoc.org/sisu/sisu_faq/index.html> + man sisu-sqlite .BR - <http://sisudoc.org/sisu/sisu_filetypes/index.html> + man sisu-txt .BR - <http://sisudoc.org/sisu/sisu_help/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_howto/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_introduction/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_markup/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_output_overview/index.html> + man 7 sisu_complete .BR - <http://sisudoc.org/sisu/sisu_pdf/index.html> + man 7 sisu_pdf .BR - <http://sisudoc.org/sisu/sisu_postgresql/index.html> + man 7 sisu_postgresql .BR - <http://sisudoc.org/sisu/sisu_quickstart/index.html> + man 7 sisu_sqlite .BR - <http://sisudoc.org/sisu/sisu_remote/index.html> + man sisu_termsheet .BR - <http://sisudoc.org/sisu/sisu_search/index.html> + man sisu_webrick -.BR - <http://sisudoc.org/sisu/sisu_skin/index.html> +.SH +34.2 SISU GENERATED OUTPUT - LINKS TO HTML .BR - <http://sisudoc.org/sisu/sisu_sqlite/index.html> +Note +.B SiSU +documentation is prepared in +.B SiSU +and output is available in multiple formats including amongst others html, +pdf, odf and epub, which may be also be accessed via the html pages[^29] -.BR - <http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html> +.SH +34.2.1 WWW.SISUDOC.ORG .BR - <http://sisudoc.org/sisu/sisu_vim/index.html> +<http://sisudoc.org/sisu/sisu_manual/index.html> .BR - <http://sisudoc.org/sisu/sisu_webrick/index.html> + <http://sisudoc.org/sisu/sisu_manual/index.html> .SH 34.3 MAN2HTML @@ -4571,28 +4614,22 @@ pdf, odf and epub which may be also be accessed via the html pages[^28] 34.3.1 LOCALLY INSTALLED .BR -<file:///usr/share/doc/sisu/v2/html/sisu.1.html> - -.BR -<file:///usr/share/doc/sisu/v2/html/sisu_help.1.html> +file:///usr/share/doc/sisu/html/sisu.1.html .BR -<file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html> + file:///usr/share/doc/sisu/html/sisu.1.html .BR - /usr/share/doc/sisu/v2/html/sisu.1.html - -.BR - /usr/share/doc/sisu/v2/html/sisu_pdf.7.html + file:///usr/share/doc/sisu/html/sisu_pdf.7.html .BR - /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html + file:///usr/share/doc/sisu/html/sisu_postgresql.7.html .BR - /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html + file:///usr/share/doc/sisu/html/sisu_sqlite.7.html .BR - /usr/share/doc/sisu/v2/html/sisu_webrick.1.html + file:///usr/share/doc/sisu/html/sisu_webrick.1.html .SH 34.3.2 WWW.JUS.UIO.NO/SISU @@ -4694,7 +4731,9 @@ editors notes, numbered asterisk footnote/endnote series editors notes, numbered asterisk footnote/endnote series .TP .BI 14. -<http://www.jus.uio.no/sisu/> +<http://www.sisudoc.org/> + +.BR .TP .BI 15. <http://www.ruby-lang.org/en/> @@ -4706,7 +4745,7 @@ Table from the Wealth of Networks by Yochai Benkler .BI 17. \.ssc (for composite) is under consideration but \._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will -have \"accidents\", working on a \.ssc file that is overwritten by subsequent +have "accidents", working on a \.ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared \.ssc is an appropriate suffix to use. .TP @@ -4739,10 +4778,14 @@ matches are found. There is nothing to stop MySQL support being added in future. .TP .BI 25. -<http://www.jus.uio.no/sisu/man/sisu.1> +<http://www.jus.uio.no/sisu/man/sisu.1.html> + +.BR .TP .BI 26. -<http://www.jus.uio.no/sisu/man/sisu.8> +<http://www.jus.uio.no/sisu/man/sisu.8.html> + +.BR .TP .BI 27. <http://www.jus.uio.no/sisu/man> @@ -4761,28 +4804,26 @@ named index.html or more extensively through sisu_manifest.html .SH SEE ALSO \fIsisu\fR(1), .br -\fIsisu\-epub\fR(1), +\fIsisu-epub\fR(1), .br -\fIsisu\-harvest\fR(1), +\fIsisu-harvest\fR(1), .br -\fIsisu\-html\fR(1), +\fIsisu-html\fR(1), .br -\fIsisu\-odf\fR(1), +\fIsisu-odf\fR(1), .br -\fIsisu\-pdf\fR(1), +\fIsisu-pdf\fR(1), .br -\fIsisu\-pg\fR(1), +\fIsisu-pg\fR(1), .br -\fIsisu\-sqlite\fR(1), +\fIsisu-sqlite\fR(1), .br -\fIsisu\-txt\fR(1). +\fIsisu-txt\fR(1). .br \fIsisu_vim\fR(7) -.br -\fIsisu\fR(8) .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu3.1 b/man/man1/sisu3.1 index 96b69e36..09708b31 100644..120000 --- a/man/man1/sisu3.1 +++ b/man/man1/sisu3.1 @@ -1,4806 +1 @@ -.TH "sisu" "1" "2011-02-07" "3.0.0" "SiSU" -.SH NAME -sisu \- documents: markup, structuring, publishing in multiple standard formats, and search -.SH SYNOPSIS -sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard] - -.BR -sisu [\-P] [language_directory/filename language_directory] - -.BR -sisu [\-Ddcv] [instruction] [filename/wildcard] - -.BR -sisu [\-CcFLSVvW] - -.BR -sisu \-\-v2 [operations] - -.BR -sisu \-\-v1 [operations] -.SH -SISU \- MANUAL, -RALPH AMISSAH -.BR - -.SH -WHAT IS SISU? -.BR - -.SH -1. INTRODUCTION \- WHAT IS SISU? -.BR - -.BR -.B SiSU -is a framework for document structuring, publishing (in multiple open -standard formats) and search, comprising of: (a) a lightweight document -structure and presentation markup syntax; and (b) an accompanying engine for -generating standard document format outputs from documents prepared in sisu -markup syntax, which is able to produce multiple standard outputs (including -the population of sql databases) that (can) share a common numbering system for -the citation of text within a document. - -.BR -.B SiSU -is developed under an open source, software libre license (GPL3). Its use -case for development is work with medium to large document sets and cope with -evolving document formats/ representation technologies. Documents are prepared -once, and generated as need be to update the technical presentation or add -additional output formats. Various output formats (including search related -output) share a common mechanism for cross\-output\-format citation. - -.BR -.B SiSU -both defines a markup syntax and provides an engine that produces open -standards format outputs from documents prepared with -.B SiSU -markup. From a single lightly prepared document sisu custom builds several -standard output formats which share a common (text object) numbering system for -citation of content within a document (that also has implications for search). -The sisu engine works with an abstraction of the document's structure and -content from which it is possible to generate different forms of representation -of the document. Significantly -.B SiSU -markup is more sparse than html and outputs which include html, EPUB, LaTeX, -landscape and portrait pdfs, Open Document Format (ODF), all of which can be -added to and updated. -.B SiSU -is also able to populate SQL type databases at an object level, which means -that searches can be made with that degree of granularity. - -.BR -Source document preparation and output generation is a two step process: (i) -document source is prepared, that is, marked up in sisu markup syntax and (ii) -the desired output subsequently generated by running the sisu engine against -document source. Output representations if updated (in the sisu engine) can be -generated by re\-running the engine against the prepared source. Using -.B SiSU -markup applied to a document, -.B SiSU -custom builds (to take advantage of the strengths of different ways of -representing documents) various standard open output formats including plain -text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an -SQL database with objects[^1] (equating generally to paragraph\-sized chunks) -so searches may be performed and matches returned with that degree of -granularity ( e.g. your search criteria is met by these documents and at these -locations within each document). Document output formats share a common object -numbering system for locating content. This is particularly suitable for -"published" works (finalized texts as opposed to works that are frequently -changed or updated) for which it provides a fixed means of reference of -content. - -.BR -In preparing a -.B SiSU -document you optionally provide semantic information related to the document -in a document header, and in marking up the substantive text provide -information on the structure of the document, primarily indicating heading -levels and footnotes. You also provide information on basic text attributes -where used. The rest is automatic, sisu from this information custom builds[^2] -the different forms of output requested. - -.BR -.B SiSU -works with an abstraction of the document based on its structure which is -comprised of its headings[^3] and objects[^4], which enables -.B SiSU -to represent the document in many different ways, and to take advantage of -the strengths of different ways of presenting documents. The objects are -numbered, and these numbers can be used to provide a common basis for citing -material within a document across the different output format types. This is -significant as page numbers are not well suited to the digital age, in web -publishing, changing a browser's default font or using a different browser can -mean that text will appear on a different page; and publishing in different -formats, html, landscape and portrait pdf etc. again page numbers are not -useful to cite text. Dealing with documents at an object level together with -object numbering also has implications for search that -.B SiSU -is able to take advantage of. - -.BR -One of the challenges of maintaining documents is to keep them in a format that -allows use of them independently of proprietary platforms. Consider issues -related to dealing with legacy proprietary formats today and what guarantee you -have that old proprietary formats will remain (or can be read without -proprietary software/equipment) in 15 years time, or the way the way in which -html has evolved over its relatively short span of existence. -.B SiSU -provides the flexibility of producing documents in multiple non\-proprietary -open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst -.B SiSU -relies on software, the markup is uncomplicated and minimalistic which -guarantees that future engines can be written to run against it. It is also -easily converted to other formats, which means documents prepared in -.B SiSU -can be migrated to other document formats. Further security is provided by -the fact that the software itself, -.B SiSU -is available under GPL3 a licence that guarantees that the source code will -always be open, and free as in libre, which means that that code base can be -used, updated and further developed as required under the terms of its license. -Another challenge is to keep up with a moving target. -.B SiSU -permits new forms of output to be added as they become important, (Open -Document Format text was added in 2006 when it became an ISO standard for -office applications and the archival of documents), EPUB was introduced in -2009; and allows the technical representations existing output to be updated -(html has evolved and the related module has been updated repeatedly over the -years, presumably when the World Wide Web Consortium (w3c) finalises html 5 -which is currently under development, the html module will again be updated -allowing all existing documents to be regenerated as html 5). - -.BR -The document formats are written to the file\-system and available for indexing -by independent indexing tools, whether off the web like Google and Yahoo or on -the site like Lucene and Hyperestraier. - -.BR -.B SiSU -also provides other features such as concordance files and document content -certificates, and the working against an abstraction of document structure has -further possibilities for the research and development of other document -representations, the availability of objects is useful for example for topic -maps and thesauri, together with the flexibility of -.B SiSU -offers great possibilities. - -.BR -.B SiSU -is primarily for published works, which can take advantage of the citation -system to reliably reference its documents. -.B SiSU -works well in a complementary manner with such collaborative technologies as -Wikis, which can take advantage of and be used to discuss the substance of -content prepared in -.B SiSU -. - -.BR -<http://www.jus.uio.no/sisu> - -.SH -2. COMMANDS SUMMARY -.BR - -.SH -2.1 DESCRIPTION - -.BR -.B SiSU -.B SiSU -is a document publishing system, that from a simple single marked\-up -document, produces multiple of output formats including: plaintext, html, -xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and -SQLite), which share numbered text objects ("object citation numbering") and -the same document structure information. For more see: -<http://www.jus.uio.no/sisu> - -.SH -2.2 DOCUMENT PROCESSING COMMAND FLAGS - -.TP -.B \-a [filename/wildcard] -produces plaintext with Unix linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them [ \ \-A -\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for -footnotes at the end of each paragraph \-\-unix for unix linefeed (default) -\-\-msdos for msdos linefeed) - -.TP -.B \-b [filename/wildcard] -see \-\-xhtml - -.TP -.B \-\-color\-toggle [filename/wildcard] -screen toggle ansi screen colour on or off depending on default set (unless -\-c flag is used: if sisurc colour default is set to 'true', output to screen -will be with colour, if sisurc colour default is set to 'false' or is undefined -screen output will be without colour). Alias \-c - -.TP -.B \-\-concordance [filename/wildcard] -produces concordance (wordmap) a rudimentary index of all the words in a -document. (Concordance files are not generated for documents of over 260,000 -words unless this limit is increased in the file sisurc.yml). Alias \-w - -.TP -.B \-C [\-\-init\-site] -configure/initialise shared output directory files initialize shared output -directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). \-C \-\-init\-site configure/initialise -site more extensive than \-C on its own, shared output directory files/force -update, existing shared output config files such as css and dtd files are -updated if this modifier is used. - -.TP -.B \-CC -configure/initialise shared output directory files initialize shared output -directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). The equivalent of: \-C \-\-init\-site -configure/initialise site, more extensive than \-C on its own, shared output -directory files/force update, existing shared output config files such as css -and dtd files are updated if \-CC is used. - -.TP -.B \-c [filename/wildcard] -see \-\-color\-toggle - -.TP -.B \-\-dal [filename/wildcard/url] -assumed for most other flags, creates new intermediate files for processing -(document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see \-n. -Alias \-m - -.TP -.B \-\-delete [filename/wildcard] -see \-\-zap - -.TP -.B \-D [instruction] [filename] -see \-\-pg - -.TP -.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] -see \-\-sqlite - -.TP -.B \-\-epub [filename/wildcard] -produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias -\-e - -.TP -.B \-e [filename/wildcard] -see \-\-epub - -.TP -.B \-F [\-\-webserv=webrick] -see \-\-sample\-search\-form - -.TP -.B \-\-git [filename/wildcard] -produces or updates markup source file structure in a git repo (experimental -and subject to change). Alias \-g - -.TP -.B \-g [filename/wildcard] -see \-\-git - -.TP -.B \-\-harvest *.ss[tm] -makes two lists of sisu output based on the sisu markup documents in a -directory: list of author and authors works (year and titles), and; list by -topic with titles and author. Makes use of header metadata fields (author, -title, date, topic_register). Can be used with maintenance (\-M) and remote -placement (\-R) flags. - -.TP -.B \-\-help [topic] -provides help on the selected topic, where topics (keywords) include: list, -(com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, -headings, endnotes, tables, example, customise, skin, (dir)ectories, path, -(lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql, -features, license - -.TP -.B \-\-html [filename/wildcard] -produces html output, segmented text with table of contents (toc.html and -index.html) and the document in a single file (scroll.html). Alias \-h - -.TP -.B \-h [filename/wildcard] -see \-\-html - -.TP -.B \-I [filename/wildcard] -see \-\-texinfo - -.TP -.B \-i [filename/wildcard] -see \-\-manpage - -.TP -.B \-L -prints license information. - -.TP -.B \-\-machine [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) - -.TP -.B \-\-maintenance [filename/wildcard/url] -maintenance mode files created for processing preserved and their locations -indicated. (also see \-V). Alias \-M - -.TP -.B \-\-manpage [filename/wildcard] -produces man page of file, not suitable for all outputs. Alias \-i - -.TP -.B \-M [filename/wildcard/url] -see \-\-maintenance - -.TP -.B \-m [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) - -.TP -.B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html or -LaTeX/pdf output. - -.TP -.B \-N [filename/wildcard/url] -document digest or document content certificate ( DCC ) as md5 digest tree of -the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). \-NV for verbose digest output to screen. - -.TP -.B \-n [filename/wildcard/url] -skip the creation of intermediate processing files (document abstraction) if -they already exist, this skips the equivalent of \-m which is otherwise assumed -by most processing flags. - -.TP -.B \-\-odf [filename/wildcard/url] -see \-\-odt - -.TP -.B \-\-odt [filename/wildcard/url] -output basic document in opendocument file format (opendocument.odt). Alias -\-o - -.TP -.B \-o [filename/wildcard/url] -see \-\-odt - -.TP -.B \-\-pdf [filename/wildcard] -produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set -in config file, or document header, or provided with additional command line -parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and -'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p - -.TP -.B \-\-pg [instruction] [filename] -database postgresql ( \-\-pgsql may be used instead) possible instructions, -include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; -\-\-update [filename]; \-\-remove [filename]; see database section below. Alias -\-D - -.TP -.B \-\-po [language_directory/filename language_directory] -see \-\-po4a - -.TP -.B \-\-po4a [language_directory/filename language_directory] -produces .pot and po files for the file in the languages specified by the -language directory. SiSU markup is placed in subdirectories named with the -language code, e.g. en/ fr/ es/. The sisu config file must set the output -directory structure to multilingual. v3, experimental - -.TP -.B \-P [language_directory/filename language_directory] -see \-\-po4a - -.TP -.B \-p [filename/wildcard] -see \-\-pdf - -.TP -.B \-\-quiet [filename/wildcard] -quiet less output to screen. - -.TP -.B \-q [filename/wildcard] -see \-\-quiet - -.TP -.B \-\-rsync [filename/wildcard] -copies sisu output files to remote host using rsync. This requires that -sisurc.yml has been provided with information on hostname and username, and -that you have your "keys" and ssh agent in place. Note the behavior of rsync -different if \-R is used with other flags from if used alone. Alone the rsync -\-\-delete parameter is sent, useful for cleaning the remote directory (when -\-R is used together with other flags, it is not). Also see \-\-scp. Alias \-R - -.TP -.B \-R [filename/wildcard] -see \-\-rsync - -.TP -.B \-r [filename/wildcard] -see \-\-scp - -.TP -.B \-\-sample\-search\-form [\-\-webserv=webrick] -generate examples of (naive) cgi search form for sqlite and pgsql depends on -your already having used sisu to populate an sqlite and/or pgsql database, (the -sqlite version scans the output directories for existing sisu_sqlite databases, -so it is first necessary to create them, before generating the search form) see -\-d \-D and the database section below. If the optional parameter -\-\-webserv=webrick is passed, the cgi examples created will be set up to use -the default port set for use by the webrick server, (otherwise the port is left -blank and the system setting used, usually 80). The samples are dumped in the -present work directory which must be writable, (with screen instructions given -that they be copied to the cgi\-bin directory). \-Fv (in addition to the above) -provides some information on setting up hyperestraier for sisu. Alias \-F - -.TP -.B \-\-scp [filename/wildcard] -copies sisu output files to remote host using scp. This requires that -sisurc.yml has been provided with information on hostname and username, and -that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r - -.TP -.B \-\-sqlite \-\-[instruction] [filename] -database type default set to sqlite, (for which \-\-sqlite may be used -instead) or to specify another database \-\-db\-[pgsql, \ sqlite] (however see -\-D) possible instructions include: \-\-createdb; \-\-create; \-\-dropall; -\-\-import [filename]; \-\-update [filename]; \-\-remove [filename]; see -database section below. Alias \-d - -.TP -.B \-\-sisupod -produces a sisupod a zipped sisu directory of markup files including sisu -markup source files and the directories local configuration file, images and -skins. Note: this only includes the configuration files or skins contained in - \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this -option is tested only with zsh). Alias \-S - -.TP -.B \-\-sisupod [filename/wildcard] -produces a zipped file of the prepared document specified along with -associated images, by default named sisupod.zip they may alternatively be named -with the filename extension \.ssp This provides a quick way of gathering the -relevant parts of a sisu document which can then for example be emailed. A -sisupod includes sisu markup source file, (along with associated documents if a -master file, or available in multilingual versions), together with related -images and skin. -.B SiSU -commands can be run directly against a sisupod contained in a local -directory, or provided as a url on a remote site. As there is a security issue -with skins provided by other users, they are not applied unless the flag -\-\-trust or \-\-trusted is added to the command instruction, it is recommended -that file that are not your own are treated as untrusted. The directory -structure of the unzipped file is understood by sisu, and sisu commands can be -run within it. Note: if you wish to send multiple files, it quickly becomes -more space efficient to zip the sisu markup directory, rather than the -individual files for sending). See the \-S option without [filename/wildcard]. -Alias \-S - -.TP -.B \-\-source [filename/wildcard] -copies sisu markup file to output directory. Alias \-s - -.TP -.B \-S -see \-\-sisupod - -.TP -.B \-S [filename/wildcard] -see \-\-sisupod - -.TP -.B \-s [filename/wildcard] -see \-\-source - -.TP -.B \-\-texinfo [filename/wildcard] -produces texinfo and info file, (view with pinfo). Alias \-I - -.TP -.B \-\-txt [filename/wildcard] -produces plaintext with Unix linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them [ \ \-A -\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for -footnotes at the end of each paragraph \-\-unix for unix linefeed (default) -\-\-msdos for msdos linefeed). Alias \-t - -.TP -.B \-T [filename/wildcard \ (*.termsheet.rb)] -standard form document builder, preprocessing feature - -.TP -.B \-t [filename/wildcard] -see \-\-txt - -.TP -.B \-\-urls [filename/wildcard] -prints url output list/map for the available processing flags options and -resulting files that could be requested, (can be used to get a list of -processing options in relation to a file, together with information on the -output that would be produced), \-u provides url output mapping for those flags -requested for processing. The default assumes sisu_webrick is running and -provides webrick url mappings where appropriate, but these can be switched to -file system paths in sisurc.yml. Alias \-U - -.TP -.B \-U [filename/wildcard] -see \-\-urls - -.TP -.B \-u [filename/wildcard] -provides url mapping of output files for the flags requested for processing, -also see \-U - -.TP -.B \-\-v1 [filename/wildcard] -invokes the sisu v1 document parser/generator. For use with sisu v1 markup -documents. (Markup conversion to v2 involves the modification of document -headers) - -.TP -.B \-\-v2 [filename/wildcard] -invokes the sisu v2 document parser/generator. This is the default and is -normally omitted. - -.TP -.B \-\-verbose [filename/wildcard] -provides verbose output of what is being generated, where output is placed -(and error messages if any), as with \-u flag provides a url mapping of files -created for each of the processing flag requests. Alias \-v - -.TP -.B \-V -on its own, provides -.B SiSU -version and environment information (sisu \-\-help env) - -.TP -.B \-V [filename/wildcard] -even more verbose than the \-v flag. - -.TP -.B \-v -on its own, provides -.B SiSU -version information - -.TP -.B \-v [filename/wildcard] -see \-\-verbose - -.TP -.B \-\-webrick -starts ruby's webrick webserver points at sisu output directories, the -default port is set to 8081 and can be changed in the resource configuration -files. [tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html -\ output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \ -\-H \ ; \ also, \ note \ \-F \ webrick \ ]. Alias \-W - -.TP -.B \-W -see \-\-webrick - -.TP -.B \-\-wordmap [filename/wildcard] -see \-\-concordance - -.TP -.B \-w [filename/wildcard] -see \-\-concordance - -.TP -.B \-\-xhtml [filename/wildcard] -produces xhtml/XML output for browser viewing (sax parsing). Alias \-b - -.TP -.B \-\-xml\-dom [filename/wildcard] -produces XML output with deep document structure, in the nature of dom. Alias -\-X - -.TP -.B \-\-xml\-sax [filename/wildcard] -produces XML output shallow structure (sax parsing). Alias \-x - -.TP -.B \-X [filename/wildcard] -see \-\-xml\-dom - -.TP -.B \-x [filename/wildcard] -see \-\-xml\-sax - -.TP -.B \-Y [filename/wildcard] -produces a short sitemap entry for the document, based on html output and the -sisu_manifest. \-\-sitemaps generates/updates the sitemap index of existing -sitemaps. (Experimental, [g,y,m \ announcement \ this \ week]) - -.TP -.B \-y [filename/wildcard] -produces an html summary of output generated (hyperlinked to content) and -document specific metadata (sisu_manifest.html). This step is assumed for most -processing flags. - -.TP -.B \-\-zap [filename/wildcard] -Zap, if used with other processing flags deletes output files of the type -about to be processed, prior to processing. If \-Z is used as the lone -processing related flag (or in conjunction with a combination of \-[mMvVq]), -will remove the related document output directory. Alias \-Z - -.TP -.B \-Z [filename/wildcard] -see \-\-zap - -.SH -3. COMMAND LINE MODIFIERS -.BR - -.TP -.B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html or -LaTeX/pdf output. - -.TP -.B \-\-no\-annotate -strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus -sign - -.TP -.B \-\-no\-asterisk -strips output text of editor endnotes[^*2] denoted by asterisk sign - -.TP -.B \-\-no\-dagger -strips output text of editor endnotes[^+1] denoted by dagger/plus sign - -.SH -4. DATABASE COMMANDS -.BR - -.BR -dbi \- database interface - -.BR -\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite -\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] - -.TP -.B \-\-pg \-v \-\-createall -initial step, creates required relations (tables, indexes) in existing -postgresql database (a database should be created manually and given the same -name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \ -sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb -initially NOTE: at the present time for postgresql it may be necessary to -manually create the database. The command would be 'createdb [database \ name]' -where database name would be SiSU_[present \ working \ directory \ name \ -(without \ path)]. Please use only alphanumerics and underscores. - -.TP -.B \-\-pg \-v \-\-import -[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv -\ \-\-import \ sqlite \ equivalent] - -.TP -.B \-\-pg \-v \-\-update -[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) -[ \ \-dv \ \-\-update \ sqlite \ equivalent] - -.TP -.B \-\-pg \-\-remove -[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d -\ \-\-remove \ sqlite \ equivalent] - -.TP -.B \-\-pg \-\-dropall -kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ -\-\-dropall \ sqlite \ equivalent] - -.BR -The \-v is for verbose output. - -.SH -5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS -.BR - -.TP -.B \-\-update [filename/wildcard] -Checks existing file output and runs the flags required to update this -output. This means that if only html and pdf output was requested on previous -runs, only the \-hp files will be applied, and only these will be generated -this time, together with the summary. This can be very convenient, if you offer -different outputs of different files, and just want to do the same again. - -.TP -.B \-0 to \-5 [filename \ or \ wildcard] -Default shorthand mappings (note that the defaults can be changed/configured -in the sisurc.yml file): - -.TP -.B \-0 -\-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ -options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]'] - -.TP -.B \-1 -\-mhewpy - -.TP -.B \-2 -\-mhewpaoy - -.TP -.B \-3 -\-mhewpAobxXyY - -.TP -.B \-4 -\-mhewpAobxXDyY \-\-import - -.TP -.B \-5 -\-mhewpAobxXDyY \-\-update - -.BR -add \-v for verbose mode and \-c for color, e.g. sisu \-2vc [filename \ or \ -wildcard] - -.BR -consider \-u for appended url info or \-v for verbose output - -.SH -5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING - -.BR -In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h -cisg.sst" or "sisu \-h *.{sst,ssm}" to produce html version of all documents. - -.BR -Running sisu (alone without any flags, filenames or wildcards) brings up the -interactive help, as does any sisu command that is not recognised. Enter to -escape. - -.SH -6. HELP -.BR - -.SH -6.1 SISU MANUAL - -.BR -The most up to date information on sisu should be contained in the sisu_manual, -available at: - -.BR - <http://sisudoc.org/sisu/sisu_manual/> - -.BR -The manual can be generated from source, found respectively, either within the -.B SiSU -tarball or installed locally at: - -.BR - ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ - -.BR - /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/ - -.BR -move to the respective directory and type e.g.: - -.BR - sisu sisu_manual.ssm - -.SH -6.2 SISU MAN PAGES - -.BR -If -.B SiSU -is installed on your system usual man commands should be available, try: - -.BR - man sisu - -.BR - man sisu_markup - -.BR - man sisu_commands - -.BR -Most -.B SiSU -man pages are generated directly from sisu documents that are used to prepare -the sisu manual, the sources files for which are located within the -.B SiSU -tarball at: - -.BR - ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ - -.BR -Once installed, directory equivalent to: - -.BR - /usr/share/doc/sisu/sisu_manual/ - -.BR -Available man pages are converted back to html using man2html: - -.BR - /usr/share/doc/sisu/v2/html/ - -.BR - ./data/doc/sisu/v2/html/ - -.BR -An online version of the sisu man page is available here: - -.BR -* various sisu man pages <http://www.jus.uio.no/sisu/man/> [^8] - -.BR -* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^9] - -.SH -6.3 SISU BUILT\-IN INTERACTIVE HELP - -.BR -This is particularly useful for getting the current sisu setup/environment -information: - -.BR - sisu \-\-help - -.BR - sisu \-\-help [subject] - -.BR - sisu \-\-help commands - -.BR - sisu \-\-help markup - -.BR - sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \ - setup \ with \ regard \ to \ sisu] - -.BR - sisu \-V [environment \ information, \ same \ as \ above \ command] - -.BR - sisu (on its own provides version and some help information) - -.BR -Apart from real\-time information on your current configuration the -.B SiSU -manual and man pages are likely to contain more up\-to\-date information than -the sisu interactive help (for example on commands and markup). - -.BR -NOTE: Running the command sisu (alone without any flags, filenames or -wildcards) brings up the interactive help, as does any sisu command that is not -recognised. Enter to escape. - -.SH -6.4 HELP SOURCES - -.BR -For lists of alternative help sources, see: - -.BR -.B man page - -.BR - man sisu_help_sources - -.BR -.B man2html - -.BR - /usr/share/doc/sisu/v2/html/sisu.1.html - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.SH -7. INTRODUCTION TO SISU MARKUP[^10] -.BR - -.SH -7.1 SUMMARY - -.BR -.B SiSU -source documents are plaintext (UTF\-8)[^11] files - -.BR -All paragraphs are separated by an empty line. - -.BR -Markup is comprised of: - -.BR -* at the top of a document, the document header made up of semantic meta\-data -about the document and if desired additional processing instructions (such an -instruction to automatically number headings from a particular level down) - -.BR -* followed by the prepared substantive text of which the most important single -characteristic is the markup of different heading levels, which define the -primary outline of the document structure. Markup of substantive text includes: - -.BR - * heading levels defines document structure - -.BR - * text basic attributes, italics, bold etc. - -.BR - * grouped text (objects), which are to be treated differently, such as code - blocks or poems. - -.BR - * footnotes/endnotes - -.BR - * linked text and images - -.BR - * paragraph actions, such as indent, bulleted, numbered\-lists, etc. - -.BR -Some interactive help on markup is available, by typing sisu and selecting -markup or sisu \-\-help markup - -.BR -To check the markup in a file: - -.BR - sisu \-\-identify [filename].sst - -.BR -For brief descriptive summary of markup history - -.BR - sisu \-\-query\-history - -.BR -or if for a particular version: - -.BR - sisu \-\-query\-0.38 - -.SH -7.2 MARKUP EXAMPLES - -.SH -7.2.1 ONLINE - -.BR -Online markup examples are available together with the respective outputs -produced from <http://www.jus.uio.no/sisu/SiSU/examples.html> or from -<http://www.jus.uio.no/sisu/sisu_examples/> - -.BR -There is of course this document, which provides a cursory overview of sisu -markup and the respective output produced: -<http://www.jus.uio.no/sisu/sisu_markup/> - -.BR -Some example marked up files are available as html with syntax highlighting for -viewing: <http://www.jus.uio.no/sisu/sample/syntax> - -.BR -an alternative presentation of markup syntax: -<http://www.jus.uio.no/sisu/sample/on_markup.txt> - -.SH -7.2.2 INSTALLED - -.BR -With -.B SiSU -installed sample skins may be found in: -/usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if -sisu\-markup\-samples is installed also under: -/usr/share/doc/sisu/sisu_markup_samples/non\-free - -.SH -8. MARKUP OF HEADERS -.BR - -.BR -Headers contain either: semantic meta\-data about a document, which can be used -by any output module of the program, or; processing instructions. - -.BR -Note: the first line of a document may include information on the markup -version used in the form of a comment. Comments are a percentage mark at the -start of a paragraph (and as the first character in a line of text) followed by -a space and the comment: - - -.nf - % this would be a comment -.fi - -.SH -8.1 SAMPLE HEADER - -.BR -This current document is loaded by a master document that has a header similar -to this one: - - -.nf - % SiSU master 2.0 - @title: SiSU - :subtitle: Manual - @creator: :author: Amissah, Ralph - @rights: Copyright (C) Ralph Amissah 2007, License GPL 3 - @classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, - electronic document, electronic citation, data structure, - citation systems, search - % used_by: manual - @date: :published: 2008\-05\-22 - :created: 2002\-08\-28 - :issued: 2002\-08\-28 - :available: 2002\-08\-28 - :modified: 2010\-03\-03 - @make: :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu \- documents: markup, structuring, publishing - in multiple standard formats, and search; - synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ] - . sisu \ [\-Ddcv] \ [instruction] - . sisu \ [\-CcFLSVvW] - . sisu \-\-v2 \ [operations] - . sisu \-\-v1 \ [operations] - @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ -.fi - -.SH -8.2 AVAILABLE HEADERS - -.BR -Header tags appear at the beginning of a document and provide meta information -on the document (such as the Dublin Core), or information as to how the -document as a whole is to be processed. All header instructions take either the -form @headername: or 0~headername. All Dublin Core meta tags are available - -.BR -.B @indentifier: -information or instructions - -.BR -where the "identifier" is a tag recognised by the program, and the -"information" or "instructions" belong to the tag/indentifier specified - -.BR -Note: a header where used should only be used once; all headers apart from -@title: are optional; the @structure: header is used to describe document -structure, and can be useful to know. - -.BR -This is a sample header - - -.nf - % SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version] -.fi - -.nf - @title: \ [title \ text] \ [this \ header \ is \ the \ only \ one \ that \ is \ mandatory] - :subtitle: \ [subtitle \ if \ any] - :language: English -.fi - -.nf - @creator: :author: \ [Lastname, \ First \ names] - :illustrator: \ [Lastname, \ First \ names] - :translator: \ [Lastname, \ First \ names] - :prepared_by: \ [Lastname, \ First \ names] -.fi - -.nf - @date: :published: \ [year \ or \ yyyy\-mm\-dd] - :created: \ [year \ or \ yyyy\-mm\-dd] - :issued: \ [year \ or \ yyyy\-mm\-dd] - :available: \ [year \ or \ yyyy\-mm\-dd] - :modified: \ [year \ or \ yyyy\-mm\-dd] - :valid: \ [year \ or \ yyyy\-mm\-dd] - :added_to_site: \ [year \ or \ yyyy\-mm\-dd] - :translated: \ [year \ or \ yyyy\-mm\-dd] -.fi - -.nf - @rights: :copyright: Copyright (C) \ [Year \ and \ Holder] - :license: \ [Use \ License \ granted] - :text: \ [Year \ and \ Holder] - :translation: \ [Name, \ Year] - :illustrations: \ [Name, \ Year] -.fi - -.nf - @classify: - :topic_register: SiSU:markup sample:book;book:novel:fantasy - :type: - :subject: - :description: - :keywords: - :abstract: - :isbn: \ [ISBN] - :loc: \ [Library \ of \ Congress \ classification] - :dewey: \ [Dewey \ classification - :pg: \ [Project \ Gutenberg \ text \ number] -.fi - -.nf - @links: { SiSU }http://www.jus.uio.no/sisu/ - { FSF }http://www.fsf.org -.fi - -.nf - @make: - :skin: skin_name - [skins change default settings related to the appearance of documents generated] - :num_top: 1 - :headings: \ [text \ to \ match \ for \ each \ level - (e.g. PART; Chapter; Section; Article; - or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) - :breaks: new=:C; break=1 - :promo: sisu, ruby, sisu_search_libre, open_society - :bold: [regular expression of words/phrases to be made bold] - :italics: \ [regular \ expression \ of \ words/phrases \ to \ italicise] -.fi - -.nf - @original: :language: \ [language] -.fi - -.nf - @notes: :comment: - :prefix: \ [prefix \ is \ placed \ just \ after \ table \ of \ contents] -.fi - -.SH -9. MARKUP OF SUBSTANTIVE TEXT -.BR - -.SH -9.1 HEADING LEVELS - -.BR -Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section -headings, followed by other heading levels, and 1 \-6 being headings followed -by substantive text or sub\-headings. :A~ usually the title :A~? conditional -level 1 heading (used where a stand\-alone document may be imported into -another) - -.BR -.B :A~ [heading \ text] -Top level heading [this \ usually \ has \ similar \ content \ to \ the \ -title \ @title: \ ] NOTE: the heading levels described here are in 0.38 -notation, see heading - -.BR -.B :B~ [heading \ text] -Second level heading [this \ is \ a \ heading \ level \ divider] - -.BR -.B :C~ [heading \ text] -Third level heading [this \ is \ a \ heading \ level \ divider] - -.BR -.B 1~ [heading \ text] -Top level heading preceding substantive text of document or sub\-heading 2, -the heading level that would normally be marked 1. or 2. or 3. etc. in a -document, and the level on which sisu by default would break html output into -named segments, names are provided automatically if none are given (a number), -otherwise takes the form 1~my_filename_for_this_segment - -.BR -.B 2~ [heading \ text] -Second level heading preceding substantive text of document or sub\-heading -3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 -etc. in a document. - -.BR -.B 3~ [heading \ text] -Third level heading preceding substantive text of document, that would -normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document - - -.nf - 1~filename level 1 heading, - % the primary division such as Chapter that is followed by substantive text, - % and may be further subdivided (this is the level on which by default html - % segments are made) -.fi - -.SH -9.2 FONT ATTRIBUTES - -.BR -.B markup example: - - -.nf - normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\- #{monospace}# -.BR - normal text -.BR - !{emphasis}! -.BR - *{bold text}* -.BR - _{underscore}_ -.BR - /{italics}/ -.BR - "{citation}" -.BR - ^{superscript}^ -.BR - ,{subscript}, -.BR - +{inserted text}+ -.BR - \-{strikethrough}\- -.BR - #{monospace}# -.fi - -.BR -.B resulting output: - -.BR -normal text -.B emphasis -.B bold text -.I underscore -.I italics -"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- monospace - -.BR -normal text - -.BR -.B emphasis -[note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics -\ or \ underscore] - -.BR -.B bold text - -.BR -.I italics - -.BR -.I underscore - -.BR -"citation" - -.BR -^superscript^ - -.BR -[subscript] - -.BR -++inserted text++ - -.BR -\-\-strikethrough\-\- - -.BR -monospace - -.SH -9.3 INDENTATION AND BULLETS - -.BR -.B markup example: - - -.nf - ordinary paragraph -.BR - _1 indent paragraph one step -.BR - _2 indent paragraph two steps -.BR - _9 indent paragraph nine steps -.fi - - -.B resulting output: - -.BR -ordinary paragraph - -.BR - indent paragraph one step - -.BR - indent paragraph two steps - -.BR - indent paragraph nine steps - -.BR -.B markup example: - - -.nf - _* bullet text -.BR - _1* bullet text, first indent -.BR - _2* bullet text, two step indent -.fi - -.BR -.B resulting output: - -.BR -* bullet text - -.BR - * bullet text, first indent - -.BR - * bullet text, two step indent - -.BR -Numbered List (not to be confused with headings/titles, (document structure)) - -.BR -.B markup example: - - -.nf - # numbered list numbered list 1., 2., 3, etc. -.BR - _# numbered list numbered list indented a., b., c., d., etc. -.fi - -.SH -9.4 FOOTNOTES / ENDNOTES - -.BR -Footnotes and endnotes not distinguished in markup. They are automatically -numbered. Depending on the output file format (html, EPUB, odf, pdf etc.), the -document output selected will have either footnotes or endnotes. - -.BR -.B markup example: - - -.nf - ~{ a footnote or endnote }~ -.fi - -.BR -.B resulting output: - -.BR -[^12] - -.BR -.B markup example: - - -.nf - normal text~{ self contained endnote marker & endnote in one }~ continues -.fi - -.BR -.B resulting output: - -.BR -normal text[^13] continues - -.BR -.B markup example: - - -.nf - normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues -.BR - normal text ~{** another unnumbered asterisk footnote/endnote }~ continues -.fi - -.BR -.B resulting output: - -.BR -normal text [^*] continues - -.BR -normal text [^**] continues - -.BR -.B markup example: - - -.nf - normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues -.BR - normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues -.fi - -.BR -.B resulting output: - -.BR -normal text [^*3] continues - -.BR -normal text [^+2] continues - -.BR -.B Alternative endnote pair notation for footnotes/endnotes: - - -.nf - % note the endnote marker \"~^\" -.BR - normal text~^ continues -.BR - ^~ endnote text following the paragraph in which the marker occurs -.fi - -.BR -the standard and pair notation cannot be mixed in the same document - -.SH -9.5 LINKS - -.SH -9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS - -.BR -urls found within text are marked up automatically. A url within text is -automatically hyperlinked to itself and by default decorated with angled -braces, unless they are contained within a code block (in which case they are -passed as normal text), or escaped by a preceding underscore (in which case the -decoration is omitted). - -.BR -.B markup example: - - -.nf - normal text http://www.jus.uio.no/sisu continues -.fi - -.BR -.B resulting output: - -.BR -normal text <http://www.jus.uio.no/sisu> continues - -.BR -An escaped url without decoration - -.BR -.B markup example: - - -.nf - normal text _http://www.jus.uio.no/sisu continues - deb http://www.jus.uio.no/sisu/archive unstable main non\-free -.fi - -.BR -.B resulting output: - -.BR -normal text <_http://www.jus.uio.no/sisu> continues - -.BR -deb <_http://www.jus.uio.no/sisu/archive> unstable main non\-free - -.BR -where a code block is used there is neither decoration nor hyperlinking, code -blocks are discussed later in this document - -.BR -.B resulting output: - - -.nf - deb http://www.jus.uio.no/sisu/archive unstable main non\-free -.BR - deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free -.fi - -.BR -To link text or an image to a url the markup is as follows - -.BR -.B markup example: - - -.nf - about { SiSU }http://url.org markup -.fi - -.SH -9.5.2 LINKING TEXT - -.BR -.B resulting output: - -.BR -about SiSU <http://www.jus.uio.no/sisu/> markup - -.BR -A shortcut notation is available so the url link may also be provided -automatically as a footnote - -.BR -.B markup example: - - -.nf - about {~^ SiSU }http://url.org markup -.fi - -.BR -.B resulting output: - -.BR -abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup - -.SH -9.5.3 LINKING IMAGES - -.BR -.B markup example: - - -.nf - { tux.png 64x80 }image -.BR - % various url linked images -.BR - {tux.png 64x80 \"a better way\" }http://www.jus.uio.no/sisu/ -.BR -.BR - {GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian and Ruby\" }http://www.jus.uio.no/sisu/ -.BR -.BR - {~^ ruby_logo.png \"Ruby\" }http://www.ruby\-lang.org/en/ -.BR -.BR -.fi - -.BR -.B resulting output: - -.BR -[ tux.png ] - -.BR -tux.png 64x80 \"Gnu/Linux \- a better way\" <http://www.jus.uio.no/sisu/> - -.BR -[ \ ruby_logo \ (png \ missing) \ ] [^15] - -.BR -GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian -and Ruby\" <http://www.jus.uio.no/sisu/> - -.BR -.B linked url footnote shortcut - - -.nf - {~^ \ [text \ to \ link] }http://url.org - % maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~ - % which produces hyper\-linked text within a document/paragraph, - with an endnote providing the url for the text location used in the hyperlink -.fi - - -.nf - text marker *~name -.fi - -.BR -note at a heading level the same is automatically achieved by providing names -to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of -auto\-heading numbering, without further intervention. - -.SH -9.6 GROUPED TEXT - -.SH -9.6.1 TABLES - -.BR -Tables may be prepared in two either of two forms - -.BR -.B markup example: - - -.nf - table{ c3; 40; 30; 30; - This is a table - this would become column two of row one - column three of row one is here - And here begins another row - column two of row two - column three of row two, and so on - }table -.fi - -.BR -.B resulting output: - - \ [table \ omitted, \ see \ other \ document \ formats] - -.BR -a second form may be easier to work with in cases where there is not much -information in each column - -.BR -.B markup example: -[^16] - - -.nf - !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 - {table~h 24; 12; 12; 12; 12; 12; 12;} - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 - Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 - Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 - Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 - No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 - No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 - \\* Contributed at least ten times; \\** at least 5 times in last month; \\*\** more than 100 times in last month. -.fi - -.BR -.B resulting output: - -.BR -.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 - - \ [table \ omitted, \ see \ other \ document \ formats] - -.BR -* Contributed at least ten times; ** at least 5 times in last month; *** more -than 100 times in last month. - -.SH -9.6.2 POEM - -.BR -.B basic markup: - - -.nf - poem{ - Your poem here - }poem - Each verse in a poem is given a separate object number. -.fi - -.BR -.B markup example: - - -.nf - poem{ - \`Fury said to a - mouse, That he - met in the - house, - \"Let us - both go to - law: I will - prosecute - YOU. \-\-Come, - I\'ll take no - denial; We - must have a - trial: For - really this - morning I\'ve - nothing - to do.\" - Said the - mouse to the - cur, \"Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath.\" - \"I\'ll be - judge, I\'ll - be jury,\" - Said - cunning - old Fury: - \"I\'ll - try the - whole - cause, - and - condemn - you - to - death.\"\' - }poem -.fi - -.BR -.B resulting output: - - \'Fury said to a -.BR - mouse, That he -.BR - met in the -.BR - house, -.BR - \"Let us -.BR - both go to -.BR - law: I will -.BR - prosecute -.BR - YOU. \-\-Come, -.BR - I\'ll take no -.BR - denial; We -.BR - must have a -.BR - trial: For -.BR - really this -.BR - morning I\'ve -.BR - nothing -.BR - to do.\" -.BR - Said the -.BR - mouse to the -.BR - cur, \"Such -.BR - a trial, -.BR - dear Sir, -.BR - With -.BR - no jury -.BR - or judge, -.BR - would be -.BR - wasting -.BR - our -.BR - breath.\" -.BR - \"I\'ll be -.BR - judge, I\'ll -.BR - be jury,\" -.BR - Said -.BR - cunning -.BR - old Fury: -.BR - \"I\'ll -.BR - try the -.BR - whole -.BR - cause, -.BR - and -.BR - condemn -.BR - you -.BR - to -.BR - death.\"\' -.BR - -.SH -9.6.3 GROUP - -.BR -.B basic markup: - - -.nf - group{ -.BR - Your grouped text here -.BR - }group -.BR - A group is treated as an object and given a single object number. -.fi - -.BR -.B markup example: - - -.nf - group{ -.BR - \'Fury said to a - mouse, That he - met in the - house, - \"Let us - both go to - law: I will - prosecute - YOU. \-\-Come, - I\'ll take no - denial; We - must have a - trial: For - really this - morning I\'ve - nothing - to do.\" - Said the - mouse to the - cur, \"Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath.\" - \"I\'ll be - judge, I\'ll - be jury,\" - Said - cunning - old Fury: - \"I\'ll - try the - whole - cause, - and - condemn - you - to - death.\"\' - }group -.fi - -.BR -.B resulting output: - - \'Fury said to a -.BR - mouse, That he -.BR - met in the -.BR - house, -.BR - \"Let us -.BR - both go to -.BR - law: I will -.BR - prosecute -.BR - YOU. \-\-Come, -.BR - I\'ll take no -.BR - denial; We -.BR - must have a -.BR - trial: For -.BR - really this -.BR - morning I\'ve -.BR - nothing -.BR - to do.\" -.BR - Said the -.BR - mouse to the -.BR - cur, \"Such -.BR - a trial, -.BR - dear Sir, -.BR - With -.BR - no jury -.BR - or judge, -.BR - would be -.BR - wasting -.BR - our -.BR - breath.\" -.BR - \"I\'ll be -.BR - judge, I\'ll -.BR - be jury,\" -.BR - Said -.BR - cunning -.BR - old Fury: -.BR - \"I\'ll -.BR - try the -.BR - whole -.BR - cause, -.BR - and -.BR - condemn -.BR - you -.BR - to -.BR - death.\"\' -.BR - -.SH -9.6.4 CODE - -.BR -Code tags are used to escape regular sisu markup, and have been used -extensively within this document to provide examples of -.B SiSU -markup. You cannot however use code tags to escape code tags. They are -however used in the same way as group or poem tags. - -.BR -A code\-block is treated as an object and given a single object number. [an \ -option \ to \ number \ each \ line \ of \ code \ may \ be \ considered \ at \ -some \ later \ time] - -.BR -.B use of code tags instead of poem compared, resulting output: - - -.nf - \'Fury said to a - mouse, That he - met in the - house, - \"Let us - both go to - law: I will - prosecute - YOU. \-\-Come, - I\'ll take no - denial; We - must have a - trial: For - really this - morning I\'ve - nothing - to do.\" - Said the - mouse to the - cur, \"Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath.\" - \"I\'ll be - judge, I\'ll - be jury,\" - Said - cunning - old Fury: - \"I\'ll - try the - whole - cause, - and - condemn - you - to - death.\"\' -.fi - -.SH -9.7 BOOK INDEX - -.BR -To make an index append to paragraph the book index term relates to it, using -an equal sign and curly braces. - -.BR -Currently two levels are provided, a main term and if needed a sub\-term. -Sub\-terms are separated from the main term by a colon. - - -.nf - Paragraph containing main term and sub\-term. - ={Main term:sub\-term} -.fi - -.BR -The index syntax starts on a new line, but there should not be an empty line -between paragraph and index markup. - -.BR -The structure of the resulting index would be: - - -.nf - Main term, 1 - sub\-term, 1 -.fi - -.BR -Several terms may relate to a paragraph, they are separated by a semicolon. If -the term refers to more than one paragraph, indicate the number of paragraphs. - - -.nf - Paragraph containing main term, second term and sub\-term. - ={first term; second term: sub\-term} -.fi - -.BR -The structure of the resulting index would be: - - -.nf - First term, 1, - Second term, 1, - sub\-term, 1 -.fi - -.BR -If multiple sub\-terms appear under one paragraph, they are separated under the -main term heading from each other by a pipe symbol. - - -.nf - Paragraph containing main term, second term and sub\-term. - ={Main term:sub\-term+1|second sub\-term - A paragraph that continues discussion of the first sub\-term -.fi - -.BR -The plus one in the example provided indicates the first sub\-term spans one -additional paragraph. The logical structure of the resulting index would be: - - -.nf - Main term, 1, - sub\-term, 1\-3, - second sub\-term, 1, -.fi - -.SH -10. COMPOSITE DOCUMENTS MARKUP -.BR - -.BR -It is possible to build a document by creating a master document that requires -other documents. The documents required may be complete documents that could be -generated independently, or they could be markup snippets, prepared so as to be -easily available to be placed within another text. If the calling document is a -master document (built from other documents), it should be named with the -suffix -.B \.ssm -Within this document you would provide information on the other documents -that should be included within the text. These may be other documents that -would be processed in a regular way, or markup bits prepared only for inclusion -within a master document -.B \.sst -regular markup file, or -.B \.ssi -(insert/information) A secondary file of the composite document is built -prior to processing with the same prefix and the suffix -.B \._sst - -.BR -basic markup for importing a document into a master document - - -.nf - << filename1.sst - << filename2.ssi -.fi - -.BR -The form described above should be relied on. Within the Vim editor it results -in the text thus linked becoming hyperlinked to the document it is calling in -which is convenient for editing. Alternative markup for importation of -documents under consideration, and occasionally supported have been. - - -.nf - << filename.ssi - <<{filename.ssi} - % using textlink alternatives - << |filename.ssi|@|^| -.fi - -.SH -MARKUP SYNTAX HISTORY -.BR - -.SH -11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX -.BR - -.BR -0.38 is substantially current, depreciated 0.16 supported, though file names -were changed at 0.37 - -.BR -* sisu \-\-query=[sisu \ version \ [0.38] or \'history] - -.BR -provides a short history of changes to -.B SiSU -markup - -.BR -.B 0.57 -(2007w34/4) -.B SiSU -0.57 is the same as 0.42 with the introduction of some a shortcut to use the -headers @title and @creator in the first heading [expanded \ using \ the \ -contents \ of \ the \ headers \ @title: \ and \ @author:] - - -.nf - :A~ @title by @author -.fi - -.BR -.B 0.52 -(2007w14/6) declared document type identifier at start of text/document: - -.BR - .B SiSU -0.52 - -.BR -or, backward compatible using the comment marker: - -.BR - % -.B SiSU -0.38 - -.BR -variations include \' -.B SiSU -(text|master|insert) [version]\' and \'sisu\-[version]\' - -.BR -.B 0.51 -(2007w13/6) skins changed (simplified), markup unchanged - -.BR -.B 0.42 -(2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author - -.BR -.B SiSU -0.42 is the same as 0.38 with the introduction of some additional endnote -types, - -.BR -Introduces some variations on endnotes, in particular the use of the asterisk - - -.nf - ~{* for example for describing an author }~ and ~{** for describing a second author }~ -.fi - -.BR -* for example for describing an author - -.BR -** for describing a second author - -.BR -and - - -.nf - ~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~ -.fi - -.BR -which numerically increments an asterisk and plus respectively - -.BR -*1 my note +1 another note - -.BR -.B 0.38 -(2006w15/7) introduced new/alternative notation for headers, e.g. @title: -(instead of 0~title), and accompanying document structure markup, -:A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) - -.BR -.B SiSU -0.38 introduced alternative experimental header and heading/structure -markers, - - -.nf - @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ -.fi - -.BR -as the equivalent of: - - -.nf - 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ -.fi - -.BR -The internal document markup of -.B SiSU -0.16 remains valid and standard Though note that -.B SiSU -0.37 introduced a new file naming convention - -.BR -.B SiSU -has in effect two sets of levels to be considered, using 0.38 notation A\-C -headings/levels, pre\-ordinary paragraphs /pre\-substantive text, and 1\-3 -headings/levels, levels which are followed by ordinary text. This may be -conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, -in effect: A must exist, optional B and C may follow in sequence (not strict) 1 -must exist, optional 2 and 3 may follow in sequence i.e. there are two -independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard -notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 -alternative makes explicit an aspect of structuring documents in -.B SiSU -that is not otherwise obvious to the newcomer (though it appears more -complicated, is more in your face and likely to be understood fairly quickly); -the substantive text follows levels 1,2,3 and it is \'nice\' to do most work in -those levels - -.BR -.B 0.37 -(2006w09/7) introduced new file naming convention, \.sst (text), \.ssm -(master), \.ssi (insert), markup syntax unchanged - -.BR -.B SiSU -0.37 introduced new file naming convention, using the file extensions \.sst - \.ssm and \.ssi to replace \.s1 \.s2 \.s3 \.r1 \.r2 \.r3 and \.si - -.BR -this is captured by the following file \'rename\' instruction: - - -.nf - rename \'s/\.s[123]$/\.sst/\' *.s{1,2,3} - rename \'s/\.r[123]$/\.ssm/\' *.r{1,2,3} - rename \'s/\.si$/\.ssi/\' *.si -.fi - -.BR -The internal document markup remains unchanged, from -.B SiSU -0.16 - -.BR -.B 0.35 -(2005w52/3) sisupod, zipped content file introduced - -.BR -.B 0.23 -(2005w36/2) utf\-8 for markup file - -.BR -.B 0.22 -(2005w35/3) image dimensions may be omitted if rmagick is available to be -relied upon - -.BR -.B 0.20.4 -(2005w33/4) header 0~links - -.BR -.B 0.16 -(2005w25/2) substantial changes introduced to make markup cleaner, header -0~title type, and headings [1\-6]~ introduced, also percentage sign (%) at -start of a text line as comment marker - -.BR -.B SiSU -0.16 (0.15 development branch) introduced the use of - -.BR -the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ - -.BR -in place of the 0.1 header, heading/structure notation - -.BR -.B SiSU -0.1 headers and headings structure represented by header 0{~ and -headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ - -.SH -12. SISU FILETYPES -.BR - -.BR -.B SiSU -has plaintext and binary filetypes, and can process either type of document. - -.SH -12.1 \.SST \.SSM \.SSI MARKED UP PLAIN TEXT - -.BR -.B SiSU -documents are prepared as plain\-text (utf\-8) files with -.B SiSU -markup. They may make reference to and contain images (for example), which -are stored in the directory beneath them _sisu/image. -.B SiSU -plaintext markup files are of three types that may be distinguished by the -file extension used: regular text \.sst; master documents, composite documents -that incorporate other text, which can be any regular text or text insert; and -inserts the contents of which are like regular text except these are marked - \.ssi and are not processed. - -.BR -.B SiSU -processing can be done directly against a sisu documents; which may be -located locally or on a remote server for which a url is provided. - -.BR -.B SiSU -source markup can be shared with the command: - -.BR - sisu \-s [filename] - -.SH -12.1.1 SISU TEXT \- REGULAR FILES (.SST) - -.BR -The most common form of document in -.B SiSU -, see the section on -.B SiSU -markup. - -.BR -<http://www.jus.uio.no/sisu/sisu_markup> - -.BR -<http://www.jus.uio.no/sisu/sisu_manual> - -.SH -12.1.2 SISU MASTER FILES (.SSM) - -.BR -Composite documents which incorporate other -.B SiSU -documents which may be either regular -.B SiSU -text \.sst which may be generated independently, or inserts prepared solely -for the purpose of being incorporated into one or more master documents. - -.BR -The mechanism by which master files incorporate other documents is described as -one of the headings under under -.B SiSU -markup in the -.B SiSU -manual. - -.BR -Note: Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a \.sst file is renamed \.ssm without -requiring any other documents; the \.ssm marker flags that the document may -contain other documents. - -.BR -Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix \._sst [^17] - -.BR -<http://www.jus.uio.no/sisu/sisu_markup> - -.BR -<http://www.jus.uio.no/sisu/sisu_manual> - -.SH -12.1.3 SISU INSERT FILES (.SSI) - -.BR -Inserts are documents prepared solely for the purpose of being incorporated -into one or more master documents. They resemble regular -.B SiSU -text files except they are ignored by the -.B SiSU -processor. Making a file a \.ssi file is a quick and convenient way of -flagging that it is not intended that the file should be processed on its own. - -.SH -12.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) - -.BR -A sisupod is a zipped -.B SiSU -text file or set of -.B SiSU -text files and any associated images that they contain (this will be extended -to include sound and multimedia\-files) - -.BR -.B SiSU -plaintext files rely on a recognised directory structure to find contents -such as images associated with documents, but all images for example for all -documents contained in a directory are located in the sub\-directory -_sisu/image. Without the ability to create a sisupod it can be inconvenient to -manually identify all other files associated with a document. A sisupod -automatically bundles all associated files with the document that is turned -into a pod. - -.BR -The structure of the sisupod is such that it may for example contain a single -document and its associated images; a master document and its associated -documents and anything else; or the zipped contents of a whole directory of -prepared -.B SiSU -documents. - -.BR -The command to create a sisupod is: - -.BR - sisu \-S [filename] - -.BR -Alternatively, make a pod of the contents of a whole directory: - -.BR - sisu \-S - -.BR -.B SiSU -processing can be done directly against a sisupod; which may be located -locally or on a remote server for which a url is provided. - -.BR -<http://www.jus.uio.no/sisu/sisu_commands> - -.BR -<http://www.jus.uio.no/sisu/sisu_manual> - -.SH -13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS -.BR - -.SH -13.1 ALTERNATIVE XML - -.BR -.B SiSU -offers alternative XML input representations of documents as a proof of -concept, experimental feature. They are however not strictly maintained, and -incomplete and should be handled with care. - -.BR -.B convert from sst to simple xml representations (sax, dom and node): - -.BR - sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] - -.BR - sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] - -.BR - sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] - -.BR -.B convert to sst from any sisu xml representation (sax, dom and node): - -.BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.BR -or the same: - -.BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH -13.1.1 XML SAX REPRESENTATION - -.BR -To convert from sst to simple xml (sax) representation: - -.BR - sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] - -.BR -To convert from any sisu xml representation back to sst - -.BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.BR -or the same: - -.BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH -13.1.2 XML DOM REPRESENTATION - -.BR -To convert from sst to simple xml (dom) representation: - -.BR - sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] - -.BR -To convert from any sisu xml representation back to sst - -.BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.BR -or the same: - -.BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH -13.1.3 XML NODE REPRESENTATION - -.BR -To convert from sst to simple xml (node) representation: - -.BR - sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] - -.BR -To convert from any sisu xml representation back to sst - -.BR - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.BR -or the same: - -.BR - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH -14. CONFIGURATION -.BR - -.SH -14.1 DETERMINING THE CURRENT CONFIGURATION - -.BR -Information on the current configuration of -.B SiSU -should be available with the help command: - -.BR - sisu \-v - -.BR -which is an alias for: - -.BR - sisu \-\-help env - -.BR -Either of these should be executed from within a directory that contains sisu -markup source documents. - -.SH -14.2 CONFIGURATION FILES (CONFIG.YML) - -.BR -.B SiSU -configration parameters are adjusted in the configuration file, which can be -used to override the defaults set. This includes such things as which directory -interim processing should be done in and where the generated output should be -placed. - -.BR -The -.B SiSU -configuration file is a yaml file, which means indentation is significant. - -.BR -.B SiSU -resource configuration is determined by looking at the following files if -they exist: - -.BR - ./_sisu/sisurc.yml - -.BR - ~/.sisu/sisurc.yml - -.BR - /etc/sisu/sisurc.yml - -.BR -The search is in the order listed, and the first one found is used. - -.BR -In the absence of instructions in any of these it falls back to the internal -program defaults. - -.BR -Configuration determines the output and processing directories and the database -access details. - -.BR -If -.B SiSU -is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml - -.SH -15. SKINS -.BR - -.BR -Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following locations: - -.BR - ./_sisu/skin - -.BR - ~/.sisu/skin - -.BR - /etc/sisu/skin - -.BR -.B Within the skin directory -are the following the default sub\-directories for document skins: - -.BR - ./skin/doc - -.BR - ./skin/dir - -.BR - ./skin/site - -.BR -A skin is placed in the appropriate directory and the file named skin_[name].rb - -.BR -The skin itself is a ruby file which modifies the default appearances set in -the program. - -.SH -15.1 DOCUMENT SKIN - -.BR -Documents take on a document skin, if the header of the document specifies a -skin to be used. - - -.nf - @skin: skin_united_nations -.fi - -.SH -15.2 DIRECTORY SKIN - -.BR -A directory may be mapped on to a particular skin, so all documents within that -directory take on a particular appearance. If a skin exists in the skin/dir -with the same name as the document directory, it will automatically be used for -each of the documents in that directory, (except where a document specifies the -use of another skin, in the skin/doc directory). - -.BR -A personal habit is to place all skins within the doc directory, and symbolic -links as needed from the site, or dir directories as required. - -.SH -15.3 SITE SKIN - -.BR -A site skin, modifies the program default skin. - -.SH -15.4 SAMPLE SKINS - -.BR -With -.B SiSU -installed sample skins may be found in: - -.BR - /etc/sisu/skin/doc and - /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc - -.BR -(or equivalent directory) and if sisu\-markup\-samples is installed also under: - -.BR - /usr/share/doc/sisu\-markup\-samples/v2/samples/_sisu/skin/doc - -.BR -Samples of list.yml and promo.yml (which are used to create the right column -list) may be found in: - -.BR - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent - directory) - -.SH -16. CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) -.BR - -.BR -CSS files to modify the appearance of -.B SiSU -html, XHTML or XML may be placed in the configuration directory: \./_sisu/css -; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output -directories with the command sisu \-CC. - -.BR -The basic CSS file for html output is html.css, placing a file of that name in -directory _sisu/css or equivalent will result in the default file of that name -being overwritten. - -.BR -HTML: html.css - -.BR -XML DOM: dom.css - -.BR -XML SAX: sax.css - -.BR -XHTML: xhtml.css - -.BR -The default homepage may use homepage.css or html.css - -.BR -Under consideration is to permit the placement of a CSS file with a different -name in directory _sisu/css directory or equivalent, and change the default CSS -file that is looked for in a skin.[^18] - -.SH -17. ORGANISING CONTENT -.BR - -.SH -17.1 DIRECTORY STRUCTURE AND MAPPING - -.BR -The output directory root can be set in the sisurc.yml file. Under the root, -subdirectories are made for each directory in which a document set resides. If -you have a directory named poems or conventions, that directory will be created -under the output directory root and the output for all documents contained in -the directory of a particular name will be generated to subdirectories beneath -that directory (poem or conventions). A document will be placed in a -subdirectory of the same name as the document with the filetype identifier -stripped (.sst \.ssm) - -.BR -The last part of a directory path, representing the sub\-directory in which a -document set resides, is the directory name that will be used for the output -directory. This has implications for the organisation of document collections -as it could make sense to place documents of a particular subject, or type -within a directory identifying them. This grouping as suggested could be by -subject (sales_law, english_literature); or just as conveniently by some other -classification (X University). The mapping means it is also possible to place -in the same output directory documents that are for organisational purposes -kept separately, for example documents on a given subject of two different -institutions may be kept in two different directories of the same name, under a -directory named after each institution, and these would be output to the same -output directory. Skins could be associated with each institution on a -directory basis and resulting documents will take on the appropriate different -appearance. - -.SH - -.SH -18. HOMEPAGES -.BR - -.BR -.B SiSU -is about the ability to auto\-generate documents. Home pages are regarded as -custom built items, and are not created by -.B SiSU -. More accurately, -.B SiSU -has a default home page, which will not be appropriate for use with other -sites, and the means to provide your own home page instead in one of two ways -as part of a site\'s configuration, these being: - -.BR -1. through placing your home page and other custom built documents in the -subdirectory _sisu/home/ (this probably being the easier and more convenient -option) - -.BR -2. through providing what you want as the home page in a skin, - -.BR -Document sets are contained in directories, usually organised by site or -subject. Each directory can/should have its own homepage. See the section on -directory structure and organisation of content. - -.SH -18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY - -.BR -Custom built pages, including the home page index.html may be placed within the -configuration directory _sisu/home/ in any of the locations that is searched -for the configuration directory, namely \./_sisu ; ~/_sisu ; /etc/sisu From -there they are copied to the root of the output directory with the command: - -.BR - sisu \-CC - -.SH -18.2 HOME PAGE WITHIN A SKIN - -.BR -Skins are described in a separate section, but basically are a file written in -the programming language -.B Ruby -that may be provided to change the defaults that are provided with sisu with -respect to individual documents, a directories contents or for a site. - -.BR -If you wish to provide a homepage within a skin the skin should be in the -directory _sisu/skin/dir and have the name of the directory for which it is to -become the home page. Documents in the directory commercial_law would have the -homepage modified in skin_commercial law.rb; or the directory poems in -skin_poems.rb - - -.nf - class Home - def homepage - # place the html content of your homepage here, this will become index.html - <<HOME <html> - <head></head> - <doc> - <p>this is my new homepage.</p> - </doc> - </html> - HOME - end - end -.fi - -.SH -19. MARKUP AND OUTPUT EXAMPLES -.BR - -.SH -19.1 MARKUP EXAMPLES - -.BR -Current markup examples and document output samples are provided at -<http://www.jus.uio.no/sisu/SiSU/examples.html> - -.BR -Some markup with syntax highlighting may be found under -<http://www.jus.uio.no/sisu/sample/syntax> but is not as up to date. - -.BR -For some documents hardly any markup at all is required at all, other than a -header, and an indication that the levels to be taken into account by the -program in generating its output are. - -.SH -20. SISU SEARCH \- INTRODUCTION -.BR - -.BR -.B SiSU -output can easily and conveniently be indexed by a number of standalone -indexing tools, such as Lucene, Hyperestraier. - -.BR -Because the document structure of sites created is clearly defined, and the -text object citation system is available hypothetically at least, for all forms -of output, it is possible to search the sql database, and either read results -from that database, or just as simply map the results to the html output, which -has richer text markup. - -.BR -In addition to this -.B SiSU -has the ability to populate a relational sql type database with documents at -an object level, with objects numbers that are shared across different output -types, which make them searchable with that degree of granularity. Basically, -your match criteria is met by these documents and at these locations within -each document, which can be viewed within the database directly or in various -output formats. - -.SH -21. SQL -.BR - -.SH -21.1 POPULATING SQL TYPE DATABASES - -.BR -.B SiSU -feeds sisu markupd documents into sql type databases PostgreSQL[^19] and/or -SQLite[^20] database together with information related to document structure. - -.BR -This is one of the more interesting output forms, as all the structural data of -the documents are retained (though can be ignored by the user of the database -should they so choose). All site texts/documents are (currently) streamed to -four tables: - -.BR - * one containing semantic (and other) headers, including, title, author, - subject, (the Dublin Core...); - -.BR - * another the substantive texts by individual "paragraph" (or object) \- - along with structural information, each paragraph being identifiable by its - paragraph number (if it has one which almost all of them do), and the - substantive text of each paragraph quite naturally being searchable (both in - formatted and clean text versions for searching); and - -.BR - * a third containing endnotes cross\-referenced back to the paragraph from - which they are referenced (both in formatted and clean text versions for - searching). - -.BR - * a fourth table with a one to one relation with the headers table contains - full text versions of output, eg. pdf, html, xml, and ascii. - -.BR -There is of course the possibility to add further structures. - -.BR -At this level -.B SiSU -loads a relational database with documents chunked into objects, their -smallest logical structurally constituent parts, as text objects, with their -object citation number and all other structural information needed to construct -the document. Text is stored (at this text object level) with and without -elementary markup tagging, the stripped version being so as to facilitate ease -of searching. - -.BR -Being able to search a relational database at an object level with the -.B SiSU -citation system is an effective way of locating content generated by -.B SiSU -. As individual text objects of a document stored (and indexed) together with -object numbers, and all versions of the document have the same numbering, -complex searches can be tailored to return just the locations of the search -results relevant for all available output formats, with live links to the -precise locations in the database or in html/xml documents; or, the structural -information provided makes it possible to search the full contents of the -database and have headings in which search content appears, or to search only -headings etc. (as the Dublin Core is incorporated it is easy to make use of -that as well). - -.SH -22. POSTGRESQL -.BR - -.SH -22.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, -postgresql dependency package - -.SH -22.2 DESCRIPTION - -.BR -Information related to using postgresql with sisu (and related to the -sisu_postgresql dependency package, which is a dummy package to install -dependencies needed for -.B SiSU -to populate a postgresql database, this being part of -.B SiSU -\- man sisu). - -.SH -22.3 SYNOPSIS - -.BR - sisu \-D [instruction] [filename/wildcard \ if \ required] - -.BR - sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] - -.SH -22.4 COMMANDS - -.BR -Mappings to two databases are provided by default, postgresql and sqlite, the -same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used - -.BR -.B \-D or \-\-pgsql -may be used interchangeably. - -.SH -22.4.1 CREATE AND DESTROY DATABASE - -.TP -.B \-\-pgsql \-\-createall -initial step, creates required relations (tables, indexes) in existing -(postgresql) database (a database should be created manually and given the same -name as working directory, as requested) (rb.dbi) - -.TP -.B sisu \-D \-\-createdb -creates database where no database existed before - -.TP -.B sisu \-D \-\-create -creates database tables where no database tables existed before - -.TP -.B sisu \-D \-\-Dropall -destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories of the -same name). - -.TP -.B sisu \-D \-\-recreate -destroys existing database and builds a new empty database structure - -.SH -22.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.B sisu \-D \-\-import \-v [filename/wildcard] -populates database with the contents of the file. Imports documents(s) -specified to a postgresql database (at an object level). - -.TP -.B sisu \-D \-\-update \-v [filename/wildcard] -updates file contents in database - -.TP -.B sisu \-D \-\-remove \-v [filename/wildcard] -removes specified document from postgresql database. - -.SH -23. SQLITE -.BR - -.SH -23.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system. - -.SH -23.2 DESCRIPTION - -.BR -Information related to using sqlite with sisu (and related to the sisu_sqlite -dependency package, which is a dummy package to install dependencies needed for -.B SiSU -to populate an sqlite database, this being part of -.B SiSU -\- man sisu). - -.SH -23.3 SYNOPSIS - -.BR - sisu \-d [instruction] [filename/wildcard \ if \ required] - -.BR - sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ - required] - -.SH -23.4 COMMANDS - -.BR -Mappings to two databases are provided by default, postgresql and sqlite, the -same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used - -.BR -.B \-d or \-\-sqlite -may be used interchangeably. - -.SH -23.4.1 CREATE AND DESTROY DATABASE - -.TP -.B \-\-sqlite \-\-createall -initial step, creates required relations (tables, indexes) in existing -(sqlite) database (a database should be created manually and given the same -name as working directory, as requested) (rb.dbi) - -.TP -.B sisu \-d \-\-createdb -creates database where no database existed before - -.TP -.B sisu \-d \-\-create -creates database tables where no database tables existed before - -.TP -.B sisu \-d \-\-dropall -destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories of the -same name). - -.TP -.B sisu \-d \-\-recreate -destroys existing database and builds a new empty database structure - -.SH -23.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.B sisu \-d \-\-import \-v [filename/wildcard] -populates database with the contents of the file. Imports documents(s) -specified to an sqlite database (at an object level). - -.TP -.B sisu \-d \-\-update \-v [filename/wildcard] -updates file contents in database - -.TP -.B sisu \-d \-\-remove \-v [filename/wildcard] -removes specified document from sqlite database. - -.SH -24. INTRODUCTION -.BR - -.SH -24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, -INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) - -.BR -Sample search frontend <http://search.sisudoc.org> [^21] A small database and -sample query front\-end (search from) that makes use of the citation system, -.I object citation numbering -to demonstrates functionality.[^22] - -.BR -.B SiSU -can provide information on which documents are matched and at what locations -within each document the matches are found. These results are relevant across -all outputs using object citation numbering, which includes html, XML, EPUB, -LaTeX, PDF and indeed the SQL database. You can then refer to one of the other -outputs or in the SQL database expand the text within the matched objects -(paragraphs) in the documents matched. - -.BR -Note you may set results either for documents matched and object number -locations within each matched document meeting the search criteria; or display -the names of the documents matched along with the objects (paragraphs) that -meet the search criteria.[^23] - -.TP -.B sisu \-F \-\-webserv\-webrick -builds a cgi web search frontend for the database created - -.BR -The following is feedback on the setup on a machine provided by the help -command: - -.BR - sisu \-\-help sql - - -.nf - Postgresql - user: ralph - current db set: SiSU_sisu - port: 5432 - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 - sqlite - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db -.fi - -.BR -Note on databases built - -.BR -By default, [unless \ otherwise \ specified] databases are built on a directory -basis, from collections of documents within that directory. The name of the -directory you choose to work from is used as the database name, i.e. if you are -working in a directory called /home/ralph/ebook the database SiSU_ebook is -used. [otherwise \ a \ manual \ mapping \ for \ the \ collection \ is \ -necessary] - -.SH -24.2 SEARCH FORM - -.TP -.B sisu \-F -generates a sample search form, which must be copied to the web\-server cgi -directory - -.TP -.B sisu \-F \-\-webserv\-webrick -generates a sample search form for use with the webrick server, which must be -copied to the web\-server cgi directory - -.TP -.B sisu \-Fv -as above, and provides some information on setting up hyperestraier - -.TP -.B sisu \-W -starts the webrick server which should be available wherever sisu is properly -installed - -.BR -The generated search form must be copied manually to the webserver directory as -instructed - -.SH -25. HYPERESTRAIER -.BR - -.BR -See the documentation for hyperestraier: - -.BR - <http://hyperestraier.sourceforge.net/> - -.BR - /usr/share/doc/hyperestraier/index.html - -.BR - man estcmd - -.BR -NOTE: the examples that follow assume that sisu output is placed in the -directory /home/ralph/sisu_www - -.BR -(A) to generate the index within the webserver directory to be indexed: - -.BR - estcmd gather \-sd [index \ name] [directory \ path \ to \ index] - -.BR -the following are examples that will need to be tailored according to your -needs: - -.BR - cd /home/ralph/sisu_www - -.BR - estcmd gather \-sd casket /home/ralph/sisu_www - -.BR -you may use the \'find\' command together with \'egrep\' to limit indexing to -particular document collection directories within the web server directory: - -.BR - find /home/ralph/sisu_www \-type f | egrep - \'/home/ralph/sisu_www/sisu/.+?.html$\' |estcmd gather \-sd casket \- - -.BR -Check which directories in the webserver/output directory (~/sisu_www or -elsewhere depending on configuration) you wish to include in the search index. - -.BR -As sisu duplicates output in multiple file formats, it it is probably -preferable to limit the estraier index to html output, and as it may also be -desirable to exclude files \'plain.txt\', \'toc.html\' and -\'concordance.html\', as these duplicate information held in other html output -e.g. - -.BR - find /home/ralph/sisu_www \-type f | egrep - \'/sisu_www/(sisu|bookmarks)/.+?.html$\' | egrep \-v - \'(doc|concordance).html$\' |estcmd gather \-sd casket \- - -.BR -from your current document preparation/markup directory, you would construct a -rune along the following lines: - -.BR - find /home/ralph/sisu_www \-type f | egrep \'/home/ralph/sisu_www/([specify \ - first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \ - inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$\' | - egrep \-v \'(doc|concordance).html$\' |estcmd gather \-sd - /home/ralph/sisu_www/casket \- - -.BR -(B) to set up the search form - -.BR -(i) copy estseek.cgi to your cgi directory and set file permissions to 755: - -.BR - sudo cp \-vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi\-bin - -.BR - sudo chmod \-v 755 /usr/lib/cgi\-bin/estseek.cgi - -.BR - sudo cp \-v /usr/share/hyperestraier/estseek.* /usr/lib/cgi\-bin - -.BR - [see \ estraier \ documentation \ for \ paths] - -.BR -(ii) edit estseek.conf, with attention to the lines starting \'indexname:\' and -\'replace:\': - -.BR - indexname: /home/ralph/sisu_www/casket - -.BR - replace: ^file:///home/ralph/sisu_www{{!}}http://localhost - -.BR - replace: /index.html?${{!}}/ - -.BR -(C) to test using webrick, start webrick: - -.BR - sisu \-W - -.BR -and try open the url: <http://localhost:8081/cgi\-bin/estseek.cgi> - -.SH -26. SISU_WEBRICK -.BR - -.SH -26.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system - -.SH -26.2 SYNOPSIS - -.BR -sisu_webrick [port] - -.BR -or - -.BR -sisu \-W [port] - -.SH -26.3 DESCRIPTION - -.BR -sisu_webrick is part of -.B SiSU -(man sisu) sisu_webrick starts -.B Ruby -\'s Webrick web\-server and points it to the directories to which -.B SiSU -output is written, providing a list of these directories (assuming -.B SiSU -is in use and they exist). - -.BR -The default port for sisu_webrick is set to 8081, this may be modified in the -yaml file: ~/.sisu/sisurc.yml a sample of which is provided as -/etc/sisu/sisurc.yml (or in the equivalent directory on your system). - -.SH -26.4 SUMMARY OF MAN PAGE - -.BR -sisu_webrick, may be started on it\'s own with the command: sisu_webrick [port] -or using the sisu command with the \-W flag: sisu \-W [port] - -.BR -where no port is given and settings are unchanged the default port is 8081 - -.SH -26.5 DOCUMENT PROCESSING COMMAND FLAGS - -.BR -sisu \-W [port] starts -.B Ruby -Webrick web\-server, serving -.B SiSU -output directories, on the port provided, or if no port is provided and the -defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 - -.SH -26.6 FURTHER INFORMATION - -.BR -For more information on -.B SiSU -see: <http://www.jus.uio.no/sisu> - -.BR -or man sisu - -.SH -26.7 AUTHOR - -.BR -Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com - -.SH -26.8 SEE ALSO - -.BR - sisu(1) - -.BR - sisu_vim(7) - -.BR - sisu(8) - -.SH -27. REMOTE SOURCE DOCUMENTS -.BR - -.BR -.B SiSU -processing instructions can be run against remote source documents by -providing the url of the documents against which the processing instructions -are to be carried out. The remote -.B SiSU -documents can either be sisu marked up files in plaintext \.sst or \.ssm or; -zipped sisu files, sisupod.zip or filename.ssp - -.BR -.B \.sst / \.ssm \- sisu text files - -.BR -.B SiSU -can be run against source text files on a remote machine, provide the -processing instruction and the url. The source file and any associated parts -(such as images) will be downloaded and generated locally. - - -.nf - sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] -.fi - -.BR -Any of the source documents in the sisu examples page can be used in this way, -see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url for the -desired document. - -.BR -NOTE: to set up a remote machine to serve -.B SiSU -documents in this way, images should be in the directory relative to the -document source \../_sisu/image - -.BR -.B sisupod \- zipped sisu files - -.BR -A sisupod is the zipped content of a sisu marked up text or texts and any other -associated parts to the document such as images. - -.BR -.B SiSU -can be run against a sisupod on a (local or) remote machine, provide the -processing instruction and the url, the sisupod will be downloaded and the -documents it contains generated locally. - - -.nf - sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] -.fi - -.BR -Any of the source documents in the sisu examples page can be used in this way, -see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url for the -desired document. - -.SH -REMOTE DOCUMENT OUTPUT -.BR - -.SH -28. REMOTE OUTPUT -.BR - -.BR -Once properly configured -.B SiSU -output can be automatically posted once generated to a designated remote -machine using either rsync, or scp. - -.BR -In order to do this some ssh authentication agent and keychain or similar tool -will need to be configured. Once that is done the placement on a remote host -can be done seamlessly with the \-r (for scp) or \-R (for rsync) flag, which -may be used in conjunction with other processing flags, e.g. - - -.nf - sisu \-3R sisu_remote.sst -.fi - -.SH -28.1 COMMANDS - -.TP -.B \-R [filename/wildcard] -copies sisu output files to remote host using rsync. This requires that -sisurc.yml has been provided with information on hostname and username, and -that you have your \"keys\" and ssh agent in place. Note the behavior of rsync -different if \-R is used with other flags from if used alone. Alone the rsync -\-\-delete parameter is sent, useful for cleaning the remote directory (when -\-R is used together with other flags, it is not). Also see \-r - -.TP -.B \-r [filename/wildcard] -copies sisu output files to remote host using scp. This requires that -sisurc.yml has been provided with information on hostname and username, and -that you have your \"keys\" and ssh agent in place. Also see \-R - -.SH -28.2 CONFIGURATION - -.BR -[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain] - -.SH -29. REMOTE SERVERS -.BR - -.BR -As -.B SiSU -is generally operated using the command line, and works within a Unix type -environment, -.B SiSU -the program and all documents can just as easily be on a remote server, to -which you are logged on using a terminal, and commands and operations would be -pretty much the same as they would be on your local machine. - -.SH -30. QUICKSTART \- GETTING STARTED HOWTO -.BR - -.SH -30.1 INSTALLATION - -.BR -Installation is currently most straightforward and tested on the -.B Debian -platform, as there are packages for the installation of sisu and all -requirements for what it does. - -.SH -30.1.1 DEBIAN INSTALLATION - -.BR -.B SiSU -is available directly from the -.B Debian -Sid and testing archives (and possibly Ubuntu), assuming your -/etc/apt/sources.list is set accordingly: - - -.nf - aptitude update -.BR - aptitude install sisu\-complete -.fi - -.BR -The following /etc/apt/sources.list setting permits the download of additional -markup samples: - - -.nf - #/etc/apt/sources.list -.BR - deb http://ftp.fi.debian.org/debian/ unstable main non\-free contrib -.BR - deb\-src http://ftp.fi.debian.org/debian/ unstable main non\-free contrib -.BR - d -.fi - -.BR -The aptitude commands become: - - -.nf - aptitude update -.BR - aptitude install sisu\-complete sisu\-markup\-samples -.fi - -.BR -If there are newer versions of -.B SiSU -upstream of the -.B Debian -archives, they will be available by adding the following to your -/etc/apt/sources.list - - -.nf - #/etc/apt/sources.list - deb http://www.jus.uio.no/sisu/archive unstable main non\-free - deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free -.fi - -.BR -repeat the aptitude commands - - -.nf - aptitude update - aptitude install sisu\-complete sisu\-markup\-samples -.fi - -.BR -Note however that it is not necessary to install sisu\-complete if not all -components of sisu are to be used. Installing just the package sisu will -provide basic functionality. - -.SH -30.1.2 RPM INSTALLATION - -.BR -RPMs are provided though untested, they are prepared by running alien against -the source package, and against the debs. - -.BR -They may be downloaded from: - -.BR - <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> - -.BR -as root type: - -.BR - rpm \-i [rpm \ package \ name] - -.SH -30.1.3 INSTALLATION FROM SOURCE - -.BR -To install -.B SiSU -from source check information at: - -.BR - <http://www.jus.uio.no/sisu/SiSU/download.html#current> - -.BR -* download the source package - -.BR -* Unpack the source - -.BR -Two alternative modes of installation from source are provided, setup.rb (by -Minero Aoki) and a rant(by Stefan Lang) built install file, in either case: the -first steps are the same, download and unpack the source file: - -.BR -For basic use -.B SiSU -is only dependent on the programming language in which it is written -.B Ruby -, and -.B SiSU -will be able to generate html, EPUB, various XMLs, including ODF (and will -also produce LaTeX). Dependencies required for further actions, though it -relies on the installation of additional dependencies which the source tarball -does not take care of, for things like using a database (postgresql or -sqlite)[^24] or converting LaTeX to pdf. - -.BR -.B setup.rb - -.BR -This is a standard ruby installer, using setup.rb is a three step process. In -the root directory of the unpacked -.B SiSU -as root type: - - -.nf - ruby setup.rb config - ruby setup.rb setup - #[and \ as \ root:] - ruby setup.rb install -.fi - -.BR -further information on setup.rb is available from: - -.BR - <http://i.loveruby.net/en/projects/setup/> - -.BR - <http://i.loveruby.net/en/projects/setup/doc/usage.html> - -.BR -.B \"install\" - -.BR -The \"install\" file provided is an installer prepared using \"rant\". In the -root directory of the unpacked -.B SiSU -as root type: - -.BR - ruby install base - -.BR -or for a more complete installation: - -.BR - ruby install - -.BR -or - -.BR - ruby install base - -.BR -This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been -configured to do post installation setup setup configuration and generation of -first test file. Note however, that additional external package dependencies, -such as tetex\-extra are not taken care of for you. - -.BR -Further information on \"rant\" is available from: - -.BR - <http://make.rubyforge.org/> - -.BR - <http://rubyforge.org/frs/?group_id=615> - -.BR -For a list of alternative actions you may type: - -.BR - ruby install help - -.BR - ruby install \-T - -.SH -30.2 TESTING SISU, GENERATING OUTPUT - -.BR -To check which version of sisu is installed: - -.BR -sisu \-v - -.BR -Depending on your mode of installation one or a number of markup sample files -may be found either in the directory: - -.BR -... - -.BR -or - -.BR -... - -.BR -change directory to the appropriate one: - -.BR -cd /usr/share/doc/sisu/sisu_markup_samples/dfsg - -.SH -30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB - -.BR -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it - -.BR -sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -.BR -this will generate html including a concordance file, opendocument text format, -plaintext, XHTML and various forms of XML, and OpenDocument text - -.SH -30.2.2 LATEX / PDF - -.BR -Assuming a LaTeX engine such as tetex or texlive is installed with the required -modules (done automatically on selection of sisu\-pdf in -.B Debian -) - -.BR -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it - -.BR -sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -.BR -sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst - -.BR -should generate most available output formats: html including a concordance -file, opendocument text format, plaintext, XHTML and various forms of XML, and -OpenDocument text and pdf - -.SH -30.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE - -.BR -Relational databases need some setting up \- you must have permission to create -the database and write to it when you run sisu. - -.BR -Assuming you have the database installed and the requisite permissions - -.BR -sisu \-\-sqlite \-\-recreate - -.BR -sisu \-\-sqlite \-v \-\-import -free_as_in_freedom.rms_and_free_software.sam_williams.sst - -.BR -sisu \-\-pgsql \-\-recreate - -.BR -sisu \-\-pgsql \-v \-\-import -free_as_in_freedom.rms_and_free_software.sam_williams.sst - -.SH -30.3 GETTING HELP - -.SH -30.3.1 THE MAN PAGES - -.BR -Type: - -.BR - man sisu - -.BR -The man pages are also available online, though not always kept as up to date -as within the package itself: - -.BR -* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1> [^25] - -.BR -* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8> [^26] - -.BR -* man directory <http://www.jus.uio.no/sisu/man> [^27] - -.SH -30.3.2 BUILT IN HELP - -.BR -sisu \-\-help - -.BR -sisu \-\-help \-\-env - -.BR -sisu \-\-help \-\-commands - -.BR -sisu \-\-help \-\-markup - -.SH -30.3.3 THE HOME PAGE - -.BR -<http://www.jus.uio.no/sisu> - -.BR -<http://www.jus.uio.no/sisu/SiSU> - -.SH -30.4 MARKUP SAMPLES - -.BR -A number of markup samples (along with output) are available off: - -.BR -<http://www.jus.uio.no/sisu/SiSU/examples.html> - -.BR -Additional markup samples are packaged separately in the file: - -.BR -.B * - -.BR -On -.B Debian -they are available in non\-free[^28] to include them it is necessary to -include non\-free in your /etc/apt/source.list or obtain them from the sisu -home site. - -.SH -31. EDITOR FILES, SYNTAX HIGHLIGHTING -.BR - -.BR -The directory: - -.BR - \./data/sisu/v2/conf/editor\-syntax\-etc/ - -.BR - /usr/share/sisu/v2/conf/editor\-syntax\-etc - -.BR -contains rudimentary sisu syntax highlighting files for: - -.BR -* (g)vim <http://www.vim.org> - -.BR - package: sisu\-vim - -.BR -status: largely done - -.BR - there is a vim syntax highlighting and folds component - -.BR -* gedit <http://www.gnome.org/projects/gedit> - -.BR -* gobby <http://gobby.0x539.de/> - -.BR - file: sisu.lang - -.BR -place in: - -.BR - /usr/share/gtksourceview\-1.0/language\-specs - -.BR -or - -.BR - ~/.gnome2/gtksourceview\-1.0/language\-specs - -.BR - status: very basic syntax highlighting - -.BR - comments: this editor features display line wrap and is used by Goby! - -.BR -* nano <http://www.nano\-editor.org> - -.BR - file: nanorc - -.BR -save as: - -.BR - ~/.nanorc - -.BR - status: basic syntax highlighting - -.BR - comments: assumes dark background; no display line\-wrap; does line breaks - -.BR -* diakonos (an editor written in ruby) <http://purepistos.net/diakonos> - -.BR -file: diakonos.conf - -.BR -save as: - -.BR - ~/.diakonos/diakonos.conf - -.BR -includes: - -.BR - status: basic syntax highlighting - -.BR -comments: assumes dark background; no display line\-wrap - -.BR -* kate & kwrite <http://kate.kde.org> - -.BR - file: sisu.xml - -.BR - place in: - -.BR - /usr/share/apps/katepart/syntax - -.BR - or - -.BR - ~/.kde/share/apps/katepart/syntax - -.BR - [settings::configure \ kate::{highlighting,filetypes}] - -.BR - [tools::highlighting::{markup,scripts}:: \ .B \ SiSU \ ] - -.BR -* nedit <http://www.nedit.org> - -.BR - file: sisu_nedit.pats - -.BR - nedit \-import sisu_nedit.pats - -.BR - status: a very clumsy first attempt [not \ really \ done] - -.BR - comments: this editor features display line wrap - -.BR -* emacs <http://www.gnu.org/software/emacs/emacs.html> - -.BR - files: sisu\-mode.el - -.BR - to file ~/.emacs add the following 2 lines: - -.BR - (add\-to\-list \'load\-path \"/usr/share/sisu/v1/conf/editor\-syntax\-etc/emacs\") - -.BR - (require \'sisu\-mode.el) - -.BR - [not \ done \ / \ not \ yet \ included] - -.BR -* vim & gvim <http://www.vim.org> - -.BR - files: - -.BR - package is the most comprehensive sisu syntax highlighting and editor - environment provided to date (is for vim/ gvim, and is separate from the - contents of this directory) - -.BR - status: this includes: syntax highlighting; vim folds; some error checking - -.BR - comments: this editor features display line wrap - -.BR -NOTE: - -.BR -[ \ .B \ SiSU \ parses \ files \ with \ long \ lines \ or \ line \ breaks, \ -but, \ display \ linewrap \ (without \ line\-breaks) \ is \ a \ convenient \ -editor \ feature \ to \ have \ for \ sisu \ markup] - -.SH -32. HOW DOES SISU WORK? -.BR - -.BR -.B SiSU -markup is fairly minimalistic, it consists of: a (largely optional) document -header, made up of information about the document (such as when it was -published, who authored it, and granting what rights) and any processing -instructions; and markup within the substantive text of the document, which is -related to document structure and typeface. -.B SiSU -must be able to discern the structure of a document, (text headings and their -levels in relation to each other), either from information provided in the -document header or from markup within the text (or from a combination of both). -Processing is done against an abstraction of the document comprising of -information on the document\'s structure and its objects,[2] which the program -serializes (providing the object numbers) and which are assigned hash sum -values based on their content. This abstraction of information about document -structure, objects, (and hash sums), provides considerable flexibility in -representing documents different ways and for different purposes (e.g. search, -document layout, publishing, content certification, concordance etc.), and -makes it possible to take advantage of some of the strengths of established -ways of representing documents, (or indeed to create new ones). - -.SH -33. SUMMARY OF FEATURES -.BR - -.BR -* sparse/minimal markup (clean utf\-8 source texts). Documents are prepared in -a single UTF\-8 file using a minimalistic mnemonic syntax. Typical literature, -documents like \"War and Peace\" require almost no markup, and most of the -headers are optional. - -.BR -* markup is easily readable/parsable by the human eye, (basic markup is simpler -and more sparse than the most basic HTML), [this \ may \ also \ be \ converted -\ to \ XML \ representations \ of \ the \ same \ input/source \ document]. - -.BR -* markup defines document structure (this may be done once in a header -pattern\-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike\-through etc.) as required; and -semantic information related to the document (header information, extended -beyond the Dublin core and easily further extended as required); the headers -may also contain processing instructions. -.B SiSU -markup is primarily an abstraction of document structure and document -metadata to permit taking advantage of the basic strengths of existing -alternative practical standard ways of representing documents [be \ that \ -browser \ viewing, \ paper \ publication, \ sql \ search \ etc.] (html, epub, -xml, odf, latex, pdf, sql) - -.BR -* for output produces reasonably elegant output of established industry and -institutionally accepted open standard formats.[3] takes advantage of the -different strengths of various standard formats for representing documents, -amongst the output formats currently supported are: - -.BR - * html \- both as a single scrollable text and a segmented document - -.BR - * xhtml - -.BR - * epub - -.BR - * XML \- both in sax and dom style xml structures for further development as - required - -.BR - * ODF \- open document format, the iso standard for document storage - -.BR - * LaTeX \- used to generate pdf - -.BR - * pdf (via LaTeX) - -.BR - * sql \- population of an sql database, (at the same object level that is - used to cite text within a document) - -.BR -Also produces: concordance files; document content certificates (md5 or sha256 -digests of headings, paragraphs, images etc.) and html manifests (and sitemaps -of content). (b) takes advantage of the strengths implicit in these very -different output types, (e.g. PDFs produced using typesetting of LaTeX, -databases populated with documents at an individual object/paragraph level, -making possible granular search (and related possibilities)) - -.BR -* ensuring content can be cited in a meaningful way regardless of selected -output format. Online publishing (and publishing in multiple document formats) -lacks a useful way of citing text internally within documents (important to -academics generally and to lawyers) as page numbers are meaningless across -browsers and formats. sisu seeks to provide a common way of pinpoint the text -within a document, (which can be utilized for citation and by search engines). -The outputs share a common numbering system that is meaningful (to man and -machine) across all digital outputs whether paper, screen, or database -oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this numbering system can -be used to reference content. - -.BR -* Granular search within documents. SQL databases are populated at an object -level (roughly headings, paragraphs, verse, tables) and become searchable with -that degree of granularity, the output information provides the -object/paragraph numbers which are relevant across all generated outputs; it is -also possible to look at just the matching paragraphs of the documents in the -database; [output \ indexing \ also \ work \ well \ with \ search \ indexing \ -tools \ like \ hyperestraier]. - -.BR * long term maintainability of document collections in a world of changing -formats, having a very sparsely marked\-up source document base. there is a -considerable degree of future\-proofing, output representations are -\"upgradeable\", and new document formats may be added. e.g. addition of odf -(open document text) module in 2006, epub in 2009 and in future html5 output -sometime in future, without modification of existing prepared texts - -.BR -* SQL search aside, documents are generated as required and static once -generated. - -.BR -* documents produced are static files, and may be batch processed, this needs -to be done only once but may be repeated for various reasons as desired -(updated content, addition of new output formats, updated technology document -presentations/representations) - -.BR -* document source (plaintext utf\-8) if shared on the net may be used as input -and processed locally to produce the different document outputs - -.BR -* document source may be bundled together (automatically) with associated -documents (multiple language versions or master document with inclusions) and -images and sent as a zip file called a sisupod, if shared on the net these too -may be processed locally to produce the desired document outputs - -.BR -* generated document outputs may automatically be posted to remote sites. - -.BR -* for basic document generation, the only software dependency is -.B Ruby -, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, -LaTeX). To use a database you of course need that, and to convert the LaTeX -generated to pdf, a latex processor like tetex or texlive. - -.BR -* as a developers tool it is flexible and extensible - -.BR -Syntax highlighting for -.B SiSU -markup is available for a number of text editors. - -.BR -.B SiSU -is less about document layout than about finding a way with little markup to -be able to construct an abstract representation of a document that makes it -possible to produce multiple representations of it which may be rather -different from each other and used for different purposes, whether layout and -publishing, or search of content - -.BR -i.e. to be able to take advantage from this minimal preparation starting point -of some of the strengths of rather different established ways of representing -documents for different purposes, whether for search (relational database, or -indexed flat files generated for that purpose whether of complete documents, or -say of files made up of objects), online viewing (e.g. html, xml, pdf), or -paper publication (e.g. pdf)... - -.BR -the solution arrived at is by extracting structural information about the -document (about headings within the document) and by tracking objects (which -are serialized and also given hash values) in the manner described. It makes -possible representations that are quite different from those offered at -present. For example objects could be saved individually and identified by -their hashes, with an index of how the objects relate to each other to form a -document. - -.SH -34. HELP SOURCES -.BR - -.BR -For a summary of alternative ways to get help on -.B SiSU -try one of the following: - -.BR -.B man page - -.BR - man sisu_help - -.BR -.B man2html - -.BR - <http://www.jus.uio.no/sisu/man/sisu_help.1.html> - -.BR -.B sisu generated output \- links to html - -.BR - <http://sisudoc.org/sisu/sisu_help/index.html> - -.BR -.B help sources lists - -.BR -Alternative sources for this help sources page listed here: - -.BR - man sisu_help_sources - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.SH -34.1 MAN PAGES - -.SH -34.1.1 MAN - -.BR - man sisu - -.BR - man 7 sisu_complete - -.BR - man 7 sisu_pdf - -.BR - man 7 sisu_postgresql - -.BR - man 7 sisu_sqlite - -.BR - man sisu_termsheet - -.BR - man sisu_webrick - -.SH -34.2 SISU GENERATED OUTPUT \- LINKS TO HTML - -.BR -Note -.B SiSU -documentation is prepared in -.B SiSU -and output is available in multiple formats including amongst others html, -pdf, odf and epub which may be also be accessed via the html pages[^28] - -.SH -34.2.1 WWW.SISUDOC.ORG - -.BR -<http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_commands/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_complete/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_configuration/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_description/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_examples/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_faq/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_filetypes/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_help/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_howto/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_introduction/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_markup/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_output_overview/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_pdf/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_postgresql/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_quickstart/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_remote/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_search/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_skin/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_sqlite/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_vim/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_webrick/index.html> - -.SH -34.3 MAN2HTML - -.SH -34.3.1 LOCALLY INSTALLED - -.BR -<file:///usr/share/doc/sisu/v2/html/sisu.1.html> - -.BR -<file:///usr/share/doc/sisu/v2/html/sisu_help.1.html> - -.BR -<file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html> - -.BR - /usr/share/doc/sisu/v2/html/sisu.1.html - -.BR - /usr/share/doc/sisu/v2/html/sisu_pdf.7.html - -.BR - /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html - -.BR - /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html - -.BR - /usr/share/doc/sisu/v2/html/sisu_webrick.1.html - -.SH -34.3.2 WWW.JUS.UIO.NO/SISU - -.BR -<http://www.jus.uio.no/sisu/man/sisu.1.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu.1.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_complete.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_pdf.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> - -.TP -.BI 1. -objects include: headings, paragraphs, verse, tables, images, but not -footnotes/endnotes which are numbered separately and tied to the object from -which they are referenced. -.TP -.BI 2. -i.e. the html, pdf, epub, odf outputs are each built individually and -optimised for that form of presentation, rather than for example the html being -a saved version of the odf, or the pdf being a saved version of the html. - -.BR -.TP -.BI 3. -the different heading levels -.TP -.BI 4. -units of text, primarily paragraphs and headings, also any tables, poems, -code-blocks -.TP -.BI 5. -Specification submitted by Adobe to ISO to become a full open ISO -specification -<http://www.linux-watch.com/news/NS7542722606.html> -.TP -.BI 6. -ISO standard ISO/IEC 26300:2006 - -.BR -.TP -.BI 7. -An open standard format for e-books - -.BR -.TP -.BI *1. -square brackets -.TP -.BI *2. -square brackets -.TP -.BI +1. -square brackets -.TP -.BI 8. -<http://www.jus.uio.no/sisu/man/> -.TP -.BI 9. -<http://www.jus.uio.no/sisu/man/sisu.1.html> -.TP -.BI 10. -From sometime after SiSU 0.58 it should be possible to describe SiSU markup -using SiSU, which though not an original design goal is useful. -.TP -.BI 11. -files should be prepared using UTF-8 character encoding -.TP -.BI 12. -a footnote or endnote -.TP -.BI 13. -self contained endnote marker & endnote in one -.TP -.BI *. -unnumbered asterisk footnote/endnote, insert multiple asterisks if required -.TP -.BI **. -another unnumbered asterisk footnote/endnote -.TP -.BI *3. -editors notes, numbered asterisk footnote/endnote series -.TP -.BI +2. -editors notes, numbered asterisk footnote/endnote series -.TP -.BI 14. -<http://www.jus.uio.no/sisu/> -.TP -.BI 15. -<http://www.ruby-lang.org/en/> -.TP -.BI 16. -Table from the Wealth of Networks by Yochai Benkler -<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler> -.TP -.BI 17. -\.ssc (for composite) is under consideration but \._sst makes clear that this -is not a regular file to be worked on, and thus less likely that people will -have \"accidents\", working on a \.ssc file that is overwritten by subsequent -processing. It may be however that when the resulting file is shared \.ssc is an -appropriate suffix to use. -.TP -.BI 19. -<http://www.postgresql.org/> -<http://advocacy.postgresql.org/> -<http://en.wikipedia.org/wiki/Postgresql> -.TP -.BI 20. -<http://www.hwaci.com/sw/sqlite/> -<http://en.wikipedia.org/wiki/Sqlite> -.TP -.BI 21. -<http://search.sisudoc.org> -.TP -.BI 22. -(which could be extended further with current back-end). As regards scaling -of the database, it is as scalable as the database (here Postgresql) and -hardware allow. -.TP -.BI 23. -of this feature when demonstrated to an IBM software innovations evaluator -in 2004 he said to paraphrase: this could be of interest to us. We have large -document management systems, you can search hundreds of thousands of documents -and we can tell you which documents meet your search criteria, but there is no -way we can tell you without opening each document where within each your -matches are found. -.TP -.BI 24. -There is nothing to stop MySQL support being added in future. -.TP -.BI 25. -<http://www.jus.uio.no/sisu/man/sisu.1> -.TP -.BI 26. -<http://www.jus.uio.no/sisu/man/sisu.8> -.TP -.BI 27. -<http://www.jus.uio.no/sisu/man> -.TP -.BI 28. -the -.B Debian -Free Software guidelines require that everything distributed within -.B Debian -can be changed - and the documents are authors' works that while freely -distributable are not freely changeable. -.TP -.BI 29. -named index.html or more extensively through sisu_manifest.html - -.SH SEE ALSO -\fIsisu\fR(1), -.br -\fIsisu\-epub\fR(1), -.br -\fIsisu\-harvest\fR(1), -.br -\fIsisu\-html\fR(1), -.br -\fIsisu\-odf\fR(1), -.br -\fIsisu\-pdf\fR(1), -.br -\fIsisu\-pg\fR(1), -.br -\fIsisu\-sqlite\fR(1), -.br -\fIsisu\-txt\fR(1). -.br -\fIsisu_vim\fR(7) -.br -\fIsisu\fR(8) - -.SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. - -.SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +sisu.1
\ No newline at end of file diff --git a/man/man1/sisu_termsheet.1 b/man/man1/sisu_termsheet.1 index 4ec59279..518e65fc 100644 --- a/man/man1/sisu_termsheet.1 +++ b/man/man1/sisu_termsheet.1 @@ -60,7 +60,7 @@ or .BR sisu_vim(7) .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu_webrick.1 b/man/man1/sisu_webrick.1 index e139fb4c..2cfe9455 100644 --- a/man/man1/sisu_webrick.1 +++ b/man/man1/sisu_webrick.1 @@ -21,7 +21,7 @@ SISU WEBRICK .BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system +\- Structured information, Serialized Units - a document publishing system .SH 1.2 SYNOPSIS @@ -33,13 +33,13 @@ sisu_webrick \ [port] or .BR -sisu \-\-Webrick \ [port] +sisu --Webrick \ [port] .BR or .BR -sisu \-W \ [port] +sisu -W \ [port] .SH 1.3 DESCRIPTION @@ -49,7 +49,7 @@ sisu_webrick is part of .B SiSU (man sisu) sisu_webrick starts .B Ruby -\'s Webrick web\-server and points it to the directories to which +\'s Webrick web-server and points it to the directories to which .B SiSU output is written, providing a list of these directories (assuming .B SiSU @@ -65,7 +65,7 @@ yaml file: ~/.sisu/sisurc.yml a sample of which is provided as .BR sisu_webrick, may be started on it\'s own with the command: sisu_webrick \ -[port] or using the sisu command with the \-W flag: sisu \-W \ [port] +[port] or using the sisu command with the -W flag: sisu -W \ [port] .BR where no port is given and settings are unchanged the default port is 8081 @@ -74,9 +74,9 @@ where no port is given and settings are unchanged the default port is 8081 1.5 DOCUMENT PROCESSING COMMAND FLAGS .BR -sisu \-W \ [port] starts +sisu -W \ [port] starts .B Ruby -Webrick web\-server, serving +Webrick web-server, serving .B SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 @@ -111,7 +111,7 @@ Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com sisu(8) .SH HOMEPAGE -More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>. +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR -\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>. +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man7/sisu_vim.7 b/man/man7/sisu_vim.7 index 6b6ccd15..9ea91846 100644 --- a/man/man7/sisu_vim.7 +++ b/man/man7/sisu_vim.7 @@ -23,16 +23,10 @@ has syntax highlighting for a number of editors including vim which are documented under: .BR - man sisu_syntax_highlighting + /usr/share/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst .BR - /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html - -.BR - <http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html> - -.BR - <http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html> + <http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html> .BR .B SiSU @@ -69,126 +63,15 @@ sisu\-vim actions are activated on files with the suffix \.sst \.ssm \.ssi FURTHER INFORMATION .BR -For more information on +For more information .B SiSU see: .BR -<http://www.jus.uio.no/sisu> - -.BR -or man sisu - -.SH -DOCUMENT INFORMATION (METADATA) -.BR - -.SH -METADATA -.BR - -.BR -Document Manifest @ -<http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html> - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -.BR -DC Title: -.I SiSU \- Vim - -.BR -DC Creator: -.I Ralph Amissah - -.BR -DC Rights: -.I Copyright (C) Ralph Amissah 2008, part of SiSU documentation, License GPL -3 - -.BR -DC Type: -.I information +<http://sisudoc.org/> .BR -DC Date created: -.I 2002\-11\-12 - -.BR -DC Date issued: -.I 2002\-11\-12 - -.BR -DC Date available: -.I 2002\-11\-12 - -.BR -DC Date modified: -.I 2008\-02\-12 - -.BR -DC Date: -.I 2008\-02\-12 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu_vim.sst - -.BR -Filetype: -.I SiSU text insert 0.58 - -.BR -Sourcefile Digest, MD5(sisu_vim.sst)= -.I b5028f957b128162f7653bbd940042ca - -.BR -Skin_Digest: MD5(skin_sisu_manual.rb)= -.I 072b2584bedea82ea8a416587b9fa244 - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Thu Feb 14 02:44:14 +0000 2008 - -.BR -Generated by: -.I SiSU -.I 0.64.4 -of 2008w06/4 (2008\-02\-14) +<http://www.jus.uio.no/sisu> .BR -Ruby version: -.I ruby 1.8.6 (2007\-09\-24 patchlevel 111) \ [i486\-linux] - - -.TP -Other versions of this document: -.TP -manifest: <http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html> -.TP -html: <http://www.jus.uio.no/sisu/sisu_vim/toc.html> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf> -.TP -at: <http://www.jus.uio.no/sisu> -.TP -* Generated by: SiSU 0.64.4 of 2008w06/4 (2008-02-14) -.TP -* Ruby version: ruby 1.8.6 (2007-09-24 patchlevel 111) [i486-linux] -.TP -* Last Generated on: Thu Feb 14 02:44:14 +0000 2008 -.TP -* SiSU http://www.jus.uio.no/sisu +or man sisu diff --git a/man/man8/sisu.8 b/man/man8/sisu.8 deleted file mode 100644 index e3e676ae..00000000 --- a/man/man8/sisu.8 +++ /dev/null @@ -1,333 +0,0 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu manpage -.\" License: GPL 3 or later -.\" Notes: Process this file with -.\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" /[^\\][-'] -.\" :%s/\([^\\]\)\([-']\)/\1\\\2/c -.TH sisu 8 "October 26, 2006" "version 0.48" "CONFIGURATION and SETUP" -.SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.SH SYNOPSIS -.B sisu -.B [\-mhwpxXv...] [ -.I filename/wildcard -.B ] -.\"%% Description -.SH DESCRIPTION -A document publishing system, that from a simple single marked\-up document, -produces a multitude of output formats including: html, latex, pdf, info, and -sql output, which can be cross referenced as having the same document structure -and text object numbering, "object citation numbering". Features include its\' -simple syntax; the semantic tagging of documents; document management; built to -be associated with a revision control system; text object numbering for the -identification of a texts location in any of the output formats, easy skinning -on a site wide, or per document basis; granular search; a degree of future -proofing ... for more see -.I man 1 sisu -or -.I <http://www.jus.uio.no/sisu> -.PP -.B SiSU is a way of preparing, publishing, managing and searching documents. -.\"%% Installation -.SH INSTALLATION -.PP -Up to date information on SiSU downloads, and their installation should be -available from: -.I <http://www.jus.uio.no/sisu/SiSU/download.html> -or at: -.I <http://www.jus.uio.no/sisu/sisu_download/download.html> -.PP -There you should find links to the latest source tarball, and instructions on -how to install SiSU. -.PP -Sample marked up documents are are available at -.I /usr/share/doc/sisu/sisu_markup_samples/dfsg -or equivalent directory, or online, see -.I <http://www.jus.uio.no/sisu/SiSU/2.html> -.PP -.I man 1 sisu -has a syntax table along with processing commands. -.PP -SiSU also provides some help via the command: -.I sisu \-\-help -and selecting an appropriate subject, e.g. -.PP -.I sisu \-\-help commands -.PP -.I sisu \-\-help markup -.PP -.I sisu \-\-help headers -.PP -.I sisu \-\-help env -.PP -The rest of this note is on post installation setup -.\"%% Post Installation Setup -.SH Post Installation Setup \- Quick start -.PP - -After installation of sisu\-complete, move to the document samples directory, -.PP - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -.PP -[this is not where you would normally work but provides sample documents for -testing, you may prefer instead to copy the contents of that directory to a local -directory before proceeding] -.PP -and in that directory, initialise the output directory with the command -.PP -.I sisu \-CC -.PP -then run: -.PP -.I sisu \-1 free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -or the same: -.PP -.I sisu \-NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -look at output results, see the "sisu_manifest" page created for the document -.PP -for an overview of your current sisu setup, type: -.PP -.I sisu \-\-help env -.PP -or -.PP -.I sisu \-V -.PP -To generate a document from a remote url accessible location move to a -writable directory, (create a work directory and cd into it) as the file will -be downloaded there and e.g. -.PP -.I sisu \-1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst -.PP -.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst -.PP -examine source document, vim has syntax highlighting support -.PP -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -additional markup samples in -.I <http://www.jus.uio.no/sisu/SiSU/2.html> -.PP -it should also be possible to run sisu against sisupods (prepared zip files, -created by running the command sisu \-S [filename]), whether stored locally or -remotely. -.PP -.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip -.PP -there is a security issue associated with the running of document skins that -are not your own, so these are turned of by default, and the use of the -following command, which switches on the associated skin is not recommended: -.PP -.I sisu \-3 \-\-trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip -.PP -For help -.I man sisu -.PP -.I sisu \-\-help -.PP -.I sisu \-\-help env -for the way sisu "sees/maps" your system -.PP -.I sisu \-\-help commands -for list of commands and so on -.PP -.\"%% B. Generate a (local) document from a markup/work directory. -.B Document markup directory -.PP -Perhaps the easiest way to begin is to create a directory for sisu marked up -documents within your home directory, and copy the file structure (and document -samples) provided in the document sample directory: -.I mkdir ~/sisu_test -.PP -.I cd ~/sisu_test -.PP -.I cp \-a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. -.PP -.B \-\-\-\-\-\-\-\-\-\- -.PP -.B Tip: -the markup syntax examples may be of interest -.I <http://www.jus.uio.no/sisu/sample/> -.PP -.B Tip: -.I sisu \-U [sisu markup filename] -should printout the different possible outputs and where sisu would place them. -.PP -.B Tip: -if you want to toggle ansi color add -.I c -to your flags. -.PP -.B \-\-\-\-\-\-\-\-\-\- -.PP -.\"%% configuration files -.B SiSU configuration file search path is: -.PP -.I ./_sisu/sisurc.yaml -.PP -.I ~/.sisu/sisurc.yaml -.PP -.I /etc/sisu/sisurc.yaml -.PP -.\"%% Debian Installation Note -.SH Debian INSTALLATION Note -.PP -It is best you see -.I <http://www.jus.uio.no/sisu/SiSU/download.html#debian> -for up the most up to date information. -.PP -notes taken from the Debian control file (end edited), gives an idea of -additional packages that SiSU can make use of if available, (the -use/requirement of some of which are interdependent for specific actions by -SiSU): -.PP -Package: sisu -.PP -Depends: ruby (>= 1.8.2), libwebrick\-ruby, unzip, zip -.PP -Conflicts: vim\-sisu, sisu\-vim, sisu\-remote -.PP -Replaces: vim\-sisu, sisu\-vim -.PP -Recommends: sisu\-pdf, sisu\-sqlite, sisu\-postgresql, librmagick\-ruby, trang, -tidy, librexml\-ruby, openssl, rsync, openssh\-client \| lsh\-client, keychain, -hyperestraier, kdissert Suggests: rcs \| cvs, lv, texinfo, pinfo -.PP -Package: sisu\-complete -.PP -Depends: ruby (>= 1.8.2), sisu, sisu\-pdf, sisu\-postgresql, sisu\-sqlite -.PP -Recommends: hyperestraier -.PP -Package: sisu\-pdf -.PP -Depends: sisu, texlive\-latex\-base, texlive\-fonts\-recommended, -texlive\-latex\-recommended, texlive\-latex\-extra -.PP -Suggests: evince, xpdf -.PP -Package: sisu\-postgresql -.PP -Depends: sisu, libdbd\-pg\-ruby, libdbi\-ruby, libdbm\-ruby, postgresql -.PP -Recommends: libfcgi\-ruby -.PP -Package: sisu\-sqlite -.PP -Depends: sisu, sqlite, libdbd\-sqlite\-ruby, libdbi\-ruby, libdbm\-ruby -.PP -Recommends: libfcgi\-ruby -.PP -Package: sisu\-markup\-samples -.PP -Depends: sisu -.PP -.SH Package Description -.B sisu -.PP -Description: documents \- structuring, publishing in multiple formats and search -.PP -SiSU is a lightweight markup based, command line oriented, document -structuring, publishing and search framework for document collections. -.PP -With minimal preparation of a plain\-text, (UTF\-8) file, using its native markup -syntax in your text editor of choice, SiSU can generate various document -formats (most of which share a common object numbering system for locating -content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), -LaTeX, PDF files, and populate an SQL database with objects (roughly -paragraph\-sized chunks) so searches may be performed and matches returned with -that degree of granularity: your search criteria is met by these documents and -at these locations within each document. Object numbering is particularly -suitable for "published" works (finalized texts as opposed to works that are -frequently changed or updated) for which it provides a fixed means of reference -of content. Document outputs also share semantic meta\-data provided. -.PP -SiSU also provides concordance files, document content certificates and -manifests of generated output. -.PP -A vim syntax highlighting file and an ftplugin with folds for sisu markup is -provided, as are syntax highlighting files for kate, kwrite, gedit and -diakonos. Vim 7 includes syntax highlighting for SiSU. -.PP -man pages, and interactive help are provided. -.PP -Dependencies for various features are taken care of in sisu related packages. -The package sisu\-complete installs the whole of SiSU. -.PP -Additional document markup samples are provided in the package -sisu\-markup\-samples which is found in the non\-free archive the licenses for -the substantive content of the marked up documents provided is that provided -by the author or original publisher. -.PP -Homepage: <http://www.jus.uio.no/sisu> -.fi -.\"%% Configuration Files -.SH DOCUMENT RESOURCE CONFIGURATION -.B sisu -resource configuration information is obtained from sources (where they exist): -.\" preformatted text follows -.nf -.I ~/.sisu/sisurc.yaml -.I /etc/sisu/[sisu version]/sisurc.yaml -.I sisu program defaults -.fi -.PP -.\"%% Skins -.B Skins -.PP -default document appearance may be modified using skins contained in -sub\-directories located at the following paths: -.\" preformatted text follows -.nf -.I ./_sisu/skin -.I ~/.sisu/skin -.I /etc/sisu/skin -.fi -.PP -more specifically, the following locations (or their /etc/sisu equivalent) -should be used: -.PP -.I ~/.sisu/skin/doc -skins for individual documents; -.PP -.I ~/.sisu/skin/dir -skins for directories of matching names; -.PP -.I ~/.sisu/skin/site -site\-wide skin -modifying the site\-wide appearance of documents. -.PP -Usually all skin files are placed in the document skin directory: -.I ~/.sisu/skin/doc -with softlinks being made to the skins contained there from other skin -directories as required. -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on -.I SiSU -see: -.I <http://www.jus.uio.no/sisu> -.PP -or -.I man sisu -.\"%% Author -.SH AUTHOR -Ralph Amissah -.I <ralph@amissah.com> -or -.I <ralph.amissah@gmail.com> -.SH SEE ALSO -.BR sisu(1), -.BR sisu_examples(1), -.BR sisu_webrick(1), -.BR sisu_pdf(1) -.BR sisu_sqlite(1) -.BR sisu_postgresql(1) -.BR sisu_termsheet(1), |