Various changes

- fix link to expressions syntax (upgrade v1912)
- add mirror information
- repos jump directly to /Development
- additional quick links to repo and issues
Mark Olesen
2020-11-13 08:39:10 +01:00
parent c743c82433
commit 6f7b758c79
10 changed files with 40 additions and 21 deletions

@ -3,6 +3,7 @@
[![home](/icons/home.svg "wiki home")](/home) [![home](/icons/home.svg "wiki home")](/home)
[![modules](/icons/layers.svg "modules")](/modules) [![modules](/icons/layers.svg "modules")](/modules)
[![packages](/icons/package.svg "packages")](/precompiled) [![packages](/icons/package.svg "packages")](/precompiled)
[![repos](/icons/gitlab.svg "repos")][all-repos]
[[_TOC_]] [[_TOC_]]
@ -154,6 +155,8 @@ example:
Copyright (C) 2020 OpenCFD Ltd. Copyright (C) 2020 OpenCFD Ltd.
[all-repos]: https://develop.openfoam.com/Development/
[latest-build]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Build.md [latest-build]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Build.md
[v2006-build]: https://develop.openfoam.com/Development/openfoam/blob/maintenance-v2006/doc/Build.md [v2006-build]: https://develop.openfoam.com/Development/openfoam/blob/maintenance-v2006/doc/Build.md

26
home.md

@ -1,6 +1,6 @@
<!-- --- title: OpenFOAM wiki --> <!-- --- title: OpenFOAM wiki -->
## [![OpenFOAM](/icons/nabla.png "OpenFOAM")](http://www.openfoam.com) About ## [![OpenFOAM](/icons/nabla.png "openfoam")](http://www.openfoam.com) About
This wiki provides information to users about This wiki provides information to users about
[accessing](/page-access-code), [accessing](/page-access-code),
@ -8,19 +8,22 @@ This wiki provides information to users about
[upgrading](/upgrade/upgrade) [upgrading](/upgrade/upgrade)
to the latest version of [OpenFOAM](http://www.openfoam.com). to the latest version of [OpenFOAM](http://www.openfoam.com).
| Information | Comments | | Information | Comments |
|---------------------|---------------------| |---------------------|---------------------|
| [![readme](/icons/book-open.svg "readme")][foam-readme] [**Readme**][foam-readme] | Further cross-links in the OpenFOAM repository to _system requirements_ etc. | | [![readme](/icons/book-open.svg "readme")][foam-readme] [**Readme**][foam-readme] | Further cross-links in the OpenFOAM repository to _system requirements_ etc. |
| [![repo](/icons/gitlab.svg "repositories")](/page-access-code) [**Access**](/page-access-code) the code | Locations and descriptions of repository branch names | | [![access](/icons/info.svg "access")](/page-access-code) [**Access**](/page-access-code) the code | Locations and descriptions of repository branch names |
| [![build](/icons/cpu.svg "build")](/building) [**Build**](/building) from source | Information about building and links to build or packaging systems | | [![build](/icons/cpu.svg "build")](/building) [**Build**](/building) from source | Information about building and links to build or packaging systems |
| [![modules](/icons/layers.svg "modules")](/modules) [**Modules**](/modules) for OpenFOAM | Additional code modules | | [![modules](/icons/layers.svg "modules")](/modules) [**Modules**](/modules) for OpenFOAM | Additional code modules |
| [![upgrade](/icons/chevrons-up.svg "upgrade guide")][upgrade-guide] [**Upgrade**][upgrade-guide] guides | User and developer information for upgrading cases and code to more recent releases | | [![upgrade](/icons/chevrons-up.svg "upgrade guide")][upgrade-guide] [**Upgrade**][upgrade-guide] guides | User and developer information for upgrading cases and code to more recent releases |
| [![run](/icons/play.svg "run")](/running) [**Run**](/running) OpenFOAM | Using the OpenFOAM environment | | [![run](/icons/play.svg "run")](/running) [**Run**](/running) OpenFOAM | Using the OpenFOAM environment |
| [![download](/icons/download.svg "download")][download-source] [**Download**][download-source] source packs | Download shortcuts | | [![download](/icons/download.svg "download")][download-source] [**Download**][download-source] source packs | Download shortcuts |
Quick links:
[![repo](/icons/gitlab.svg "repo")][foam-repo]
[![issues](/icons/message-square.svg "issues")][foam-issues]
## [![repo](/icons/gitlab.svg "repositories")][all-repos] Repositories
## [![repo](/icons/database.svg "repositories")][all-repos] Repositories
The [develop.openfoam.com][all-repos] site hosts the The [develop.openfoam.com][all-repos] site hosts the
***publicly accessible*** repositories: ***publicly accessible*** repositories:
@ -31,11 +34,14 @@ The [develop.openfoam.com][all-repos] site hosts the
| [ThirdParty][third-repo] build scripts | [issues][third-issues] | | [ThirdParty][third-repo] build scripts | [issues][third-issues] |
| Additional [modules][all-modules] | _individual_ | | Additional [modules][all-modules] | _individual_ |
Mirrors
| [gitlab.com/openfoam](https://gitlab.com/openfoam/openfoam)
## [![packages](/icons/package.svg "packages")](/precompiled) Linux binaries ## [![packages](/icons/package.svg "packages")](/precompiled) Linux binaries
[***Pre-compiled binary packages***](/precompiled) may be available for [***Pre-compiled binary packages***](/precompiled) are available for
select Linux systems: some Linux systems:
| System | | System |
|---------------| |---------------|
@ -54,7 +60,7 @@ select Linux systems:
| [![code style](/icons/italic.svg "code style")][code-style] [Coding Style][code-style] | coding style in OpenFOAM | | [![code style](/icons/italic.svg "code style")][code-style] [Coding Style][code-style] | coding style in OpenFOAM |
## [![Feedback](/icons/message-square.svg "")](#feedback) Feedback ## [![Feedback](/icons/message-circle.svg "")](#feedback) Feedback
Users can provide feedback by [_submitting issues_](/Submitting-issues) Users can provide feedback by [_submitting issues_](/Submitting-issues)
or by [_feature requests_](/page-feature-requests). or by [_feature requests_](/page-feature-requests).
@ -74,12 +80,12 @@ Copyright (C) 2019-2020 OpenCFD Ltd.
[download-source]: https://dl.openfoam.com/source/ [download-source]: https://dl.openfoam.com/source/
[all-repos]: https://develop.openfoam.com/ [all-repos]: https://develop.openfoam.com/Development/
[all-modules]: https://develop.openfoam.com/Development/openfoam/-/tree/develop/modules [all-modules]: https://develop.openfoam.com/Development/openfoam/-/tree/develop/modules
[foam-readme]: https://develop.openfoam.com/Development/openfoam/blob/develop/README.md [foam-readme]: https://develop.openfoam.com/Development/openfoam/blob/develop/README.md
[foam-repo]: https://develop.openfoam.com/Development/openfoam/ [foam-repo]: https://develop.openfoam.com/Development/openfoam/
[third-repo]: https://develop.openfoam.com/Development/ThirdParty-common/
[foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues [foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues
[third-repo]: https://develop.openfoam.com/Development/ThirdParty-common/
[third-issues]: https://develop.openfoam.com/Development/ThirdParty-common/-/issues [third-issues]: https://develop.openfoam.com/Development/ThirdParty-common/-/issues

1
icons/database.svg Normal file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-database"><ellipse cx="12" cy="5" rx="9" ry="3"></ellipse><path d="M21 12c0 1.66-4 3-9 3s-9-1.34-9-3"></path><path d="M3 5v14c0 1.66 4 3 9 3s9-1.34 9-3V5"></path></svg>

After

Width:  |  Height:  |  Size: 372 B

1
icons/info.svg Normal file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-info"><circle cx="12" cy="12" r="10"></circle><line x1="12" y1="16" x2="12" y2="12"></line><line x1="12" y1="8" x2="12.01" y2="8"></line></svg>

After

Width:  |  Height:  |  Size: 347 B

1
icons/message-circle.svg Normal file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-circle"><path d="M21 11.5a8.38 8.38 0 0 1-.9 3.8 8.5 8.5 0 0 1-7.6 4.7 8.38 8.38 0 0 1-3.8-.9L3 21l1.9-5.7a8.38 8.38 0 0 1-.9-3.8 8.5 8.5 0 0 1 4.7-7.6 8.38 8.38 0 0 1 3.8-.9h.5a8.48 8.48 0 0 1 8 8v.5z"></path></svg>

After

Width:  |  Height:  |  Size: 428 B

@ -2,6 +2,7 @@
[![home](/icons/home.svg "wiki home")](/home) [![home](/icons/home.svg "wiki home")](/home)
[![build](/icons/cpu.svg "build")](/building) [![build](/icons/cpu.svg "build")](/building)
[![repos](/icons/gitlab.svg "repos")][all-repos]
For flexibility and extensibility, OpenFOAM uses [_modules_][all-modules] For flexibility and extensibility, OpenFOAM uses [_modules_][all-modules]
to provide additional functionality. to provide additional functionality.
@ -114,5 +115,5 @@ RUN mkdir -p /home/ofuser/src && \
Copyright (C) 2020 OpenCFD Ltd. Copyright (C) 2020 OpenCFD Ltd.
[all-repos]: https://develop.openfoam.com/ [all-repos]: https://develop.openfoam.com/Development/
[all-modules]: https://develop.openfoam.com/Development/openfoam/-/tree/develop/modules [all-modules]: https://develop.openfoam.com/Development/openfoam/-/tree/develop/modules

@ -3,8 +3,9 @@
[![home](/icons/home.svg "wiki home")](/home) [![home](/icons/home.svg "wiki home")](/home)
[![modules](/icons/layers.svg "modules")](/modules) [![modules](/icons/layers.svg "modules")](/modules)
[![build](/icons/cpu.svg "build")](/building) [![build](/icons/cpu.svg "build")](/building)
[![repos](/icons/gitlab.svg "repos")][all-repos]
OpenFOAM repositories are hosted at the https://develop.openfoam.com webpage. OpenFOAM repositories are hosted on the [develop.openfoam.com][all-repos] site.
Many are **public-access** and can be downloaded or cloned directly; Many are **public-access** and can be downloaded or cloned directly;
to access other internal repositories and take advantage of advanced to access other internal repositories and take advantage of advanced
features (such as reporting issues), users must create an account. features (such as reporting issues), users must create an account.
@ -153,13 +154,13 @@ multiple SSH keys and distinguish them with proper title.
Copyright (C) 2019-2020 OpenCFD Ltd. Copyright (C) 2019-2020 OpenCFD Ltd.
[all-repos]: https://develop.openfoam.com/ [all-repos]: https://develop.openfoam.com/Development/
[all-modules]: https://develop.openfoam.com/Development/openfoam/-/tree/develop/modules [all-modules]: https://develop.openfoam.com/Development/openfoam/-/tree/develop/modules
[foam-repo]: https://develop.openfoam.com/Development/openfoam/ [foam-repo]: https://develop.openfoam.com/Development/openfoam/
[third-repo]: https://develop.openfoam.com/Development/ThirdParty-common/
[foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues [foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues
[third-repo]: https://develop.openfoam.com/Development/ThirdParty-common/
[third-issues]: https://develop.openfoam.com/Development/ThirdParty-common/-/issues [third-issues]: https://develop.openfoam.com/Development/ThirdParty-common/-/issues
[master]: https://develop.openfoam.com/Development/openfoam/tree/master [master]: https://develop.openfoam.com/Development/openfoam/tree/master

@ -4,6 +4,9 @@
[![modules](/icons/layers.svg "modules")](/modules) [![modules](/icons/layers.svg "modules")](/modules)
[![build](/icons/cpu.svg "build")](/building) [![build](/icons/cpu.svg "build")](/building)
[![running](/icons/play.svg "running")](/running) [![running](/icons/play.svg "running")](/running)
[![repo](/icons/gitlab.svg "repo")][foam-repo]
[![issues](/icons/message-square.svg "issues")][foam-issues]
To make OpenFOAM readily available to a larger range of users, To make OpenFOAM readily available to a larger range of users,
OpenCFD works actively with the community surrounding OpenCFD works actively with the community surrounding
@ -21,10 +24,9 @@ the following:
Debian/Ubuntu and openSUSE generally receive first attention: Debian/Ubuntu and openSUSE generally receive first attention:
1. Debian/Ubuntu is a very popular distribution with OpenFOAM users. 1. Debian/Ubuntu is a very popular distribution with OpenFOAM users.
2. openSUSE is historically the internal development platform of 2. openSUSE is historically the favoured development platform for
OpenCFD Ltd. Since it is an RPM-based system, it is generally OpenCFD Ltd. Since it is an RPM-based system, a well-crafted spec
possible to use a well-crafted spec file to subsequently address file can also address RedHat-based distributions.
RedHat-based distributions.
[[_TOC_]] [[_TOC_]]
@ -150,3 +152,6 @@ reference purposes, and to help when scripting:
---- ----
Copyright (C) 2020 OpenCFD Ltd. Copyright (C) 2020 OpenCFD Ltd.
[foam-repo]: https://develop.openfoam.com/Development/openfoam/
[foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues

@ -309,7 +309,7 @@ operator to supply random numbers for std::transform.
---- ----
[expressions]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Expressions.md [expressions]: https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-expression-syntax.html
[code-patterns]: /coding/patterns/patterns [code-patterns]: /coding/patterns/patterns
[upgrade-guide]: /upgrade/upgrade [upgrade-guide]: /upgrade/upgrade

@ -452,7 +452,7 @@ $ foamDictionary -debug-switch fieldExpr=4 -expand mydict
[sourceforge]: https://sourceforge.net/projects/openfoam/files/ [sourceforge]: https://sourceforge.net/projects/openfoam/files/
[compiler-versions]: /building#different-compiler-versions [compiler-versions]: /building#different-compiler-versions
[expressions]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Expressions.md [expressions]: https://www.openfoam.com/documentation/guides/latest/doc/openfoam-guide-expression-syntax.html
[v1906-user]: /upgrade/v1906-User-Upgrade-Guide [v1906-user]: /upgrade/v1906-User-Upgrade-Guide
[v1906-devel]: /upgrade/v1906-Developer-Upgrade-Guide [v1906-devel]: /upgrade/v1906-Developer-Upgrade-Guide