EcoSpecies-Atlas/docs/flelmr-authoring.md

45 lines
1.4 KiB
Markdown

# FLELMR Authoring Notes
## Summary Field
The legacy outline reserves header slot `1.4` for `Summary/Abstract` or `Executive Summary`, but the historical corpus in this repository does not contain populated examples. Future FLELMR-compatible records should treat this as a short abstract for the full species life history.
## Recommended Format
Place the summary in the `HEADER` section immediately after the FLELMR code block:
```text
Summary/Abstract:
Short paragraph here.
```
Accepted marker variants:
- `Summary/Abstract`
- `Summary/Abstract:`
- `Summary`
- `Summary:`
- `Abstract`
- `Abstract:`
- `Executive Summary`
- `Executive Summary:`
## Intended Meaning
The field should be a concise executive overview of the record, not metadata and not a section outline. It should help a reader understand the species before they read the detailed habitat, trophic, reproductive, and citation sections.
## Suggested Content
Write 3 to 6 sentences that cover:
- species identity and ecological or management importance
- general geographic range
- major habitat use or life-stage pattern
- notable trophic or reproductive traits
- major conservation, fishery, or data-status note if relevant
## Publishing Rule
- During ingestion or editorial review, a missing summary should be treated as a warning.
- In accepted datasets, the summary may remain empty if no editor-authored abstract is available.