Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate GUI documentation #17

Open
wants to merge 45 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
bc9df9b
Initial commit
michaeltryby May 24, 2024
b712bdc
WIP
michaeltryby May 28, 2024
099b13b
Conceptual Model
michaeltryby May 29, 2024
d476664
WIP, main window
michaeltryby May 29, 2024
14ac50e
WIP
michaeltryby May 29, 2024
493e4a8
WIP toolbars
michaeltryby May 30, 2024
1220361
WIP Map Browser
michaeltryby May 31, 2024
85a7777
Committed generated html by mistake
michaeltryby May 31, 2024
e58ead9
Working with Projects
michaeltryby Jun 3, 2024
f84dd5c
Working with Objects
michaeltryby Jun 3, 2024
bae8795
WIP
michaeltryby Jun 3, 2024
18c7e8e
WIP
michaeltryby Jun 3, 2024
a96d44e
Working with map
michaeltryby Jun 4, 2024
fb2fb5e
Running Simulation
michaeltryby Jun 5, 2024
ac06597
Remove HTML folder
michaeltryby Jun 5, 2024
a356cd6
Fussing
michaeltryby Jun 5, 2024
8519680
Viewing results
michaeltryby Jun 5, 2024
35be32f
Printing and copying
michaeltryby Jun 6, 2024
ac3543e
Files used
michaeltryby Jun 6, 2024
f4880aa
Add-in tools
michaeltryby Jun 6, 2024
bcf380d
Update doxyfile to build tutorials and user guide
michaeltryby Jun 6, 2024
36b9de5
Initial commit
michaeltryby Jun 11, 2024
96c87d8
Units
michaeltryby Jun 11, 2024
c146dab
Parameter tables
michaeltryby Jun 12, 2024
a3e01a9
Visual Properties
michaeltryby Jun 13, 2024
16fde73
Error messages
michaeltryby Jun 13, 2024
55c065c
WIP
michaeltryby Jun 14, 2024
162bd8c
WIP
michaeltryby Jun 17, 2024
141a817
WIP
michaeltryby Jun 17, 2024
ad0686e
WIP
michaeltryby Jun 17, 2024
ed16c3a
WIP
michaeltryby Jun 18, 2024
279de4e
WIP
michaeltryby Jun 21, 2024
927e393
WIP
michaeltryby Jun 25, 2024
4f7f9c6
WIP
michaeltryby Jul 3, 2024
25c0479
special dialogs
michaeltryby Jul 3, 2024
92f9728
Add special dialog forms
michaeltryby Jul 3, 2024
71335d5
Add special dialog forms to reference
michaeltryby Jul 3, 2024
1da98b3
Remove html folder
michaeltryby Jul 8, 2024
548933c
Remove html folder
michaeltryby Jul 8, 2024
ad1f15c
Fix typos/bugs
michaeltryby Jul 8, 2024
c5556db
Conflicts resolved
michaeltryby Jul 10, 2024
a417035
Add doxygen-awesome-css as submodule
michaeltryby Jul 10, 2024
1e23284
Add doxygen-awesome-css as submodule
michaeltryby Jul 10, 2024
86b582b
Create doxygen-gh-pages.yml
michaeltryby Jul 11, 2024
e485176
Remove workflow file
michaeltryby Jul 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@

.DS_Store

attic/
docs/html


# Uncomment these types if you want even more clean repository. But be careful.
# It can make harm to an existing project source. Read explanations below.
#
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/doxygen-awesome-css"]
path = docs/doxygen-awesome-css
url = https://github.com/jothepro/doxygen-awesome-css.git
2,827 changes: 2,827 additions & 0 deletions docs/Doxyfile

Large diffs are not rendered by default.

610 changes: 610 additions & 0 deletions docs/basic-tutorial/basic-tutorial.md

Large diffs are not rendered by default.

Binary file added docs/basic-tutorial/images/clip0013.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/copy.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/dwrd.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/edit.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/example_map.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/graph.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/plus.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/plusbtn.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/profile.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/propedit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/report.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/select.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/sum.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/basic-tutorial/images/verted.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/doxygen-awesome-css
Submodule doxygen-awesome-css added at 40e9b2
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/inlet-tutorial/images/depressedgutter.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/inlet-tutorial/images/dualdrainage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/inlet-tutorial/images/example-dg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/inlet-tutorial/images/example.png
Binary file added docs/inlet-tutorial/images/finalmodel.png
Binary file added docs/inlet-tutorial/images/grate.zoom54.gif
Binary file added docs/inlet-tutorial/images/grateflow.png
Binary file added docs/inlet-tutorial/images/grateinlet.zoom82.gif
Binary file added docs/inlet-tutorial/images/inlettypes.zoom57.gif
Binary file added docs/inlet-tutorial/images/networklayout.png
Binary file added docs/inlet-tutorial/images/plus.gif
Binary file added docs/inlet-tutorial/images/profileplot2.png
Binary file added docs/inlet-tutorial/images/sewerbackflow.png
Binary file added docs/inlet-tutorial/images/sewerbackflowgraph.png
Binary file added docs/inlet-tutorial/images/streetresults-a.png
Binary file added docs/inlet-tutorial/images/streetresults-d.png
502 changes: 502 additions & 0 deletions docs/inlet-tutorial/inlet-tutorial.md

Large diffs are not rendered by default.

Binary file added docs/reference/images/add.gif
Binary file added docs/reference/images/blueinfo.gif
Binary file added docs/reference/images/conicstorageshape.gif
Binary file added docs/reference/images/crosssectioneditor.png
Binary file added docs/reference/images/custominlet2.zoom81.gif
Binary file added docs/reference/images/cylindrical.png
Binary file added docs/reference/images/delete1.gif
Binary file added docs/reference/images/downbtn.gif
Binary file added docs/reference/images/edit.gif
Binary file added docs/reference/images/embim10.gif
Binary file added docs/reference/images/embim3.gif
Binary file added docs/reference/images/embim4.gif
Binary file added docs/reference/images/embim5.gif
Binary file added docs/reference/images/embim6.gif
Binary file added docs/reference/images/embim7.gif
Binary file added docs/reference/images/embim8.gif
Binary file added docs/reference/images/embim9.gif
Binary file added docs/reference/images/filebrowse.gif
Binary file added docs/reference/images/greenplusbtn.gif
Binary file added docs/reference/images/groundwaterequation.gif
Binary file added docs/reference/images/groundwaterflow.gif
Binary file added docs/reference/images/horizontalthroat.gif
Binary file added docs/reference/images/inclinedthroat.gif
Binary file added docs/reference/images/inleteditor.png
Binary file added docs/reference/images/lidgrpeditor2.gif
Binary file added docs/reference/images/minusbtn.gif
Binary file added docs/reference/images/paraboloid.png
Binary file added docs/reference/images/plusbtn.gif
Binary file added docs/reference/images/prismaticstorageshape.gif
Binary file added docs/reference/images/street.gif
Binary file added docs/reference/images/treatmenteditor.zoom70.gif
Binary file added docs/reference/images/unithydrographeditor.gif
Binary file added docs/reference/images/upbtn.gif
Binary file added docs/reference/images/verticalthroat.gif
3,749 changes: 3,749 additions & 0 deletions docs/reference/reference.md

Large diffs are not rendered by default.

Binary file added docs/user-guide/images/addinsmenu.png
Binary file added docs/user-guide/images/animatorback.gif
Binary file added docs/user-guide/images/animatorfirst.gif
Binary file added docs/user-guide/images/animatorforward.gif
Binary file added docs/user-guide/images/animatorstop.gif
Binary file added docs/user-guide/images/arealdepletion.png
Binary file added docs/user-guide/images/backdropimage.png
Binary file added docs/user-guide/images/bioretentioncell.gif
Binary file added docs/user-guide/images/cascade.gif
Binary file added docs/user-guide/images/cistern.zoom57.gif
Binary file added docs/user-guide/images/conduit.gif
Binary file added docs/user-guide/images/configuretools.gif
Binary file added docs/user-guide/images/continuityerrors.gif
Binary file added docs/user-guide/images/copy.gif
Binary file added docs/user-guide/images/divider.gif
Binary file added docs/user-guide/images/downspout.zoom48.gif
Binary file added docs/user-guide/images/edit.gif
Binary file added docs/user-guide/images/embim1.gif
Binary file added docs/user-guide/images/embim2.gif
Binary file added docs/user-guide/images/extents.gif
Binary file added docs/user-guide/images/filebrowsebtn.gif
Binary file added docs/user-guide/images/find.gif
Binary file added docs/user-guide/images/flag_green.gif
Binary file added docs/user-guide/images/flag_red.gif
Binary file added docs/user-guide/images/flag_white.gif
Binary file added docs/user-guide/images/flag_yellow.gif
Binary file added docs/user-guide/images/greenroof.zoom54.gif
Binary file added docs/user-guide/images/groupdelete.gif
Binary file added docs/user-guide/images/groupselect.gif
Binary file added docs/user-guide/images/icebergtheme.zoom50.gif
Binary file added docs/user-guide/images/infiltrench.zoom60.gif
Binary file added docs/user-guide/images/inlet.gif
Binary file added docs/user-guide/images/inletsonmap.gif
Binary file added docs/user-guide/images/inlettypes.zoom55.gif
Binary file added docs/user-guide/images/interfacefiles.png
Binary file added docs/user-guide/images/junction.gif
Binary file added docs/user-guide/images/label.gif
Binary file added docs/user-guide/images/legend.gif
Binary file added docs/user-guide/images/lidplacement.gif
Binary file added docs/user-guide/images/linkoffset.gif
Binary file added docs/user-guide/images/lock.gif
Binary file added docs/user-guide/images/mainwindow.zoom75.gif
Binary file added docs/user-guide/images/mapanimator.gif
Binary file added docs/user-guide/images/mapbrowser.gif
Binary file added docs/user-guide/images/mapquery.gif
Binary file added docs/user-guide/images/mapthemes.gif
Binary file added docs/user-guide/images/maptimeperiods.gif
Binary file added docs/user-guide/images/measure.gif
Binary file added docs/user-guide/images/new.gif
Binary file added docs/user-guide/images/open.gif
Binary file added docs/user-guide/images/options.gif
Binary file added docs/user-guide/images/orifice.gif
Binary file added docs/user-guide/images/outfall.gif
Binary file added docs/user-guide/images/outlet.gif
Binary file added docs/user-guide/images/overviewmap.gif
Binary file added docs/user-guide/images/pan.gif
Binary file added docs/user-guide/images/precisionpreferences.gif
Binary file added docs/user-guide/images/print.gif
Binary file added docs/user-guide/images/profileplot.gif
Binary file added docs/user-guide/images/projectbrowser.gif
Binary file added docs/user-guide/images/propertyeditor.gif
Binary file added docs/user-guide/images/pump.gif
Binary file added docs/user-guide/images/pump1.gif
Binary file added docs/user-guide/images/pump2.gif
Binary file added docs/user-guide/images/pump3.gif
Binary file added docs/user-guide/images/pump4.gif
Binary file added docs/user-guide/images/pump5.gif
Binary file added docs/user-guide/images/quartztheme.zoom50.gif
Binary file added docs/user-guide/images/query.gif
Binary file added docs/user-guide/images/raingage.gif
Binary file added docs/user-guide/images/raingarden.zoom45.gif
Binary file added docs/user-guide/images/refreshbtn.gif
Binary file added docs/user-guide/images/report.gif
Binary file added docs/user-guide/images/run.gif
Binary file added docs/user-guide/images/runstatus.gif
Binary file added docs/user-guide/images/save.gif
Binary file added docs/user-guide/images/scatterplot.gif
Binary file added docs/user-guide/images/select.gif
Binary file added docs/user-guide/images/selectvertex.gif
Binary file added docs/user-guide/images/statistics.gif
Binary file added docs/user-guide/images/statusbar.gif
Binary file added docs/user-guide/images/storageunit.gif
Binary file added docs/user-guide/images/street.gif
Binary file added docs/user-guide/images/streetplanter.zoom105.gif
Binary file added docs/user-guide/images/studyareamap.zoom77.gif
Binary file added docs/user-guide/images/subcatchment.gif
Binary file added docs/user-guide/images/summaryreport.gif
Binary file added docs/user-guide/images/timeseriesplot.gif
Binary file added docs/user-guide/images/timeseriestable.gif
Binary file added docs/user-guide/images/transect.gif
Binary file added docs/user-guide/images/unithydrograph.png
Binary file added docs/user-guide/images/urbanwetweatherflows.png
Binary file added docs/user-guide/images/vegswale.zoom57.gif
Binary file added docs/user-guide/images/visualobjects.gif
Binary file added docs/user-guide/images/weir.gif
Binary file added docs/user-guide/images/windowstheme.zoom50.gif
Binary file added docs/user-guide/images/world.gif
Binary file added docs/user-guide/images/zoomin.gif
Binary file added docs/user-guide/images/zoomout.gif
3,717 changes: 3,717 additions & 0 deletions docs/user-guide/user-guide.md

Large diffs are not rendered by default.