View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0002194 | OpenFOAM | Bug | public | 2016-08-16 02:07 | 2016-12-06 11:15 |
| Reporter | wyldckat | Assigned To | chris | ||
| Priority | low | Severity | text | Reproducibility | N/A |
| Status | closed | Resolution | fixed | ||
| Summary | 0002194: codingStyleGuide.org was incorrectly converted to HTML for openfoam.org/dev/coding-style-guide | ||||
| Description | There are a few render/representation issues in the current page: http://openfoam.org/dev/coding-style-guide/ - which are not consistent with the original file; and if we compare with the one at the "Documentation-dev" repository: http://openfoam.github.io/Documentation-dev/html/codingStyleGuide.html - it's possible to spot the following rendering problems: - The backslashes are gone. - This happens in various code snippets for the Doxygen sections, e.g.: "\verbatim" - And it's missing from the following phrase: Doxygen has a large number of special commands with a \ prefix. - And another issue at section 2.3, where the following was not represented as intended: The template with type \<HR\> is a better example. - In section 2.7, the APA link breaks sooner than desired. - In section 1.9, there are a few lists that are missing line breaks. This leads to typos such as "linesSplit" and "linesoutdent". All signs point to this being an export problem from ORG to HTML and not an HTML rendering problem. | ||||
| Tags | No tags attached. | ||||
|
|
Fixed. Thanks for spotting the errors. I suggest that in section 1.9 Maths and Logic, the line (paragraph) breaks within bullet headings are removed and replaced by a colon, i.e. - Splitting formulae over several lines: split and indent... - Splitting logical tests over several lines: outdent the operator... |
|
|
Sorry, I was hoping you would use the latest codingStyleGuide.org file to re-render the page and I forgot to mention it in the report. Please see report #2193 for the typos that have been fixed on the aforementioned file: http://bugs.openfoam.org/view.php?id=2193 |
|
|
Thanks Bruno, got it. And some changes were made to the org file according to my suggestions. |
|
|
Sorry, it's faster for me to re-open this report... this typo is still around at http://openfoam.org/dev/coding-style-guide/#sec-1-3 - Sourcs --> Source this was reported in issue #2193, mentioned above and somehow hasn't propagated to the website :( But at least it's the only one from #2193 that is missing :) |
|
|
Thanks Bruno. Fixed. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2016-08-16 02:07 | wyldckat | New Issue | |
| 2016-08-16 02:07 | wyldckat | Status | new => assigned |
| 2016-08-16 02:07 | wyldckat | Assigned To | => chris |
| 2016-08-19 23:18 | chris | Note Added: 0006708 | |
| 2016-08-19 23:18 | chris | Status | assigned => resolved |
| 2016-08-19 23:18 | chris | Resolution | open => fixed |
| 2016-08-20 10:49 | wyldckat | Note Added: 0006712 | |
| 2016-08-20 10:49 | wyldckat | Status | resolved => feedback |
| 2016-08-20 10:49 | wyldckat | Resolution | fixed => reopened |
| 2016-08-20 11:33 | chris | Note Added: 0006713 | |
| 2016-08-20 11:33 | chris | Status | feedback => closed |
| 2016-08-20 11:34 | chris | Resolution | reopened => fixed |
| 2016-11-28 00:11 | wyldckat | Status | closed => feedback |
| 2016-11-28 00:11 | wyldckat | Resolution | fixed => reopened |
| 2016-11-28 00:11 | wyldckat | Note Added: 0007348 | |
| 2016-12-06 11:15 | chris | Status | feedback => closed |
| 2016-12-06 11:15 | chris | Resolution | reopened => fixed |
| 2016-12-06 11:15 | chris | Note Added: 0007413 |
