cyberweb 0.4.174 → 0.5.225

data/doc/USAGE.md

@@ -9,17 +9,17 @@
     require 'cyberweb'
     require 'cyberweb/autoinclude' # This is the preferred way for .cgi files.
 
-== Using it in a project
+== Using the cyberweb project in another project
 
-We assume that you have successfully installed the Cyberweb project. Now
-you can use the commandline executable called "cyberweb" to generate
-a .cgi file.
+We assume that you have successfully installed the Cyberweb project at
+this point. Now you can use the commandline executable called "cyberweb"
+to generate a new .cgi file.
 
 Issue something like this:
 
     cyberweb test.cgi
 
-This will create a default skeleton for your project.
+This will create a default skeleton file for your project.
 
 The page will have a default title, and use a global <div> html tag for the
 main content. A prominent member of this main <div> will be a <h2> header.
@@ -46,10 +46,10 @@ You can also use a simplified approach to this.
 For instance, say you want to display all images in a given
 directory. The short way to do so would be:
 
-    #!/System/Index/bin/ruby -w
-    # Encoding: ISO-8859-1
+    #!/usr/bin/ruby -w
+    # Encoding: UTF-8
     # frozen_string_literal: true
-    # ======================================================================= #
+    # =========================================================================== #
     require 'cyberweb/autoinclude'
 
     doc {
@@ -57,8 +57,8 @@ directory. The short way to do so would be:
       display_all_images
     }
 
-A more complex (but also deprecated and disfavoured) example
-would be the following one:
+A more complex (but also deprecated and disfavoured) example would
+be the following one:
 
     w.t = 'SELF_NO_EXT' # Disable Extension-name.
     w.css_style = :template1 # Is shorter. The templates can be found in: CSS/default.css
@@ -76,8 +76,8 @@ would be the following one:
     hfin
 
 You can see the difference - the second variant allows you to be more
-explicit, the first variant attempts to infer from the given information
-what should happen.
+explicit, with more control, whereas the first variant attempts to
+infer from the given information what should happen.
 
 Do note that the call to .t aka .title will be optional if you have set
 the configuration option set_title_automatically to true in the
@@ -90,7 +90,7 @@ of April 2016.
 
 If you wish to display all images from a certain directory, do this:
 
-    display_all_images :from => 'home/x/images/NJOY/'
+    display_all_images from: 'home/x/images/njoy/'
 
 To use Frames, do:
 
@@ -107,7 +107,7 @@ To use Frames, do:
 
 To use Markdown, do something like this here (markdown tag):
 
-    markdown('/home/x/DATA/PC/MARKDOWN/example.md')
+    markdown('/home/x/data/PC/MARKDOWN/example.md')
     markdown('*md')
     markdown # defaults to all .md files.
 
@@ -119,7 +119,7 @@ To use an autogenerated Sitemap, do (sitemap tag):
 
 To use Textile, do something like this here:
 
-    textile '/home/x/DATA/PC/TEXTILE/test.textile'
+    textile '/home/x/data/PC/TEXTILE/test.textile'
 
 To count, do:
 
@@ -190,7 +190,7 @@ by doing:
 
 Example if you have a local .cgi script:
 
-    http://localhost/SCIENCE/CHEMISTRY/CHEMISTRY.cgi?pdf
+    http://localhost/science/chemistry/chemistry.cgi?pdf
 
 You can also link from within a page to this pdf-generation,
 by doing:

data/doc/configuration/configuration.md

@@ -13,7 +13,7 @@ commandline, by issuing:
     cyberweb edit
     cyberweb --edit
 
-This will usually load the editor called "vim". You can also change
+This will usually make use of the editor called "vim". You can change
 this setting, but you have to modify the following file for this:
 
     cyberweb/toplevel_methods/edit_configuration_file.rb
@@ -21,3 +21,5 @@ this setting, but you have to modify the following file for this:
 Simply change the entry at:
 
     use_this_editor = 'vim'
+
+to your preferred editor instead.

data/doc/deprecations.md

@@ -2,9 +2,12 @@
 # === deprecations.md
 # =========================================================================== #
 
-This file will keep some deprecations that were made over the years. It
-shall serve as an explanation why this code was in use at one point in
-time, and why it was removed again.
+This file will keep some deprecations that were made over the years with 
+regards to the cyberweb project.
+
+It shall serve as an explanation why this code was in use at one point
+in time, and why it was removed again. This may help us if we want to
+plan for future changes to the project.
 
 # =========================================================================== #
 # === PREDEFINED_CSS (deprecated as of 23.05.2021)
@@ -16,11 +19,11 @@ I sometimes used it to set a default body font-size.
 
 At some later moment I considered wanting to switch to template-based
 layouts, with the ability to allow multiple, pre-defined layouts where
-you can use :symbols to switch between them. 
+you can simply use :symbols to switch between them. 
 
-On **28.11.2008** I have disabled this completely. There needs to be
-another way to set and use it. The current approach is not flexible
-enough.
+On **28.11.2008** I have disabled this old approach completely. There
+needs to be another way to set and use it. The current approach is
+not flexible enough.
 
 What if you dont want to use them? My suggestion used to be to use this
 variant instead:
@@ -29,4 +32,7 @@ variant instead:
   w.body = :tech_template
   w.body = :rose_template
 
+That way we could quickly style a whole webpage or subpage in this
+regard.
+
 PREDEFINED_CSS = 'body { font-size: 95%; }'

data/doc/{DOCUMENTATION_FOR_CYBERSPRAWL.md → documentation_for_cybersprawl.md}

@@ -1,11 +1,14 @@
 # =========================================================================== #
 # Welcome to Cybersprawl, the WebApp of WebObject.
+#
+# Note that since as of 2021 this is slightly out-of-date. At a future
+# point it will be decided what to do with cybersprawl; possibly it
+# will just become the web-forum for cyberweb as-is.
 # =========================================================================== #
 
 Cybersprawl is a WebApp generator for ruby.
 
-It is based on Cyberweb, which is a general web framework written
-in Ruby.
+It is based on Cyberweb, which is a general web framework written in Ruby.
 
 Specific Features of Cybersprawl:
 
@@ -35,8 +38,8 @@ Specific Features of Cybersprawl:
  - Use graphics easily by providing access to "typical" images
    (see ADMIN.cgi#std_images for a list of what is available)
 
- - Use project collaboration (see at Basecamp to get an idea what
-   this means, i.e. IRC-like communication.)
+ - Use "project collaboration tools" (see at Basecamp to get an idea
+   what this means, i.e. IRC-like communication.)
   
  - Provide bindings for many external components.
 

data/doc/future_design_goals.md

@@ -0,0 +1,33 @@
+This file just contains some random ideas what/how to improve
+the Cyberweb project in the long run. Sort of a "todo" list,
+but without too much code (yet) to implement these ideas.
+
+The entries will be kept listed via numbers, to make it 
+simpler to keep track of what has all been suggested so far:
+
+-------------------------------------------------------------------------------
+
+(1) Add a method called "index" for subclasses that wish to
+    render content (e. g. html content) as view to the visitor.
+    Index is the method that may be called by default when 
+    this class is served to the browser.
+
+(2) Allow "actionable" HTML tags, such as:
+
+div(id: 'foo_bar') {
+  p {
+    e 'This is a nice webpage.'
+  }
+}
+div.on_clicked {
+  :grey_background # Add a grey background in this case.
+}
+
+In order for this to work, though, we need to add "surrogate"
+HTML tags. The last HTML tag that is used like this always
+has to be made available. This may require a larger re-design
+of cyberweb, so for the time being (October 2021) this will
+be postponed.
+
+
+-------------------------------------------------------------------------------

data/doc/html_characters.md

@@ -4,12 +4,12 @@
 # This file contains some of the "german umlauts".
 # =========================================================================== #
 
-                UTF      ISO
+                  UTF      ISO
 
-ä 	a Umlaut 	ä 	ä
-Ä 	A Umlaut 	Ä 	Ä
+  ä   a Umlaut   ä   ä
+  Ä   A Umlaut   Ä   Ä
 
-ö 	o Umlaut 	ö 	ö
-Ö 	O Umlaut 	Ö 	Ö
-ü 	u Umlaut 	ü 	ü
-Ü 	U Umlaut 	Ü 	Ü
+  ö   o Umlaut   ö   ö
+  Ö   O Umlaut   Ö   Ö
+  ü   u Umlaut   ü   ü
+  Ü   U Umlaut   Ü   Ü

data/doc/{JQUERY.md → jquery/jquery.md}

@@ -13,13 +13,15 @@ Let's show a specific usage example for the call to the drag() method:
 
 First, create or define an id such a in this way:
  
-    div('','some_id_here')
+    div('','some_id_here') {
+    }
 
-  or simpler
+or simpler and possibly more elegant:
 
-    div(id: some_id_here)
+    div(id: some_id_here) {
+    }
 
-Then:
+Then call:
 
     drag :some_id_here
 
@@ -53,7 +55,7 @@ HTML element in question.
 
 In our example here, the ID of a div() aka a HTML <div> element. That
 element will have a specific id, if you assigned one.
-  
+
 Also note that some alternative syntaxes to the above example exist.
 
 For instance:
@@ -67,7 +69,7 @@ a Hash.
 Another alternative to the above, rather than forcing you to pass in
 the specific ID, you can simply point to the last id used, like by
 doing this:
-  
+
     drag :last_id_used
     drag :last_id
 
@@ -76,7 +78,7 @@ on-the-fly if the elements start with the string 'drag_', as
 identifier to their ID elements.
 
 This can happen like so, in the following two equivalent examples:
-  
+ 
     div('', 'drag_this_div')
     div(id: 'drag_this_div')
 
@@ -88,15 +90,20 @@ variant usually, even in the year 2021.
 For Images, you can also use the following variant here:
 
     img('foobar.png', 'drag_#NAME#')
-  
+ 
 This will use the name of the file in question.
 
 Sometime later in 2015, I have also added this variant:
-  
+ 
     img 'foobar.png','', :drag
 
+Or, even shorter:
+
+    dimg 'foobar.png'
+
 That means that you can pass the symbol :drag to the ID, which
-means that we wish to drag this image.
+means that we wish to drag this image. The "d" stands for
+"drag".
 
 Pick a variant that is fitting to your personal preference.
 
@@ -108,8 +115,8 @@ jquery, irrelevant over what value the configuration holds.
 
 Examples for the latter:
 
-    http://localhost/MISC/ROEBE_TEMPEL.cgi?use_jquery=1
-    http://localhost/MISC/ROEBE_TEMPEL.cgi?use_jquery
+    http://localhost/misc/ROEBE_TEMPEL.cgi?use_jquery=1
+    http://localhost/misc/ROEBE_TEMPEL.cgi?use_jquery
 
 You can enable or disable jquery through the configuration
 file by the way.
@@ -120,3 +127,4 @@ Note that you can download jquery via this module method:
 
 This will use wget and download into the current working
 directory.
+

data/doc/{MOUSE.md → mouse.md}

@@ -45,15 +45,7 @@ The mouse component will require `libxdo`. Libxdo is part of `xdotool`.
 
 Details and installation instructions can be found at:
 
-    http://www.semicomplete.com/projects/xdotool/
-
-Build instructions for Ubuntu:
-
-    $ sudo apt-get install xorg-dev
-    $ wget http://semicomplete.googlecode.com/files/xdotool-2.20100818.3004.tar.gz
-    $ tar xzvf xdotool*.tar.gz
-    $ cd xdotool-*
-    $ sudo make all install
+    https://www.semicomplete.com/projects/xdotool/
 
 Testing
 -------

data/doc/{RENDER_WEB_BASE.md → render_web_base.md}

@@ -1,5 +1,5 @@
---- This document is mostly to see if we can simplify HTML and CSS
-    with a more lightweight template language. It will probably
+--- This document is mostly used to to see whether we could simplify HTML and
+    CSS with a more lightweight template language. It will probably
     never be implemented as-is, but serves as an "idea-generator".
 
 <!DOCTYPE html>
@@ -29,7 +29,6 @@ p:  This is a paragraph.
 div: This is another section # And it comes with css_classes: padlem mar5em
 
 --------------------------
-
 VERSUS:
 
 w {
@@ -43,4 +42,12 @@ doc {
 
 }
 
---------------------------
+--------------------------
+VERSUS:
+
+w('Page Title') {
+
+doc {
+  h1 { ee 'This is a heading.' }
+  p { ee 'This is a paragraph.' }
+}}