giblish 0.8.0 → 1.0.0

data/docs/concepts/text_search_im/cgi-search_request.svg

@@ -0,0 +1,397 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="581.25px" preserveAspectRatio="none" style="width:657px;height:581px;background:#00000000;" version="1.1" viewBox="0 0 657 581" width="657.2917px" zoomAndPan="magnify"><defs/><g><rect height="45.0846" rx="4.1667" ry="4.1667" style="stroke:#BABDBF;stroke-width:1.0416666666666667;fill:none;" width="335.4167" x="165.1042" y="14.5833"/><text fill="#2FA4E7" font-family="Verdana" font-size="20.8333" lengthAdjust="spacing" textLength="308.3333" x="178.6458" y="44.338">Using CGI for search requests</text><rect fill="#EEEEEE" height="497.3633" rx="4.1667" ry="4.1667" style="stroke:#868E96;stroke-width:1.0416666666666667;" width="511.4583" x="112.5" y="71.1263"/><text fill="#343A40" font-family="Verdana" font-size="12.5" font-weight="bold" lengthAdjust="spacing" textLength="218.75" x="258.8542" y="87.9374">The Document Hosting Server</text><line style="stroke:#BABDBF;stroke-width:2.0833333333333335;stroke-dasharray:5.0,5.0;" x1="34.375" x2="34.375" y1="173.1445" y2="574.7396"/><line style="stroke:#BABDBF;stroke-width:2.0833333333333335;stroke-dasharray:5.0,5.0;" x1="207.2917" x2="207.2917" y1="173.1445" y2="574.7396"/><line style="stroke:#BABDBF;stroke-width:2.0833333333333335;stroke-dasharray:5.0,5.0;" x1="408.3333" x2="408.3333" y1="173.1445" y2="574.7396"/><line style="stroke:#BABDBF;stroke-width:2.0833333333333335;stroke-dasharray:5.0,5.0;" x1="568.75" x2="568.75" y1="173.1445" y2="574.7396"/><text fill="#2FA4E7" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="42.7083" x="10.4167" y="164.9882">Viewer</text><ellipse cx="34.8958" cy="92.9688" rx="8.3333" ry="8.3333" style="stroke:#2FA4E7;stroke-width:2.0833333333333335;fill:none;"/><path d="M34.8958,101.3021 L34.8958,129.4271 M21.3542,109.6354 L48.4375,109.6354 M34.8958,129.4271 L21.3542,145.0521 M34.8958,129.4271 L48.4375,145.0521 " fill="none" style="stroke:#2FA4E7;stroke-width:2.0833333333333335;"/><rect height="39.5508" rx="4.1667" ry="4.1667" style="stroke:#2FA4E7;stroke-width:1.5625;fill:none;" width="98.9583" x="158.3333" y="132.5521"/><text fill="#2FA4E7" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="73.9583" x="170.8333" y="156.6549">Web Server</text><rect height="68.6523" rx="4.1667" ry="4.1667" style="stroke:#2FA4E7;stroke-width:1.5625;fill:none;" width="115.625" x="351.0417" y="103.4505"/><text fill="#2FA4E7" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="90.625" x="363.5417" y="127.5533">Search Result</text><text fill="#2FA4E7" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="66.6667" x="375.5208" y="142.1041">Generator</text><text fill="#2FA4E7" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="31.25" x="393.2292" y="156.6549">(CGI)</text><text fill="#2FA4E7" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="84.375" x="523.9583" y="164.9882">Search index</text><path d="M550.5208,110.6771 C550.5208,100.2604 569.2708,100.2604 569.2708,100.2604 C569.2708,100.2604 588.0208,100.2604 588.0208,110.6771 L588.0208,137.7604 C588.0208,148.1771 569.2708,148.1771 569.2708,148.1771 C569.2708,148.1771 550.5208,148.1771 550.5208,137.7604 L550.5208,110.6771 " style="stroke:#2FA4E7;stroke-width:1.5625;fill:none;"/><path d="M550.5208,110.6771 C550.5208,121.0938 569.2708,121.0938 569.2708,121.0938 C569.2708,121.0938 588.0208,121.0938 588.0208,110.6771 " fill="none" style="stroke:#2FA4E7;stroke-width:1.5625;"/><path d="M297.9167,192.9362 L297.9167,248.1445 A4.1667,4.1667 0 0 0 302.0833,252.3112 L515.625,252.3112 A4.1667,4.1667 0 0 0 519.7917,248.1445 L519.7917,199.1862 L509.375,188.7695 L302.0833,188.7695 A4.1667,4.1667 0 0 0 297.9167,192.9362 " style="stroke:#033C73;stroke-width:1.0416666666666667;fill:none;"/><path d="M509.375,188.7695 L509.375,197.1029 A2.0833,2.0833 0 0 0 511.4583,199.1862 L519.7917,199.1862 L509.375,188.7695 " style="stroke:#033C73;stroke-width:1.0416666666666667;fill:none;"/><text fill="#033C73" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="183.3333" x="309.375" y="210.789">The CGI script could use the</text><text fill="#033C73" font-family="monospace" font-size="12.5" lengthAdjust="spacing" textLength="167.7083" x="309.375" y="225.3398">Giblish::RequestManager</text><text fill="#033C73" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="189.5833" x="309.375" y="239.8905">class to do most of the work.</text><polygon fill="#2FA4E7" points="195.3125,300.0651,205.7292,304.2318,195.3125,308.3984,199.4792,304.2318" style="stroke:#2FA4E7;stroke-width:1.0416666666666667;"/><line style="stroke:#2FA4E7;stroke-width:3.125;" x1="34.8958" x2="201.5625" y1="304.2318" y2="304.2318"/><text fill="#343A40" font-family="Verdana" font-size="12.5" font-weight="bold" lengthAdjust="spacing" textLength="8.3333" x="47.3958" y="286.7167">1</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="87.5" x="70.3125" y="279.4413">Search Query</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="76.0417" x="70.3125" y="293.9921">(html POST)</text><polygon fill="#2FA4E7" points="396.3542,354.1667,406.7708,358.3333,396.3542,362.5,400.5208,358.3333" style="stroke:#2FA4E7;stroke-width:1.0416666666666667;"/><line style="stroke:#2FA4E7;stroke-width:3.125;" x1="207.8125" x2="402.6042" y1="358.3333" y2="358.3333"/><text fill="#343A40" font-family="Verdana" font-size="12.5" font-weight="bold" lengthAdjust="spacing" textLength="8.3333" x="220.3125" y="340.8183">2</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="66.6667" x="243.2292" y="333.5429">Invoke CGI</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="36.4583" x="243.2292" y="348.0937">script</text><polygon fill="#2FA4E7" points="556.7708,408.2682,567.1875,412.4349,556.7708,416.6016,560.9375,412.4349" style="stroke:#2FA4E7;stroke-width:1.0416666666666667;"/><line style="stroke:#2FA4E7;stroke-width:3.125;" x1="408.8542" x2="563.0208" y1="412.4349" y2="412.4349"/><text fill="#343A40" font-family="Verdana" font-size="12.5" font-weight="bold" lengthAdjust="spacing" textLength="8.3333" x="421.3542" y="394.9198">3</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="71.875" x="444.2708" y="387.6444">Search the</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="34.375" x="444.2708" y="402.1952">index</text><polygon fill="#2FA4E7" points="219.2708,480.0456,208.8542,484.2122,219.2708,488.3789,215.1042,484.2122" style="stroke:#2FA4E7;stroke-width:1.0416666666666667;"/><line style="stroke:#2FA4E7;stroke-width:3.125;" x1="213.0208" x2="407.8125" y1="484.2122" y2="484.2122"/><text fill="#343A40" font-family="Verdana" font-size="12.5" font-weight="bold" lengthAdjust="spacing" textLength="8.3333" x="230.7292" y="466.6972">4</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="84.375" x="253.6458" y="459.4218">Return serch</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="80.2083" x="253.6458" y="473.9726">result (html)</text><path d="M413.5417,430.1432 L413.5417,499.9349 A4.1667,4.1667 0 0 0 417.7083,504.1016 L645.8333,504.1016 A4.1667,4.1667 0 0 0 650,499.9349 L650,436.3932 L639.5833,425.9766 L417.7083,425.9766 A4.1667,4.1667 0 0 0 413.5417,430.1432 " style="stroke:#033C73;stroke-width:1.0416666666666667;fill:none;"/><path d="M639.5833,425.9766 L639.5833,434.3099 A2.0833,2.0833 0 0 0 641.6667,436.3932 L650,436.3932 L639.5833,425.9766 " style="stroke:#033C73;stroke-width:1.0416666666666667;fill:none;"/><text fill="#033C73" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="188.5417" x="425" y="447.996">Giblish contains help classes</text><text fill="#033C73" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="200" x="425" y="462.5468">that provide most of the heavy</text><text fill="#033C73" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="152.0833" x="425" y="477.0976">lifting for retrieving and</text><text fill="#033C73" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="188.5417" x="425" y="491.6484">formatting the search result.</text><polygon fill="#2FA4E7" points="46.3542,551.8229,35.9375,555.9896,46.3542,560.1563,42.1875,555.9896" style="stroke:#2FA4E7;stroke-width:1.0416666666666667;"/><line style="stroke:#2FA4E7;stroke-width:3.125;" x1="40.1042" x2="206.7708" y1="555.9896" y2="555.9896"/><text fill="#343A40" font-family="Verdana" font-size="12.5" font-weight="bold" lengthAdjust="spacing" textLength="8.3333" x="57.8125" y="538.4745">5</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="93.75" x="80.7292" y="531.1991">return  search</text><text fill="#343A40" font-family="Verdana" font-size="12.5" lengthAdjust="spacing" textLength="37.5" x="80.7292" y="545.7499">result</text><!--MD5=[d106587639b2b6f3746ea7123ebb446d]
+@startuml
+!theme cerulean-outline
+' !theme spacelab
+hide footbox
+autonumber
+
+title "Using CGI for search requests"
+
+actor       Viewer       as Vi
+
+box "The Document Hosting Server" #EEEEEE
+participant "Web Server" as Webserv
+participant "Search Result\nGenerator\n(CGI)"   as Searcher
+note over of Searcher
+  The CGI script could use the
+  ""Giblish::RequestManager""
+  class to do most of the work.
+end note
+database "Search index"   as Index
+end box
+
+Vi -> Webserv     : Search Query\n(html POST)
+Webserv -> Searcher : Invoke CGI\nscript
+Searcher -> Index : Search the\nindex
+Searcher -> Webserv : Return serch\nresult (html)
+note right
+  Giblish contains help classes 
+  that provide most of the heavy 
+  lifting for retrieving and
+  formatting the search result.
+end note
+Webserv -> Vi  : return  search\nresult
+@enduml
+
+@startuml
+
+
+
+skinparam backgroundColor transparent
+skinparam useBetaStyle false
+
+
+
+
+
+
+
+skinparam defaultFontName       "Verdana"
+skinparam defaultFontSize       12
+skinparam dpi                   100
+skinparam shadowing             false
+skinparam roundcorner           8
+skinparam ParticipantPadding    40
+skinparam BoxPadding            40
+skinparam Padding               5
+skinparam ArrowColor            #868E96
+skinparam stereotype {
+    CBackgroundColor #EDF0F2
+    CBorderColor #BABDBF
+    ABackgroundColor #8FB961
+    ABorderColor $SUCCESS_DARK
+    IBackgroundColor #D2494E
+    IBorderColor $DANGER_DARK
+    EBackgroundColor #E47833
+    EBorderColor $WARNING_DARK
+    NBackgroundColor #35638F
+    NBorderColor $INFO_DARK
+}
+skinparam title {
+	FontColor	                 #2FA4E7
+	BorderColor	                 #BABDBF
+	FontSize	    	         20
+	BorderRoundCorner            8
+	BorderThickness 	         1
+	BackgroundColor              transparent
+}
+
+skinparam legend {
+	BackgroundColor transparent
+	BorderColor #BABDBF
+	FontColor #343A40
+}
+
+skinparam swimlane {
+	BorderColor #033C73
+	BorderThickness 2
+	TitleBackgroundColor  #EDF0F2-#E9ECEF
+	TitleFontColor #2FA4E7
+}
+
+
+skinparam activity {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	BarColor #73A839
+	StartColor #033C73
+	EndColor #033C73
+	DiamondBackgroundColor transparent
+  	DiamondBorderColor #BABDBF
+	DiamondFontColor #BABDBF
+}
+
+
+skinparam participant {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	ParticipantBorderThickness 2
+}
+
+
+skinparam actor {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam arrow {
+	Thickness 3
+	Color #2FA4E7
+	FontColor #343A40
+}
+
+
+skinparam sequence {
+	BorderColor #2FA4E7
+	TitleFontColor #2FA4E7
+	BackgroundColor transparent
+	StartColor #2FA4E7
+	EndColor #2FA4E7
+	BoxBackgroundColor transparent
+	BoxBorderColor #868E96
+	BoxFontColor #343A40
+	LifeLineBorderColor #BABDBF
+	LifeLineBorderThickness 2
+	LifeLineBackgroundColor transparent
+	GroupBorderColor #868E96
+	GroupFontColor #343A40
+	GroupHeaderFontColor #033C73
+	DividerBackgroundColor transparent
+    DividerBorderColor #868E96
+    DividerBorderThickness 2
+    DividerFontColor #343A40
+	ReferenceBackgroundColor transparent
+	ReferenceBorderColor #868E96
+	ReferenceFontColor #343A40
+	ReferenceHeaderFontColor #033C73
+}
+
+
+skinparam partition {
+	BorderColor #2FA4E7
+	FontColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam collections {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam control {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam entity {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam boundary {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam agent {
+	BackgroundColor transparent
+	BorderColor #999999
+	FontColor #333333
+}
+
+
+skinparam note {
+	BorderThickness 1
+	BackgroundColor transparent
+	BorderColor #033C73
+	FontColor #033C73
+}
+
+
+skinparam artifact {
+	BackgroundColor transparent
+	BorderColor #868E96
+	FontColor #868E96
+}
+
+
+skinparam component {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam interface {
+	BackgroundColor  transparent
+	BorderColor  #C71C22
+	FontColor #343A40
+}
+
+
+skinparam storage {
+	BackgroundColor transparent
+  	BorderColor #DD5600
+	FontColor #DD5600
+}
+
+
+skinparam node {
+	BackgroundColor transparent
+	BorderColor #343A40
+	FontColor #343A40
+}
+
+
+skinparam cloud {
+	BackgroundColor #F2FCFE-#eeeeee
+	BorderColor #F2FCFE
+	FontColor #343A40
+}
+
+
+skinparam database {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam class {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	FontColor #F8F9FA
+	HeaderBackgroundColor #2FA4E7-#2683B9
+	StereotypeFontColor #343A40
+	BorderThickness 1
+	AttributeFontColor #343A40
+	AttributeFontSize 11
+}
+
+
+skinparam object {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	StereotypeFontColor #343A40
+	BorderThickness 1
+	AttributeFontColor #BABDBF
+	AttributeFontSize 11
+}
+
+
+skinparam usecase {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	BorderThickness 2
+	StereotypeFontColor #2FA4E7
+}
+
+
+skinparam rectangle {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	BorderThickness 2
+	StereotypeFontColor #2FA4E7
+}
+
+
+skinparam package {
+	BackgroundColor transparent
+  	BorderColor #2FA4E7
+	FontColor #2FA4E7
+	BorderThickness 2
+}
+
+
+skinparam folder {
+	BackgroundColor transparent
+  	BorderColor #DD5600
+	FontColor #DD5600
+	BorderThickness 2
+}
+
+
+skinparam frame {
+	BackgroundColor transparent
+  	BorderColor #033C73
+	FontColor #033C73
+	BorderThickness 2
+}
+
+
+skinparam state {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+	StartColor #033C73
+	EndColor #033C73
+	AttributeFontColor #BABDBF
+	AttributeFontSize 11
+}
+
+
+skinparam queue {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+skinparam card {
+	BackgroundColor transparent
+	BorderColor #033C73
+	FontColor #033C73
+}
+
+
+skinparam file {
+	BackgroundColor transparent
+	BorderColor #868E96
+	FontColor #868E96
+}
+
+
+skinparam stack {
+		FontColor #2FA4E7
+	BorderColor #2FA4E7
+	BackgroundColor transparent
+}
+
+
+
+hide footbox
+autonumber
+
+title "Using CGI for search requests"
+
+actor       Viewer       as Vi
+
+box "The Document Hosting Server" #EEEEEE
+participant "Web Server" as Webserv
+participant "Search Result\nGenerator\n(CGI)"   as Searcher
+note over of Searcher
+  The CGI script could use the
+  ""Giblish::RequestManager""
+  class to do most of the work.
+end note
+database "Search index"   as Index
+end box
+
+Vi -> Webserv     : Search Query\n(html POST)
+Webserv -> Searcher : Invoke CGI\nscript
+Searcher -> Index : Search the\nindex
+Searcher -> Webserv : Return serch\nresult (html)
+note right
+  Giblish contains help classes 
+  that provide most of the heavy 
+  lifting for retrieving and
+  formatting the search result.
+end note
+Webserv -> Vi  : return  search\nresult
+@enduml
+
+PlantUML version 1.2021.7(Sun May 23 14:40:07 CEST 2021)
+(GPL source distribution)
+Java Runtime: OpenJDK Runtime Environment
+JVM: OpenJDK 64-Bit Server VM
+Default Encoding: UTF-8
+Language: en
+Country: US
+--></g></svg>

data/docs/concepts/text_search_im/search_request.puml

@@ -0,0 +1,40 @@
+@startuml
+!theme cerulean-outline
+hide footbox
+autonumber
+
+title "Using a Passenger web-app for search requests"
+
+actor       Viewer       as Vi
+
+box "Document-hosting Server" #EEEEEE
+participant "Web Server" as Webserv
+participant "Passenger"   as Pass
+participant "Search script\n(Web app)"   as Searcher
+note over of Searcher
+  This could eg be a
+  sinatra-based application 
+  that use the 
+  ""Giblish::RequestManager""
+  class.
+end note
+database "Search index"   as Index
+end box
+
+Vi -> Webserv     : Search Query\n(html POST)
+Webserv -> Pass : hand over\nPOST request
+Pass -> Searcher : hand over\nPOST request
+Searcher -> Index : Search the\nindex
+Searcher -> Pass : Return search\nresult (html)
+note right
+  Giblish contains help 
+  classes fthat provide 
+  most of the heavy lifting 
+  for retrieving and formatting
+  the search result.
+end note
+Pass -> Webserv : Return search\nresult (html)
+Webserv -> Vi  : Return search\nresult (html)
+@enduml
+
+