Commit 809eea69 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

update the documentation 

- Update the "Getting Started" page
- Update the examples page
- Add automatic page titles for all documentation pages
- Add new URI redirects for the wwwdocs
parent 1b72664d

.gitignore

+3 −0
Original line number Diff line number Diff line
@@ -21,3 +21,6 @@ install_manifest.txt 
wwwdocs

config.h

test-results



# Local Netlify folder

.netlify
 
 No newline at end of file

CMakeLists.txt

+13 −0
Original line number Diff line number Diff line
@@ -123,3 +123,16 @@ add_custom_target(doc 
    COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs

    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/doc/web/build.sh ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs)



file(GLOB doc_figure_files "doc/**/*.clp")

foreach(doc_figure_path ${doc_figure_files})

  get_filename_component(doc_figure_name ${doc_figure_path} NAME_WE)

  get_filename_component(doc_figure_srcdir ${doc_figure_path} DIRECTORY)

  add_custom_target(

      doc_figure_${doc_figure_name}

      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}

      COMMAND ${CMAKE_CURRENT_BINARY_DIR}/clip ${doc_figure_srcdir}/${doc_figure_name}.clp -e ${doc_figure_srcdir}/${doc_figure_name}.svg)

  add_dependencies(doc_figure_${doc_figure_name} clip-cli)

  add_dependencies(doc doc_figure_${doc_figure_name})

endforeach()

doc/figures/quickstart1.clp

+8 −10
Original line number Diff line number Diff line 
(layout/margins margin 4em)



(plot/lines

(figure/plot

    lines (

        data-x (100 200 300 400 500 600 700 800 900)

        data-y (1.2   1.8   1.3   1.6   1.5   1.3   1.8   1.9   2.0)

        limit-y (0 3)

        limit-x (0 1000)

        marker-shape (pentagon)

    marker-size 8pt)

        marker-size 8pt))

doc/figures/quickstart1.svg

+12 −10
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8" ?>

<!-- Generated by clip v0.7.0 (clip-lang.org) -->

<svg xmlns="http://www.w3.org/2000/svg" width="1024.000000" height="512.000000">

  <rect width="1024.000000" height="512.000000" fill="#ffffff" fill-opacity="1.000000"/>

  <path d="M58.6667 58.6666 L172 354.667 L285.333 108 L398.667 256 L512 206.667 L625.333 108 L738.667 354.667 L852 404 L965.333 453.333 " fill="none" stroke-width="2.000000" stroke="#000000ff"/>

  <text x="53.104167" y="62.666643" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="166.437500" y="358.666661" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="279.770833" y="111.999979" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="393.104167" y="259.999988" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="506.437500" y="210.666652" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="619.770833" y="111.999979" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="733.104167" y="358.666661" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="846.437500" y="407.999997" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <text x="959.770833" y="457.333333" fill="#000000ff" font-size="12.800000" font-family="Arial,Helvetica,'Helvetica Neue',sans-serif" font-weight="500.000000">⬟</text>

  <path d="M102.4 307.2 L204.8 204.8 L307.2 290.133 L409.6 238.933 L512 256 L614.4 290.133 L716.8 204.8 L819.2 187.733 L921.6 170.667 " fill="none" stroke-width="2.000000" stroke="#000000ff"/>

  <path d="M97.0719 305.169 L102.494 301.231 L107.916 305.169 L105.838 311.544 L99.1344 311.544 L97.0719 305.169 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M199.472 202.769 L204.894 198.831 L210.316 202.769 L208.238 209.144 L201.534 209.144 L199.472 202.769 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M301.872 288.102 L307.294 284.165 L312.716 288.102 L310.637 294.477 L303.934 294.477 L301.872 288.102 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M404.272 236.902 L409.694 232.965 L415.116 236.902 L413.038 243.277 L406.334 243.277 L404.272 236.902 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M506.672 253.969 L512.094 250.031 L517.516 253.969 L515.438 260.344 L508.734 260.344 L506.672 253.969 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M609.072 288.102 L614.494 284.165 L619.916 288.102 L617.837 294.477 L611.134 294.477 L609.072 288.102 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M711.472 202.769 L716.894 198.831 L722.316 202.769 L720.237 209.144 L713.534 209.144 L711.472 202.769 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M813.872 185.702 L819.294 181.765 L824.716 185.702 L822.638 192.077 L815.934 192.077 L813.872 185.702 Z" fill="#000000" fill-opacity="1.000000"/>

  <path d="M916.272 168.635 L921.694 164.698 L927.116 168.635 L925.038 175.01 L918.334 175.01 L916.272 168.635 Z" fill="#000000" fill-opacity="1.000000"/>

</svg>
 
 No newline at end of file

doc/figures/quickstart2.clp

+13 −16
Original line number Diff line number Diff line 
(layout/margins margin 4em)



(plot/axes

(figure/plot

    axes (

        limit-y (0 3)

        limit-x (0 1000)

        label-format-x (scientific)

        label-placement-x (linear-interval 100 100 900))



(plot/lines

    lines (

        data-x (100 200 300 400 500 600 700 800 900)

        data-y (1.2   1.8   1.3   1.6   1.5   1.3   1.8   1.9   2.0)

        limit-y (0 3)

        limit-x (0 1000)

        marker-shape (pentagon)

    marker-size 8pt)

        marker-size 8pt))

CRA Git | Maintained and supported by SUSTech CRA and CCSE