diff --git a/doc/src/Howto_lammps_gui.rst b/doc/src/Howto_lammps_gui.rst index a91a46ad3c..baae66bb40 100644 --- a/doc/src/Howto_lammps_gui.rst +++ b/doc/src/Howto_lammps_gui.rst @@ -559,6 +559,9 @@ a minimal description of LAMMPS-GUI. The ``LAMMPS-GUI Howto`` entry will open this documentation page from the online documentation in a web browser window. The ``LAMMPS Manual`` entry will open the main page of the LAMMPS online documentation in a web browser window. +The ``LAMMPS Tutorial`` entry will open the main page of the set of +LAMMPS tutorials authored and maintained by Simon Gravelle at +https://lammpstutorials.github.io/ in a web browser window. ----- @@ -744,12 +747,12 @@ available (On macOS use the Command key instead of Ctrl/Control). - Reformat line - Shift+TAB - Show Completions - * - Ctrl+Shift+Enter + * - Ctrl+Shift+T + - LAMMPS Tutorial + - Ctrl+Shift+Enter - Run File - - - - - - Further editing keybindings `are documented with the Qt documentation `_. In diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index d18ab66181..649834ed7f 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -1355,6 +1355,7 @@ Grama grana granregion graphene +Gravelle Greathouse greenyellow Greffet diff --git a/tools/lammps-gui/CMakeLists.txt b/tools/lammps-gui/CMakeLists.txt index 435516a521..0b307a43cc 100644 --- a/tools/lammps-gui/CMakeLists.txt +++ b/tools/lammps-gui/CMakeLists.txt @@ -199,7 +199,7 @@ if(APPLE) MACOSX_BUNDLE_BUNDLE_VERSION ${PROJECT_VERSION} MACOSX_BUNDLE_SHORT_VERSION_STRING ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR} MACOSX_BUNDLE_ICON_FILE lammps.icns - MACOSX_BUNDLE_COPYRIGHT "(c) 2003 - 2023, The LAMMPS Developers" + MACOSX_BUNDLE_COPYRIGHT "(c) 2003 - 2024, The LAMMPS Developers" MACOSX_BUNDLE TRUE ) # additional targets to populate the bundle tree and create the .dmg image file diff --git a/tools/lammps-gui/codeeditor.cpp b/tools/lammps-gui/codeeditor.cpp index 2d349e28ab..c4690c3d7f 100644 --- a/tools/lammps-gui/codeeditor.cpp +++ b/tools/lammps-gui/codeeditor.cpp @@ -775,6 +775,11 @@ void CodeEditor::contextMenuEvent(QContextMenuEvent *event) action->setData(QString()); connect(action, &QAction::triggered, this, &CodeEditor::open_help); + action = menu->addAction(QString("LAMMPS Tutorial")); + action->setIcon(QIcon(":/icons/help-tutorial.png")); + action->setData(QString("https://lammpstutorials.github.io/")); + connect(action, &QAction::triggered, this, &CodeEditor::open_url); + menu->exec(event->globalPos()); delete menu; } @@ -1208,6 +1213,12 @@ void CodeEditor::open_help() QUrl(QString("https://docs.lammps.org/%1").arg(act->data().toString()))); } +void CodeEditor::open_url() +{ + auto *act = qobject_cast(sender()); + QDesktopServices::openUrl(QUrl(act->data().toString())); +} + void CodeEditor::view_file() { auto *act = qobject_cast(sender()); diff --git a/tools/lammps-gui/codeeditor.h b/tools/lammps-gui/codeeditor.h index b36f0d8de0..978dc41d3b 100644 --- a/tools/lammps-gui/codeeditor.h +++ b/tools/lammps-gui/codeeditor.h @@ -78,6 +78,7 @@ private slots: void get_help(); void find_help(QString &page, QString &help); void open_help(); + void open_url(); void view_file(); void reformatCurrentLine(); void runCompletion(); diff --git a/tools/lammps-gui/icons/help-browser.png b/tools/lammps-gui/icons/help-browser.png index f3edf2c430..f61fca4573 100644 Binary files a/tools/lammps-gui/icons/help-browser.png and b/tools/lammps-gui/icons/help-browser.png differ diff --git a/tools/lammps-gui/icons/help-tutorial.png b/tools/lammps-gui/icons/help-tutorial.png new file mode 100644 index 0000000000..94df016852 Binary files /dev/null and b/tools/lammps-gui/icons/help-tutorial.png differ diff --git a/tools/lammps-gui/lammpsgui.cpp b/tools/lammps-gui/lammpsgui.cpp index 99fc75d869..18d4e67a2d 100644 --- a/tools/lammps-gui/lammpsgui.cpp +++ b/tools/lammps-gui/lammpsgui.cpp @@ -210,6 +210,7 @@ LammpsGui::LammpsGui(QWidget *parent, const char *filename) : connect(ui->action_Help, &QAction::triggered, this, &LammpsGui::help); connect(ui->actionLAMMPS_GUI_Howto, &QAction::triggered, this, &LammpsGui::howto); connect(ui->actionLAMMPS_Manual, &QAction::triggered, this, &LammpsGui::manual); + connect(ui->actionLAMMPS_Tutorial, &QAction::triggered, this, &LammpsGui::tutorial); connect(ui->actionPreferences, &QAction::triggered, this, &LammpsGui::preferences); connect(ui->actionDefaults, &QAction::triggered, this, &LammpsGui::defaults); connect(ui->actionView_in_OVITO, &QAction::triggered, this, &LammpsGui::start_exe); @@ -1332,6 +1333,11 @@ void LammpsGui::manual() QDesktopServices::openUrl(QUrl("https://docs.lammps.org/")); } +void LammpsGui::tutorial() +{ + QDesktopServices::openUrl(QUrl("https://lammpstutorials.github.io/")); +} + void LammpsGui::howto() { QDesktopServices::openUrl(QUrl("https://docs.lammps.org/Howto_lammps_gui.html")); diff --git a/tools/lammps-gui/lammpsgui.h b/tools/lammps-gui/lammpsgui.h index f41266b485..eb8618125b 100644 --- a/tools/lammps-gui/lammpsgui.h +++ b/tools/lammps-gui/lammpsgui.h @@ -99,6 +99,7 @@ private slots: void about(); void help(); void manual(); + void tutorial(); void howto(); void logupdate(); void modified(); diff --git a/tools/lammps-gui/lammpsgui.qrc b/tools/lammps-gui/lammpsgui.qrc index b4bf6b578d..8cb3f3244e 100644 --- a/tools/lammps-gui/lammpsgui.qrc +++ b/tools/lammps-gui/lammpsgui.qrc @@ -40,6 +40,7 @@ icons/help-about.png icons/help-browser.png icons/help-faq.png + icons/help-tutorial.png icons/image-x-generic.png icons/media-playback-start-2.png icons/media-playlist-repeat.png diff --git a/tools/lammps-gui/lammpsgui.ui b/tools/lammps-gui/lammpsgui.ui index d0354feb6c..2607e715b9 100644 --- a/tools/lammps-gui/lammpsgui.ui +++ b/tools/lammps-gui/lammpsgui.ui @@ -86,6 +86,7 @@ + @@ -313,6 +314,17 @@ Ctrl+Shift+M + + + + + + LAMMPS &Tutorial + + + Ctrl+Shift+T + + @@ -454,7 +466,7 @@ - LAMMPS-GUI Howto + LAMMPS-&GUI Howto Ctrl+Shift+G