Skip to content

Commit

Permalink
Update mobile data branch (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
lepitaxa authored Oct 22, 2024
2 parents 5899244 + 61e7e73 commit e0074de
Show file tree
Hide file tree
Showing 11 changed files with 5,774 additions and 637 deletions.
3 changes: 2 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
*.html text eol=lf
*.js text eol=lf
*.md text eol=lf
*.png binary
*.png binary
*.ico binary
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@
*.docx
*.xls
*.xlsx
*.ico
*.pdf
*.zip
2 changes: 1 addition & 1 deletion 404.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ a:hover {text-decoration:underline}
</head>

<body>
<img src="https://lepitaxa.github.io/lepitaxa2.png" height="160">
<img src="favicon.svg" height="160">
<h1>404</h1>
<h2>There's nothing here ...</h2>
<h3>Alternate routes:</h3>
Expand Down
57 changes: 28 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# <picture><source media="(prefers-color-scheme: light)" srcset="lepitaxa.png"><source media="(prefers-color-scheme: dark)" srcset="lepitaxa2.png"><img src="lepitaxa.png" height="32"></picture> LEPITAXA – Lepidopteran Classification Project
# <img src="favicon.svg" height="32"> LEPITAXA – Lepidopteran Classification Project
#### Website: [lepitaxa.github.io](https://lepitaxa.github.io/)
#### GitHub repository: [lepitaxa / lepitaxa.github.io](https://github.com/lepitaxa/lepitaxa.github.io)

## Overview
- [Introduction](#introduction)
- [Basic structure](#basic-structure)
- [Workspace setup](#workspace-setup)
- [Data types](#data-types)
- [Guidelines](#guidelines)
- [Project details](#project-details)
- [Licencing](#licencing)

## Introduction
This project aims to provide a modern, up-to-date phylogeny-based classification of the large insect order Lepidoptera (Butterflies & Moths) in a simple and lightweight format.
Expand All @@ -20,21 +20,29 @@ This GitHub repository also provides a place to discuss data, propose changes an

-- _Georg Hammerschmid_

## Basic structure
### Project history
|Date|Milestone|
|---|---|
|07.07.2008|Started experimenting with a first HTML-based tree for the superfamily Papilionoidea (butterflies).|
|17.12.2013|Complete technical overhaul of the still experimental "Papilionoidea" project, including the use of CSS and JavaScript.|
|05.12.2020|Formal creation of the Lepitaxa project with improved code and data structure, as well as a significantly expanded tree.|
|17.09.2023|The Lepitaxa project moved to GitHub and is now available to the public domain, using GitHub Pages as a website host.|

### Basic structure
Within Lepitaxa, the Lepidopterans are, for faster navigation, divided into four _"Macrolepidopteran"_ and four _"Microlepidopteran"_ groups, all with easily recognizable names and color coding. Keep in mind that these groups are NOT actual taxa or datapoints! An overview of the group structure can be found in the table below.

|Color|English name|German name|Included Taxa|
|---|---|---|---|
||_"Macrolepidopterans"_|_"Großschmetterlinge"_||
|${\color[RGB]{255,255,153}██\color[RGB]{255,192,1}█\color[RGB]{255,255,153}██}$<br>${\color[RGB]{255,255,153}██\color[RGB]{255,192,1}█\color[RGB]{255,255,153}██}$|**Butterflies**|**Tagfalter**|Section Obtectomera / Subsection Rhopalocera<br>(Superfamilies Papilionoidea + Thyridoidea)|
|${\color[RGB]{255,204,102}██\color{red}█\color[RGB]{255,204,102}██}$<br>${\color[RGB]{255,204,102}██\color{red}█\color[RGB]{255,204,102}██}$|**Owlet Moths**|**Eulen**|Section Obtectomera / Subsection Macroheterocera<br>Infrasection Noctuina (Superfamily Noctuoidea)|
|${\color[RGB]{204,255,204}██\color[RGB]{153,204,0}█\color[RGB]{204,255,204}██}$<br>${\color[RGB]{204,255,204}██\color[RGB]{153,204,0}█\color[RGB]{204,255,204}██}$|**Geometrid Moths**|**Spannerartige**|Section Obtectomera / Subsection Macroheterocera<br>Infrasection Geometrina (Superfamily Geometroidea)|
|${\color[RGB]{204,204,255}██\color[RGB]{92,1,255}█\color[RGB]{204,204,255}██}$<br>${\color[RGB]{204,204,255}██\color[RGB]{92,1,255}█\color[RGB]{204,204,255}██}$|**Silkmoths**|**Spinner**|Section Obtectomera / Subsection Macroheterocera<br>Infrasection Bombycina (Superfamilies Bombycoidea + Lasiocampoidea)|
|![#FFFF99,#FFC001](https://placehold.co/110x50/ff9/ffc001?text=PAP)|**Butterflies**|**Tagfalter**|Section Obtectomera / Subsection Rhopalocera (Superfamilies Papilionoidea + Thyridoidea)|
|![#FFCC66,#FF0000](https://placehold.co/110x50/fc6/f00?text=NOC)|**Owlet Moths**|**Eulen**|Section Obtectomera / Subsection Macroheterocera / Infrasection Noctuina (Superfamily Noctuoidea)|
|![#CCFFCC,#99CC00](https://placehold.co/110x50/cfc/9c0?text=GEO)|**Geometrid Moths**|**Spannerartige**|Section Obtectomera / Subsection Macroheterocera / Infrasection Geometrina (Superfamily Geometroidea)|
|![#CCCCFF,#5C01FF](https://placehold.co/110x50/ccf/5c01ff?text=BOM)|**Silkmoths**|**Spinner**|Section Obtectomera / Subsection Macroheterocera / Infrasection Bombycina (Superfamilies Bombycoidea + Lasiocampoidea)|
||_"Microlepidopterans"_|_"Kleinschmetterlinge"_||
|${\color[RGB]{255,204,255}██\color[RGB]{187,0,255}█\color[RGB]{255,204,255}██}$<br>${\color[RGB]{255,204,255}██\color[RGB]{187,0,255}█\color[RGB]{255,204,255}██}$|**Higher Micromoths**|**Höhere Motten**|Remaining Obtectomeran taxa<br>(Superfamilies Drepanoidea, Pyraloidea, etc.)|
|${\color[RGB]{255,204,204}██\color[RGB]{238,0,153}█\color[RGB]{255,204,204}██}$<br>${\color[RGB]{255,204,204}██\color[RGB]{238,0,153}█\color[RGB]{255,204,204}██}$|**Cossid Micromoths**|**Bohrerartige**|Section Cossina<br>(Superfamilies Cossoidea, Zygaenoidea and relatives)|
|${\color[RGB]{187,255,255}██\color[RGB]{30,185,188}█\color[RGB]{187,255,255}██}$<br>${\color[RGB]{187,255,255}██\color[RGB]{30,185,188}█\color[RGB]{187,255,255}██}$|**Typical Micromoths**|**Klassische Motten**|Remaining basal Distrysian taxa<br>(Superfamilies Gelechioidea, Tortricoidea, Yponomeutoidea, Tineoidea, etc.)|
|${\color[RGB]{238,238,204}██\color[RGB]{170,136,85}█\color[RGB]{238,238,204}██}$<br>${\color[RGB]{238,238,204}██\color[RGB]{170,136,85}█\color[RGB]{238,238,204}██}$|**Archaic Micromoths**|**Primitive Motten**|Remaining basal Lepidoptera<br>(Non-Ditrysian, like Adeloidea, Exoporia, Zeugloptera, etc.)|
|![#FFCCFF,#BB00FF](https://placehold.co/110x50/fcf/bb00ff?text=HEM)|**Higher Micromoths**|**Höhere Motten**|Remaining Obtectomeran taxa<br>(Superfamilies Drepanoidea, Pyraloidea, etc.)|
|![#FFCCCC,#EE0099](https://placehold.co/110x50/fcc/e09?text=COS)|**Cossid Micromoths**|**Bohrerartige**|Section Cossina<br>(Superfamilies Cossoidea, Zygaenoidea and relatives)|
|![#BBFFFF,#1EB9BC](https://placehold.co/110x50/bff/1eb9bc?text=TYP)|**Typical Micromoths**|**Klassische Motten**|Remaining basal Distrysian taxa<br>(Superfamilies Gelechioidea, Tortricoidea, Yponomeutoidea, Tineoidea, etc.)|
|![#EEEECC,#AA8855](https://placehold.co/110x50/eec/a85?text=ARC)|**Archaic Micromoths**|**Primitive Motten**|Remaining basal Lepidoptera<br>(Non-Ditrysian, like Adeloidea, Exoporia, Zeugloptera, etc.)|

Note that within the _"Microlepidoptera"_, the group naming and color coding mostly does not represent actual monophyletic entities, but is purely for aesthetics and practical reasons. The _"Macrolepidopterans"_ are, on the other hand, divided into four strictly monophyletic groups here, that actually do make somewhat sense from a practical standpoint.

Expand All @@ -55,12 +63,12 @@ All Lepitaxa data is included within a single file, index.html. This file also c
To get around faster within the large dataset, simply use your text editors search function to jump to whatever datapoint you’d like to modify.

### Checking data integrity
To check if your modifications show up correctly on the webpage, just open index.html in a web browser. Especially for larger modifications and additions, it is recommended to additionally run an automated data integrity check. To do this, open index.html in a web browser, navigate to "Stats & Infos" on the bottom and select one of the data export options. Every data export will trigger the lepitest script, which checks the data for common mistakes and when done, displays an error log listing all mistakes found. Try to fix them, reload the page and repeat the lepitest for confirmation.
To check if your modifications show up correctly on the webpage, just open index.html in a web browser. Especially for larger modifications and additions, it is recommended to additionally run an automated data integrity check. To do this, open index.html in a web browser, navigate to the bottom and click the data download button. Every data export will trigger the lepitest script, which checks the data for common mistakes and when done, displays an error log listing all mistakes found. Try to fix them, reload the page and repeat the lepitest for confirmation.

Note that running a successfull lepitest does NOT guarantee full data integrity, as this simple script can by no means detect everything. Also keep in mind that sometimes a single mistake within the data can cause several error points in a lepitest log, don’t get confused by that. They will all resolve after fixing the mistake.

### Exporting the dataset
If you want to use Lepitaxa data for your own research, you’re free to do so in any way you want at all times, no need to ask for permission. More details about the dataset, its licensing as well as a data export feature (supports txt, csv, tsv and xml formats) can be found by clicking the “Stats & Infos” button on the bottom of the Lepitaxa webpage.
If you want to use Lepitaxa data for your own research, you’re free to do so in any way you want at all times, no need to ask for permission. More details about the dataset, its licensing as well as a data export feature can be found in the footer of the Lepitaxa webpage.

## Data types
### Basic data syntax
Expand Down Expand Up @@ -127,7 +135,7 @@ These datapoints form a very long, but simple list, resulting in a strictly line
|`d`|NAME_DE|**NAME**|German common name of a<br>species or species complex|
|`d2`|NAME_DE|**NAME**|German common name of a<br>family/tribe-level taxon|
|`b`|BAS|**GEN** $\color{#9BD}{\textsf{ SP}}$|Genus of the basionym/original combination|
|`n`|BAS_AUT|**AUT, YYYY**|Author(s) and year of publication of the basionym/original combination|
|`n`|AUT|**AUT, YYYY**|Author(s) and year of publication of the basionym/original combination|
|`s`|SYN|$\color{#9BD}{\textsf{GEN }}$ **SP** SSP|Species synonym with different<br>species (+ optional subspecies) epithet|
|`s2`|SYN|**GEN** SP $\color{#9BD}{\textsf{ SP/SSP}}$|(Sub)species synonym with different<br>genus (+optional species) name|
|`s3`|SYN|$\color{#9BD}{\textsf{GEN }}$ **SP** $\color{#9BD}{\textsf{ SSP}}$|Species synonym of former subspecies<br>of the given species epithet|
Expand All @@ -139,7 +147,7 @@ These datapoints form a very long, but simple list, resulting in a strictly line
|`p`|REF_ID|$\color{#9BD}{\textsf{doi:}}$**DOI**|ID of scientific reference via DOI|
|`p2`|REF_ID|$\color{#9BD}{\textsf{ISSN-L:}}$ **ISSN-L, VOL**(ISSUE)|ID of scientific reference via<br>ISSN-L and Volume+Issue designation|

$\color{#9BD}{\textsf{X}}$ Auto-generated data substring – added on page load via JavaScript<br>
$\color{#9BD}{\textsf{X }}$ Auto-generated data substring – added on page load via JavaScript<br>
**X**&nbsp; Required data (sub)string – must always be present<br>
X&nbsp; Optional data substring – can be added in addition to a required substring

Expand Down Expand Up @@ -428,7 +436,7 @@ The genus of the basionym (original combination) of the species' or species aggr
</details>

---
### 22 - BAS_AUT (`n`)
### 22 - AUT (`n`)
The author(s) and the year of publication of the basionym.

<details>
Expand Down Expand Up @@ -524,15 +532,6 @@ The ID of a referenced scientific publication. This data type forms the last ele
- 27.7. The sorting follows Guideline 25.5.
</details>

---

## Project details

**LEPITAXA – Lepidopteran Classification Project**
- Author: [Georg Hammerschmid](https://github.com/lepitaxa)
- Creation date of base tree: 07.07.2008
- Creation date of project: 05.12.2020
- Webhost Lepitaxa site: [pages.github.com](https://pages.github.com/) since 17.09.2023
- GitHub repository: [lepitaxa / lepitaxa.github.io](https://github.com/lepitaxa/lepitaxa.github.io)
- Licencing Lepitaxa designs: [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)
- Licencing Lepitaxa dataset: [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)
## Licencing
#### <img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" height="45"> <img src="https://mirrors.creativecommons.org/presskit/icons/zero.svg" height="45"> This work is licenced under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) (public domain)
Author: [Georg Hammerschmid](https://github.com/lepitaxa)
Binary file added favicon.ico
Binary file not shown.
File renamed without changes
1 change: 1 addition & 0 deletions favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e0074de

Please sign in to comment.