search

opengeospatial / templates

OGC document templates in AsciiDoc
Apache License 2.0
11 stars 20 forks source link

Proposed new engineering report template #44

Open ghobona opened 6 months ago

ghobona commented 6 months ago

Attached is a proposed new ER template.

The steps towards implementation are:

@gbuehler @ronaldtse @ingosimonis

20240307_Draft_Template_for_ER.zip

ingosimonis commented 6 months ago

Hi Gobe,

the template does not contain any guidance with respect to links to other resources. I think we need something like that. I would prefer to see in-line-links wherever possible. The bibliography section is nice, but very old fashion, requires a lot of work, etc.

(1) What is the reason we stick to it? (2) Do we allow in-line-links in addition?

Cheers, Ingo

ghobona wrote on 07.03.24 20:35:

Attached is a proposed new ER template.

The steps towards implementation are:

  • DocTeam approval
  • Implementation in metanorma-ogc

@gbuehler https://github.com/gbuehler @ronaldtse https://github.com/ronaldtse @ingosimonis https://github.com/ingosimonis

20240307_Draft_Template_for_ER.zip https://github.com/opengeospatial/templates/files/14529153/20240307_Draft_Template_for_ER.zip

— Reply to this email directly, view it on GitHub https://github.com/opengeospatial/templates/issues/44, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACQ3DWB4XJNAE6KLGJLL7FTYXC6RPAVCNFSM6AAAAABELTGUHSVHI2DSMVQWIX3LMV43ASLTON2WKOZSGE3TINRTGAYDMOI. You are receiving this because you were mentioned.Message ID: @.***>

--

Sign up for OGC News https://ogc.us4.list-manage.com/subscribe?u=704e02f81107a6caab1568067&id=4e4528fd9d

ogcscotts commented 5 months ago

see Issue #39 for inline references, if that issue is accepted then the template will be updated to include inline references.

cnreediii commented 4 months ago

Actually I believe that the TC also needs to approve OGC document templates.

ghobona commented 4 months ago

The DocTeam SC approved the templates today (2024-04-23).

The next step is the TC approval.

ogcscotts commented 2 months ago

TC approval on 20 June 2024. We can merge the branch.

cnreediii commented 2 months ago

One question: Are there any notes for editors to read so that they can understand what should be included in the Abstract, what should be in the Scope, etc.? Also, a few years ago the DocTeam and Members approved having a short (one or two page) Executive Summary instead of an Abstract. I cannot remember how that disappeared. Thanks

ghobona commented 4 weeks ago

Ticket created for metanorma maintainers to update the ER template in metanorma. https://github.com/metanorma/metanorma-ogc/issues/704

opoudjis commented 3 weeks ago

Implemented.