Gifs fixed

potassco · Aug 7, 2024 · 7c551a2 · 7c551a2
1 parent 3a7da64
commit 7c551a2
Show file tree

Hide file tree

Showing 36 changed files with 37 additions and 19 deletions.
diff --git a/docs/clinguin/examples/graph_coloring.md b/docs/clinguin/examples/graph_coloring.md
@@ -0,0 +1 @@
+../../../examples/angular/graph_coloring/README.md
diff --git a/docs/clinguin/examples/index.rst b/docs/clinguin/examples/index.rst
@@ -14,5 +14,14 @@
 .. toctree::
    :maxdepth: 1
 
+   sudoku
+   catdog
    elevator
-   catdog
+   knapsack
+   placement
+   study_regulations
+   graph_coloring
+   tree_browser
+   sudoku_basic
+   sudoku_advanced
+   jobshop
diff --git a/docs/clinguin/examples/jobshop.md b/docs/clinguin/examples/jobshop.md
@@ -0,0 +1 @@
+../../../examples/angular/jobshop/README.md
diff --git a/docs/clinguin/examples/knapsack.md b/docs/clinguin/examples/knapsack.md
@@ -0,0 +1 @@
+../../../examples/angular/knapsack/README.md
diff --git a/docs/clinguin/examples/placement.md b/docs/clinguin/examples/placement.md
@@ -0,0 +1 @@
+../../../examples/angular/placement/README.md
diff --git a/docs/clinguin/examples/study_regulations.md b/docs/clinguin/examples/study_regulations.md
@@ -0,0 +1 @@
+../../../examples/angular/study_regulations/README.md
diff --git a/docs/clinguin/examples/sudoku.md b/docs/clinguin/examples/sudoku.md
@@ -0,0 +1 @@
+../../../examples/angular/sudoku/README.md
diff --git a/docs/clinguin/examples/sudoku_advanced.md b/docs/clinguin/examples/sudoku_advanced.md
@@ -0,0 +1 @@
+../../../examples/angular/sudoku_advanced/README.md
diff --git a/docs/clinguin/examples/sudoku_basic.md b/docs/clinguin/examples/sudoku_basic.md
@@ -0,0 +1 @@
+../../../examples/angular/sudoku_basic/README.md
diff --git a/docs/clinguin/examples/tree_browser.md b/docs/clinguin/examples/tree_browser.md
@@ -0,0 +1 @@
+../../../examples/angular/tree_browser/README.md
diff --git a/docs/clinguin/examples_readme.md b/docs/clinguin/examples_readme.md
diff --git a/docs/clinguin/help.rst b/docs/clinguin/help.rst
@@ -79,6 +79,7 @@
     *Is part of my ui-state*
         Then we recomend you use the browser's developer tools to inspect the elements and see if the styles are being applied.
         You can also move the HTML directly in your browser to find the right settings. Once you found them you can copy them to your :ref:`ui-files`.
+        We recomend taking a look at  `bootstrap flex <https://getbootstrap.com/docs/5.0/utilities/flex/>`_ for the classes you can use for flexible alignments.
 
         You can also add a border to all of your containers to see where they are placed, and then remove them once you have the right settings.
         To do so, just add the following line to your ui encoding:

diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,7 @@ UIs are defined as sets of facts,  which are then rendered by a fronted to provi
 
 **Here is a motivation example:**
 
-Consider an ASP encoding that solves the sudoku puzzle where cells are defined by prediate  ``pos(X,Y)`` and solutions by ``sudoku(X,Y,V)``
+Consider an ASP encoding that solves the sudoku puzzle (:ref:`sudoku basic`) where cells are defined by prediate  ``pos(X,Y)`` and solutions by ``sudoku(X,Y,V)``
 clinguin will use this encoding and the following UI encoding to construct the UI shown bellow.
 
 .. code-block::
@@ -43,7 +43,7 @@ clinguin will use this encoding and the following UI encoding to construct the U
 
 
 
-.. image:: ../examples/angular/elevator/ui.gif
+.. image:: ../examples/angular/sudoku_basic/ui.gif
 
 
 .. note:: Clinguin is part of the `Potassco umbrella <https://potassco.org/>`_ (which is the home of Clingo and the other ASP tools)

diff --git a/examples/README.md b/examples/README.md
@@ -20,7 +20,7 @@ To run the example we suggest downloading clinguin source files as a zip. All th
 
 ### [elevator](https://github.com/potassco/clinguin/tree/master/examples/angular/elevator)
 
-<img src="https://github.com/potassco/clinguin/blob/gifs/examples/angular/elevator/ui.gif?raw=true" height="200">
+<img src="https://github.com/potassco/clinguin/blob/master/examples/angular/elevator/ui.gif?raw=true" height="200">
 
 ### [study_regulations](https://github.com/potassco/clinguin/tree/master/examples/angular/study_regulations)
 

diff --git a/examples/angular/catdog/README.md b/examples/angular/catdog/README.md
@@ -11,7 +11,7 @@ The aim is to place people in tables so that no cat-people are sitting with dog-
 $ clinguin client-server --domain-files catdog/{instance.lp,encoding-explain.lp} --ui-files catdog/{ui-tables.lp,ui-menu.lp,ui-people.lp,ui-explain.lp,ui-explain-msg.lp} --backend ExplanationBackend --assumption-signature cons,2
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/catdog/ui.gif?raw=true">
 

diff --git a/examples/angular/catdog/ui.gif b/examples/angular/catdog/ui.gif
diff --git a/examples/angular/elevator/README.md b/examples/angular/elevator/README.md
@@ -8,9 +8,9 @@ This example showcases one way to use clinguin in an incremental multi-shot enco
 $ clinguin client-server --domain-files elevator/{encoding.lp,instance.lp} --ui-files elevator/ui.lp
 ```
 
-## UI
 
-<img src="https://github.com/potassco/clinguin/blob/gifs/examples/angular/elevator/ui.gif?raw=true">
+
+<img src="https://github.com/potassco/clinguin/blob/master/examples/angular/elevator/ui.gif?raw=true">
 
 ## Domain Files
 

diff --git a/examples/angular/elevator/ui.gif b/examples/angular/elevator/ui.gif
diff --git a/examples/angular/graph_coloring/README.md b/examples/angular/graph_coloring/README.md
@@ -11,7 +11,7 @@ Implements the [graph coloring problem](https://en.wikipedia.org/wiki/Graph_colo
 $ clinguin client-server --domain-files graph_coloring/{encoding.lp,instance.lp} --ui-files graph_coloring/ui.lp --backend=ClingraphBackend --clingraph-files=graph_coloring/viz.lp
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/graph_coloring/ui.gif?raw=true">
 

diff --git a/examples/angular/graph_coloring/ui.gif b/examples/angular/graph_coloring/ui.gif
diff --git a/examples/angular/jobshop/README.md b/examples/angular/jobshop/README.md
@@ -10,7 +10,7 @@ This example is a simple version of the [job-shop scheduling problem](https://en
 $ clinguin client-server --domain-files jobshop/encoding.lp  jobshop/instance.lp --ui-files jobshop/ui.lp  --backend ClingoDLBackend
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/jobshop/ui.gif?raw=true">
 

diff --git a/examples/angular/jobshop/ui.gif b/examples/angular/jobshop/ui.gif
diff --git a/examples/angular/knapsack/README.md b/examples/angular/knapsack/README.md
@@ -10,7 +10,7 @@ By doing so, it showcases the use of optimal consequences and false assumptions.
 $ clinguin client-server --domain-files knapsack/{encoding.lp,instance.lp} --ui-files knapsack/ui.lp
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/knapsack/ui.gif?raw=true">
 

diff --git a/examples/angular/knapsack/ui.gif b/examples/angular/knapsack/ui.gif
diff --git a/examples/angular/placement/README.md b/examples/angular/placement/README.md
@@ -11,7 +11,7 @@ The option ` --opt-timeout 0` makes sure that one model is computed at a time to
 clinguin client-server --domain-files placement/{instance.lp,encoding.lp} --ui-files placement/ui.lp --opt-timeout 0
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/placement/ui.gif?raw=true">
 

diff --git a/examples/angular/placement/ui.gif b/examples/angular/placement/ui.gif
diff --git a/examples/angular/study_regulations/README.md b/examples/angular/study_regulations/README.md
@@ -13,7 +13,7 @@ This encodings are used in the paper for study regulations in [ICLP 2024](https:
 $ clinguin client-server --domain-files study_regulations/{encoding.lp,instance.lp} --ui-files study_regulations/ui.lp -c n=4
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/study_regulations/ui.gif?raw=true">
 

diff --git a/examples/angular/study_regulations/ui.gif b/examples/angular/study_regulations/ui.gif
diff --git a/examples/angular/sudoku/README.md b/examples/angular/sudoku/README.md
@@ -9,7 +9,7 @@ This example uses the well known [sudoku puzzle](https://en.wikipedia.org/wiki/S
 $ clinguin client-server --domain-files sudoku/{encoding.lp,instance.lp} --ui-files sudoku/ui.lp
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/sudoku/ui.gif?raw=true">
 

diff --git a/examples/angular/sudoku/ui.gif b/examples/angular/sudoku/ui.gif
diff --git a/examples/angular/sudoku_advanced/README.md b/examples/angular/sudoku_advanced/README.md
@@ -1,4 +1,4 @@
-## Sudoku
+## Sudoku Explained
 
 - **Backend**:   `ExplanationBackend`
 
@@ -13,7 +13,7 @@ Notice that the instances uses choices on predicate `initial/3`. This way they c
 $ clinguin client-server --domain-files sudoku_advanced/{encoding.lp,instance.lp} --ui-files sudoku_advanced/ui.lp --backend ExplanationBackend  --assumption-signature initial,3
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/sudoku_advanced/ui.gif?raw=true">
 

diff --git a/examples/angular/sudoku_advanced/ui.gif b/examples/angular/sudoku_advanced/ui.gif
diff --git a/examples/angular/sudoku_basic/README.md b/examples/angular/sudoku_basic/README.md
@@ -1,4 +1,4 @@
-# Sudoku
+# Sudoku basic
 
 This example uses the well known [sudoku puzzle](https://en.wikipedia.org/wiki/Sudoku) to showcase most basic feature of clinguin.
 
@@ -9,7 +9,7 @@ This example uses the well known [sudoku puzzle](https://en.wikipedia.org/wiki/S
 $ clinguin client-server --domain-files sudoku_basic/{encoding.lp,instance.lp} --ui-files sudoku_basic/ui.lp
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/sudoku_basic/ui.gif?raw=true">
 

diff --git a/examples/angular/sudoku_basic/ui.gif b/examples/angular/sudoku_basic/ui.gif
diff --git a/examples/angular/tree_browser/README.md b/examples/angular/tree_browser/README.md
@@ -12,7 +12,7 @@ Notice that web browser might need to be resized to see the clingraph image.
 $ clinguin client-server --domain-files tree_browser/{encoding.lp,instance.lp} --ui-files tree_browser/ui.lp --backend=ClingraphBackend --clingraph-files tree_browser/viz.lp
 ```
 
-## UI
+
 
 <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/tree_browser/ui.gif?raw=true">
 

diff --git a/examples/angular/tree_browser/ui.gif b/examples/angular/tree_browser/ui.gif
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../examples/angular/graph_coloring/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../examples/angular/study_regulations/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../examples/angular/sudoku_advanced/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../examples/angular/sudoku_basic/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../examples/angular/tree_browser/README.md
-Original file line number
+Diff line change
@@ Expand Up @@
     $ clinguin client-server --domain-files catdog/{instance.lp,encoding-explain.lp} --ui-files catdog/{ui-tables.lp,ui-menu.lp,ui-people.lp,ui-explain.lp,ui-explain-msg.lp} --backend ExplanationBackend --assumption-signature cons,2
     ```
-    ## UI
     <img src="https://github.com/potassco/clinguin/blob/master/examples/angular/catdog/ui.gif?raw=true">
@@ Expand Down @@