diff --git a/doc/clog-manual.html b/doc/clog-manual.html index e4fb5b5..41f1a90 100644 --- a/doc/clog-manual.html +++ b/doc/clog-manual.html @@ -50,20 +50,21 @@
  • 13 CLOG Style Blocks
  • 14 CLOG Form Objects
  • 15 CLOG Canvas Objects
  • -
  • 16 CLOG Multimedia Objects
  • -
  • 17 CLOG Auth Objects
  • -
  • 18 CLOG GUI Objects
  • -
  • 19 CLOG Web Objects
  • -
  • 20 CLOG Web DBI
  • -
  • 21 CLOG Web Site Themes
  • -
  • 22 CLOG Body Objects
  • -
  • 23 CLOG Window Objects
  • -
  • 24 CLOG Document Objects
  • -
  • 25 CLOG Location Objects
  • -
  • 26 CLOG Navigator Objects
  • -
  • 27 CLOG jQuery Objects
  • -
  • 28 CLOG Helper Functions
  • -
  • 29 CLOG Framework internals and extensions
  • +
  • 16 CLOG WebGL Objects
  • +
  • 17 CLOG Multimedia Objects
  • +
  • 18 CLOG Auth Objects
  • +
  • 19 CLOG GUI Objects
  • +
  • 20 CLOG Web Objects
  • +
  • 21 CLOG Web DBI
  • +
  • 22 CLOG Web Site Themes
  • +
  • 23 CLOG Body Objects
  • +
  • 24 CLOG Window Objects
  • +
  • 25 CLOG Document Objects
  • +
  • 26 CLOG Location Objects
  • +
  • 27 CLOG Navigator Objects
  • +
  • 28 CLOG jQuery Objects
  • +
  • 29 CLOG Helper Functions
  • +
  • 30 CLOG Framework internals and extensions
  • [in package CLOG]
    @@ -95,15 +96,8 @@ frameworks and website frameworks. The CLOG package starts up the connectivity to the browser or other websocket client (often a browser embedded in a native template application.)

    -

    STATUS: CLOG is complete and all work is on higher order additions, -such as full desktop over the web, database tools,etc. See below for -some enhacements being worked on. CLOG is actually based on GNOGA, a -framework I wrote for Ada in 2013 and used in commercial production -code for the last 8+ years, i.e. the techniques CLOG uses are solid -and proven.

    - -

    CLOG is being actively extended daily. Check the github discussion -boards for the latest.

    +

    STATUS: CLOG's API is mature and stable. Tools and new plugins always in +the works. Check the github discussion boards for the latest.

    Some potential applications for CLOG:

    @@ -362,29 +356,38 @@ properties (to use for :property) are based on the event type.

    + +

    +

    + +

    @@ -687,6 +690,16 @@ lisp and an HTML DOM element.

    CLOG-Obj - Low Level

    +

    +

    + + +

    @@ -786,6 +799,16 @@ flushed with +

    + + +

    @@ -1506,13 +1529,13 @@ special key + Access_Key

    The special key per browser and platform is:

    -
    Browser              Windows       Linux           Mac
    ------------------    -------       -----           ---
    -Internet Explorer     [Alt]         N/A            N/A
    -Chrome                [Alt]        [Alt]     [Control][Alt]
    -Firefox           [Alt][Shift] [Alt][Shift]  [Control][Alt]
    -Safari                [Alt]         N/A      [Control][Alt]
    -Opera 15+             [Alt]        [Alt]          [Alt]
    +
    Browser              Windows     Linux          Mac
    +-----------------    -------     -----          ---
    +Internet Explorer     Alt         N/A           N/A
    +Chrome                Alt         Alt       Control|Alt
    +Firefox             Alt|Shift   Alt|Shift   Control|Alt
    +Safari                Alt         N/A       Control|Alt
    +Opera 15+             Alt         Alt           Alt
     
    @@ -1932,12 +1955,12 @@ flex - Turn this item in to a flexbox container. The flexbox order - sets visual item order in flexbox align-self - override flexbox's align-items for item - :flex-start [--- ] - :flex-end [ ---] - :center [ --- ] - :space-between [- - -] - :space-around [ - - - ] - :space-evenly [ - - - ] + :flex-start (--- ) + :flex-end ( ---) + :center ( --- ) + :space-between (- - -) + :space-around ( - - - ) + :space-evenly ( - - - ) grid - Turn this item in to a grid container block level. The grid properties to adjust for container are: @@ -2611,7 +2634,7 @@ is relative to origin of: padding-box|border-box|content-box

  • [generic-function] BACKGROUND-REPEAT CLOG-ELEMENT

    Get/Setf background-repeat. repeat-x | repeat-y | - repeat | space | round | no-repeat {1,2}

  • +( repeat | space | round | no-repeat ) {1,2}

    @@ -2927,6 +2950,40 @@ on browser.

    simulate click.

    +

    +

    + + + +

    +

    + + + +

    +

    + + +

    CLOG-Element - DOM Traversal Methods

    @@ -4617,6 +4674,15 @@ if :HTML-ID "myid" then the HTML-ID for cent

    Returns the bottom panel of a clog-panel-box-layout object.

    +

    +

    + + +

    @@ -5397,7 +5463,7 @@ optionally fill in with contents of data-list.

    -

    +

    15 CLOG Canvas Objects

    @@ -5438,124 +5504,164 @@ optionally fill in with contents of data-list.

    Create a new CLOG-Context2d from a CLOG-Canvas

    -

    -

    +

    CLOG-Canvas - Properties

    + +

    +

    -

    -

    +

    +

    - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - -

    +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + +

    @@ -5567,9 +5673,9 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    @@ -5583,7 +5689,7 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    @@ -5592,118 +5698,12 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - - -

    -

    - - +

    CLOG-Canvas - Methods

    @@ -5723,6 +5723,114 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    Adds an arc to the current path.

    +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + +

    @@ -5732,6 +5840,132 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    Adds an elliptical arc to the current path.

    +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + +

    @@ -5741,40 +5975,13 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    Adds a rectangle to the current path.

    -

    -

    +

    +

    - -

    -

    - - - -

    -

    - - - -

    -

    - -

    @@ -5786,12 +5993,1617 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font

    Restore canvas from stack

    +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-Canvas-Gradient

    + +

    +

    + + + +

    +

    + + + +

    CLOG-Image-Data

    + +

    +

    + + + +

    +

    + + + +

    CLOG-Matrix

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-Path2d

    + +

    +

    + + + +

    +

    + + + +

    CLOG-Text-Metrics

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + +

    + +

    16 CLOG WebGL Objects

    + +
    [in package CLOG-WEBGL]
    + +

    CLOG-WebGL - Class for CLOG WebGL objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Active-Info - Class for CLOG WebGL Active Info objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Shader - Class for CLOG WebGL-Shader objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Program - Class for CLOG WebGL-Program objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Buffer - Class for CLOG WebGL-Buffer objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Vertex-Array - Class for CLOG WebGL-Vertex-Array objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Frame-Buffer - Class for CLOG WebGL-Frame-Buffer objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Render-Buffer - Class for CLOG WebGL-Render-Buffer objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    CLOG-WebGL-Texture - Class for CLOG WebGL-Texture objects

    + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + + +

    +

    + + +

    -

    +

    -

    16 CLOG Multimedia Objects

    +

    17 CLOG Multimedia Objects

    CLOG-Multimedia - Base Class for CLOG multimedia objects

    @@ -6237,7 +8049,7 @@ is nil unbind the event.

    -

    17 CLOG Auth Objects

    +

    18 CLOG Auth Objects

    [in package CLOG-AUTH]
    @@ -6298,7 +8110,7 @@ is nil unbind the event.

    -

    18 CLOG GUI Objects

    +

    19 CLOG GUI Objects

    [in package CLOG-GUI]
    @@ -6802,7 +8614,7 @@ machine, upon close ON-FILE-NAME called with filename or nil if fai

    -

    19 CLOG Web Objects

    +

    20 CLOG Web Objects

    [in package CLOG-WEB]
    @@ -7559,7 +9371,7 @@ and no-script body information for search engines with DESCRIPTION.

    -

    20 CLOG Web DBI

    +

    21 CLOG Web DBI

    [in package CLOG-WEB-DBI]
    @@ -7654,7 +9466,7 @@ optional WHERE and ORDER-BY sql.

    -

    21 CLOG Web Site Themes

    +

    22 CLOG Web Site Themes

    [in package CLOG-WEB]
    @@ -7704,7 +9516,7 @@ Page properties:

    -

    22 CLOG Body Objects

    +

    23 CLOG Body Objects

    CLOG-Body - CLOG Body Objects

    @@ -7780,7 +9592,7 @@ replace the browser contents with HTML.

    -

    23 CLOG Window Objects

    +

    24 CLOG Window Objects

    CLOG-Window - CLOG Window Objects

    @@ -8185,7 +9997,7 @@ on-storage event is fired for changes to :local storage keys.

    -

    24 CLOG Document Objects

    +

    25 CLOG Document Objects

    CLOG-Document - CLOG Document Objects

    @@ -8373,7 +10185,7 @@ The handler should be installed on the document before calling load-script.

    <

    -

    25 CLOG Location Objects

    +

    26 CLOG Location Objects

    Clog-Location - CLOG Location Objects

    @@ -8504,7 +10316,7 @@ saved in session history and back button will not return to it.

    -

    26 CLOG Navigator Objects

    +

    27 CLOG Navigator Objects

    CLOG-Navigator - CLOG Navigator Objects

    @@ -8580,7 +10392,7 @@ saved in session history and back button will not return to it.

    -

    27 CLOG jQuery Objects

    +

    28 CLOG jQuery Objects

    CLOG-jQuery - Base class for CLOG jQuery Objects

    @@ -8591,7 +10403,7 @@ saved in session history and back button will not return to it.

  • [class] CLOG-JQUERY CLOG-ELEMENT

    CLOG jQuery objects. A jQuery representa DOM queries that -can represent one or even my CLOG objects as a single element.

  • +can represent one or even many CLOG objects as a single element.

    CLOG-jQuery creation

    @@ -8647,7 +10459,7 @@ result or DEFAULT-ANSWER on time out.

    -

    28 CLOG Helper Functions

    +

    29 CLOG Helper Functions

    Tutorial and demo helpers

    @@ -8766,7 +10578,7 @@ set (logging to browser console),

    -

    29 CLOG Framework internals and extensions

    +

    30 CLOG Framework internals and extensions

    * Introduction to Internals *

    diff --git a/make-docs b/make-docs new file mode 100755 index 0000000..5661949 --- /dev/null +++ b/make-docs @@ -0,0 +1 @@ +sbcl --dynamic-space-size 10240 --eval "(ql:quickload :clog/docs)" --eval "(clog:make-html)" diff --git a/source/clog-docs.lisp b/source/clog-docs.lisp index d9be5ae..e1228a8 100644 --- a/source/clog-docs.lisp +++ b/source/clog-docs.lisp @@ -86,15 +86,8 @@ frameworks and website frameworks. The CLOG package starts up the connectivity to the browser or other websocket client (often a browser embedded in a native template application.) -STATUS: CLOG is complete and all work is on higher order additions, -such as full desktop over the web, database tools,etc. See below for -some enhacements being worked on. CLOG is actually based on GNOGA, a -framework I wrote for Ada in 2013 and used in commercial production -code for the last 8+ years, i.e. the techniques CLOG uses are solid -and proven. - -CLOG is being actively extended daily. Check the github discussion -boards for the latest. +STATUS: CLOG's API is mature and stable. Tools and new plugins always in +the works. Check the github discussion boards for the latest. Some potential applications for CLOG: diff --git a/source/clog-webgl.lisp b/source/clog-webgl.lisp index ba1472c..300adbc 100644 --- a/source/clog-webgl.lisp +++ b/source/clog-webgl.lisp @@ -202,8 +202,7 @@ can be webgl (version 1) or webgl2 (default)")) (defgeneric buffer-parameter (clog-webgl glenum-target glenum-pname) (:documentation "Returns information about the buffer. -target ------- +target: A GLenum specifying the target buffer object. Possible values: :ARRAY_BUFFER @@ -232,8 +231,7 @@ Buffer used for pixel transfer operations. :PIXEL_UNPACK_BUFFER Buffer used for pixel transfer operations. -pname ------ +pname: A GLenum specifying information to query. Possible values: :BUFFER_SIZE @@ -298,8 +296,7 @@ When using a WebGL 2 context, the following values are available additionally: (defgeneric vertex-attribute (clog-webgl index glenum-pname) (:documentation "Information about a vertex attribute at a given position. -pname ------ +pname: A GLenum specifying the information to query. Possible values: :VERTEX_ATTRIB_ARRAY_BUFFER_BINDING @@ -673,8 +670,7 @@ When using a WebGL 2 context, the following values are available additionally: (:documentation "Hints for certain behaviors. The interpretation of these hints depend on the implementation. -target ------- +target: Sets which behavior to be controlled. Possible values: :GENERATE_MIPMAP_HINT @@ -690,8 +686,7 @@ When using a WebGL 2 context, the following values are available additionally: :FRAGMENT_SHADER_DERIVATIVE_HINT Same as ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES -mode ----- +mode: Sets the behavior. The default value is :DONT_CARE. The possible values are: :FASTEST : The most efficient behavior should be used. diff --git a/source/clog.lisp b/source/clog.lisp index 2e5261d..6a61372 100644 --- a/source/clog.lisp +++ b/source/clog.lisp @@ -786,7 +786,7 @@ embedded in a native template application.)" (measure-text generic-function) (move-to generic-function) (put-image-data generic-function) - (put-image-dirty generic-function) + (put-image-data-dirty generic-function) (quadratic-curve-to generic-function) (rect generic-function) (reset-transform generic-function) @@ -804,8 +804,8 @@ embedded in a native template application.)" (translate generic-function) "CLOG-Canvas-Gradient" - (clog-canvas-gradien class) - (add-color-stop generic-function) + (clog-canvas-gradient class) + (add-color-stop generic-function) "CLOG-Image-Data" (clog-image-data class) @@ -817,7 +817,7 @@ embedded in a native template application.)" (flip-x generic-function) (flip-y generic-function) (inverse generic-function) - (mutliply generic-function) + (multiply generic-function) (rotate generic-function) (scale-matrix generic-function) (scale3d generic-function)