Merge pull request #88 from gefei/master

Updated information of how to create a new project

README.md

@@ -7,16 +7,17 @@ The official IMI showtime website
 
 [Preview: https://htw-imi-showtime.github.io/](https://htw-imi-showtime.github.io/)
 
-* [Adding a new project](#Adding-a-new-project)
-* [Updating your Fork](#Updating-your-Fork)
-* [Including additional content](#Including-additional-content)
-  * [Sections](#Sections)
-  * [Images](#Images)
-  * [Gallery](#Gallery)
-    * [Special Case: Team Gallery](#Special-Case-Team-Gallery)
-  * [Videos](#Videos)
-  * [HTW Mediathek Player](#HTW-Mediathek-Player)
-  * [GitHub Gists](#GitHub-Gists)
+- [IMI Showtime Website](#imi-showtime-website)
+  - [Adding a new project](#adding-a-new-project)
+  - [Updating your Fork](#updating-your-fork)
+  - [Including additional content](#including-additional-content)
+    - [Sections](#sections)
+    - [Images](#images)
+    - [Gallery](#gallery)
+      - [Special Case: Team Gallery](#special-case-team-gallery)
+    - [Videos](#videos)
+    - [HTW Mediathek Player](#htw-mediathek-player)
+    - [GitHub Gists](#github-gists)
 
 ## Adding a new project
 If you want to add your project to the website, please follow these steps and create a pull request when you're done:
@@ -44,14 +45,14 @@ git submodule update --init --recursive
 ```
 4. Create a new project directory for your project by duplicating either the bachelor's or the master's sample project directory:
 ```
-cp -R content/ws20/bachelor/b0-template-project/ content/ws20/bachelor/b#-your-project/
+cp -R content/ws21/bachelor/b0-template-project/ content/ws21/bachelor/b#-your-project/
 ```
 ```
-cp -R content/ws20/master/m0-template-project/ content/ws20/master/m#-your-project/
+cp -R content/ws21/master/m0-template-project/ content/ws21/master/m#-your-project/
 ```
 **Please make sure to include your project number! (e.g. B2, M1, ...)**
 
-5. Fill out your project's homepage `content/ws20/<bachelor/master>/##-your-project/_index.md` and any subpages in your project's directory you'd like to keep. Delete the subpages you don't need.\
+5. Fill out your project's homepage `content/ws21/<bachelor/master>/##-your-project/_index.md` and any subpages in your project's directory you'd like to keep. Delete the subpages you don't need.\
    **Please don't use Markdown headings (hashtags) directly, since those headings won't be displayed correctly.**
    Have a look at the [section documentation](#Sections) below or the template projects for including headings.\
    If you need help with the markdown syntax, have a look at this [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).\
@@ -60,13 +61,13 @@ cp -R content/ws20/master/m0-template-project/ content/ws20/master/m#-your-proje
 6. Preview your changes locally to make sure everything looks fine by executing `hugo server` and visiting http://localhost:1313/ in your browser.
 7. Add your changes to the git index, commit them to the repository and push them to GitHub:
 ```
-git add content/ws20/<bachelor|master>/<project_number-your-project>
+git add content/ws21/<bachelor|master>/<project_number-your-project>
 git commit -m "Your commit message"
 git push
 ```
 8. Create a new pull request on GitHub that merges your version of the repo's `master` branch onto the htw-imi-showtime `master` branch. ([GitHub Help: Creating a pull request from a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork))
 
-Once your branch was merged, you may preview your project's page on our staging server: https://htw-imi-showtime.github.io/
+Once your branch was merged, you may preview your project's page on our staging server: https://htw-imi-showtime.github.io/ 
 
 One week before the Showtime takes place, the website will be published on our production server: https://showtime.f4.htw-berlin.de/
 
@@ -88,7 +89,7 @@ git submodule update
 ```
 
 ## Including additional content
-In addition to the required content you can add any content you want - at least this term (winter semester 2021) this site
+In addition to the required content you can add any content you want - at least this term (winter semester 2021/22) this site
 replaces the Showtime Fair with the booths and posters. Please consider
 - the Urheberrecht for all material you provide: Include the information (source, creator etc.) in the caption
 - please reduce the file sizes for all images and videos that are included in the site

config/_default/config.toml

@@ -4,7 +4,7 @@ title = "IMI Showtime"
 theme = "showtime-theme-2021"
 
 [params]
-    current_semester = "ws20"
+    current_semester = "ss21"
     archive_semester = "ss20"
 
 [markup]

content/_index.md

@@ -1,13 +1,13 @@
 +++
-showtime_date = "12/02/2021"
+showtime_date = "16/07/2021"
 showtime_place = "REMOTE"
 is_live = "false"
-zoom_link = "https://htw-berlin.zoom.us/j/97320821203"
+zoom_link = "TBD"
 +++
 
 {{<teaser category="about showtime" title="Projects over Distance">}}
 
-This term is the second term already that all projects and our Showtime are held in
+This term is the third term already that all projects and our Showtime are held in
 a distance format - sad, but also an opportunity to explore the projects
 from afar! Just dip in for one or two project presentations, visit the projects
 in their virtual booths or watch the presentation videos,

content/contact.md

@@ -6,6 +6,6 @@ layout = "contact"
 The IMIxShowtime is a showcase
 of the term-long practical projects in the International Media and Computing
 [Bachelor's](https://imi-bachelor.htw-berlin.de) and
-[Master's](https://imi-master.htw-berlin.de) programmes. 
+[Master's](https://imi-master.htw-berlin.de) programs. 
 It takes place every term on the Friday of the
 last week of lectures.

content/imprint.md

@@ -7,16 +7,16 @@ Diese Seite präsentiert Praxisprojekte der Studiengänge [Internationale Medien
 #### Redaktionelle Verantwortung und verantwortliche Ansprechperson
 Studiengangssprecher der Studiengänge Internationale Medieninformatik
 
-Prof. Dr. Barne Kleinen\
+Prof. Dr. Gefei Zhang\
 HTW Berlin, Fachbereich 4\
 Wilhelminenhofstr. 75A\
 12495 Berlin
 
-barne.kleinen@htw-berlin.de
+gefei.zhang@htw-berlin.de
 
 https://www.htw-berlin.de/impressum/
 
-Telefon: +49 30 5019 - 3499
+Telefon: +49 30 5019 - 3738
 
 #### Urheberschutz und Nutzung
 Die Urheber räumen Ihnen ganz konkret das Nutzungsrecht ein, sich eine private Kopie für persönliche Zwecke anzufertigen. Nicht berechtigt sind Sie dagegen, die Materialien zu verändern und/oder weiter zu geben oder gar selbst zu veröffentlichen. Wenn nicht ausdrücklich anders vermerkt, liegen die Urheberrechte für Texte bei den Studierenden.
@@ -28,7 +28,7 @@ Vielen Dank für Ihr Interesse an unserer Hochschule. Der Schutz Ihrer Daten ist
 Die Inhalte dieses Webprojektes wurden sorgfältig geprüft und nach bestem Wissen erstellt. Aber für die hier dargebotenen Informationen wird kein Anspruch auf Vollständigkeit, Aktualität, Qualität oder Richtigkeit erhoben. Es kann keine Verantwortung für Schäden übernommen werden, die durch das Vertrauen auf die Inhalte dieser Website oder deren Gebrauch entstehen.
 
 #### Schutzrechtsverletzung
-Falls Sie vermuten, dass von dieser Website aus eines Ihrer Schutzrechte verletzt wird, teilen Sie das bitte umgehend per elektronischer Post an barne.kleinen@htw-berlin.de mit, damit zügig Abhilfe geschafft werden kann. Bitte nehmen Sie zur Kenntnis: Die zeitaufwändigere Einschaltung eines Anwaltes zur für den Diensteanbieter kostenpflichtigen Abmahnung entspricht nicht dessen wirklichen oder mutmaßlichen Willen. 
+Falls Sie vermuten, dass von dieser Website aus eines Ihrer Schutzrechte verletzt wird, teilen Sie das bitte umgehend per elektronischer Post an gefei.zhang@htw-berlin.de mit, damit zügig Abhilfe geschafft werden kann. Bitte nehmen Sie zur Kenntnis: Die zeitaufwändigere Einschaltung eines Anwaltes zur für den Diensteanbieter kostenpflichtigen Abmahnung entspricht nicht dessen wirklichen oder mutmaßlichen Willen. 
 
 #### Anmerkungen
 Theme-Design: [Tobi Hoffmann](http://tobihoffmann.com/) \

content/projects.md

@@ -2,4 +2,4 @@
 title = "Projects"
 layout = "projects_list"
 +++
-This term there are [6 bachelor's](#B1) and [4 master's](#M1) projects.
+This term there are [5 bachelor's](#B1) and [5 master's](#M1) projects.

content/ss21/_index.md

@@ -0,0 +1,5 @@
++++
+title = "ss21"
+full_title = "Summer semester 2021"
+layout = "projects_archive"
++++

content/ss21/bachelor/_index.md

@@ -0,0 +1,7 @@
++++
+type = "ss21"
+
+[cascade]
+    type = "Bachelor"
+    layout = "project"
++++

content/ss21/bachelor/b0-template-project/_index.md

@@ -0,0 +1,37 @@
++++
+title = "Bachelor Project Template"
+project_id = "B0"
+
+# Properties for displaying the project in the project list
+card_image = "FB4_IMI.jpg"
+card_description = "Template, copy of a project of WS20/21"
+
+
+# These properties may be removed if you don't need them
+source_link = "links to Git repo"
+
+
+team = ["Bachelor", "Bachelorette"]
+supervisor = "Prof. Dr. Bachelor Master"
++++
+
+{{<mediathek id="9a515dbdd99e6b17d8a21d87d5fcd3cb" >}}
+
+This is only a template
+
+{{<image src="headerindex.png" alt="Mockup" >}}
+{{<section title="Our Goals">}}
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+{{</section>}}
+
+<!--{{<quote source="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/blockquote" caption="me">}}
+yeet
+{{</quote>}} -->
+
+{{<section title="The Team">}}
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. 
+{{</section >}}
+
+{{<gallery>}}
+{{<team-member image="anton.png" name="Anton">}}
+{{</gallery>}}

content/ss21/bachelor/b0-template-project/features.md

@@ -0,0 +1,62 @@
++++
+title = "Features"
+weight = 1
++++
+
+{{<image src="Overview_features.png" alt="Mockup" >}}
+{{<section title="Feature set" >}}
+#### Offline Data
+Our app is completely offline compatible
+We have **over 30.000 ingredients** stored in our data set.
+It was important for us to guarantee that the user is always able to use the app. Therefore we didn't want to rely on an internet connection.
+
+#### Text Recognition/Filtering
+Our app uses the Firebase ML text recognition to recognise the ingredients on the back of the product.
+
+The **backside** of a product is **full of information that isn't interesting to us or our app**. So **filtering out** the information we need was quite **important for the performance** of our app.
+Some things that our app takes into account is **how** the **ingredients are separated**. It differs from product to product how they separate the ingredients, **some use commas**, some use **dashes**, some just use **spaces**. For our app to scan products as fast as possible, we need to recognise which word is an ingredient and which isn't, so our search algorithm doesn't have to search for words that aren't ingredients.
+Another way to improve our text filter was to **look for the word 'ingredients'** or variations of it. In most cases, the list of ingredients starts with the word 'ingredients', so **finding this word** in our text **helped us locate the list of ingredients** in our scanned text.
+
+#### Allergies
+One of our **core features** is the allergy feature. This feature **derived from one of our User Personas** that we created for our app. **People with allergies** can use our app to **manage** them and use it as a **signal** for whenever they are about to **buy a product they are allergic to**.  
+
+
+{{</section>}}
+
+<!--{{<image src="dummy_feature_image_01.png" alt="An Essential Functionality" caption="An Essential Functionality">}} -->
+{{<section title="String matching algorithm">}}
+Levenshtein distance is an **approximate string matching algorithm**, which calculates the distance between two words.
+The distance is calculated via the three operations: **insertion, deletion and substitution**.
+The reason we needed an **approximate** string matching algorithm, is because we are working with text recognition and text recognition is **prone to errors**.
+We used this algorithm in **combination** with the **Trie data structure** in order to guarantee **fast querying** of our data.
+{{</section>}}
+
+{{<gist "jonathanjander" "a56dde942b2aa9ad7e78887e6086fc97">}}
+
+
+<!--{{<section title="A Copy-pasted Feature">}}
+And, as I lie **close to the earth**, a thousand unknown plants are noticed by me: when I hear the buzz
+of the little world among the stalks, and grow familiar with the countless indescribable forms of
+the insects and flies, then I feel **the presence of the Universe**, which formed us in its own image,
+and the breath of that universal love which bears and sustains us, as it floats around us in an
+**eternity of bliss;** and then, my friend, when darkness overspreads my eyes, and heaven and earth
+seem to dwell in my soul and absorb its power.
+
+Have a look at **this list:**
+* You get a list item
+* And you get a list item
+* And you as well
+* And you get a list item
+* EvErYbOdY gEtS a LiSt ItEm!!!
+
+{{</section>}}
+
+{{<mediathek id="447fbfc91fd121a16b124417cd2c65ae" title="Explanatory Video">}}
+
+ I sink under the weight of the splendour of these visions! A wonderful serenity
+ has taken possession of my entire soul, like these sweet mornings of spring
+ which I enjoy with my whole heart. I am alone, and feel the charm of existence
+ in this spot, which was created for the bliss of souls like mine. I am so happy,
+ my dear friend, so absorbed in the exquisite sense of mere tranquil existence,
+ that I neglect my talents.
+ -->

content/ss21/bachelor/b0-template-project/future.md

@@ -0,0 +1,26 @@
++++
+title = "Future"
+weight = 4
++++
+
+{{<section title="So, what's next?">}}
+While things like improving the text recognition or speeding up the scanning are ongoing processes, we still have some ideas for new features that will improve the app.
+One thing that is on our bucket list, is to contact the **European Commission** because they have **shown interest** in projects that use their data. 
+The European Commission has other datasets that are related to the CosIng dataset that we use, so we want to **expand our dataset** and implement relations between these datasets.
+
+{{</section>}}
+
+{{<section title="Features">}}
+#### Groups for common allergies
+There are a couple of common allergies like peanuts and shellfish out there. Our idea is to have **groups** for these allergies. Once a user selects one of the products, we **mark all the related allergies** to that product. It should make the **initial setup** of our app a little **easier**.
+
+#### Advanced camera
+While our camera does what it is supposed to do, it is still pretty bare bones. **Post-processing for our images** is the keyword here. Little things like **adjusting the brightness** so the text recognition has an easier time recognising the text. We also want to give the user options like **turning on the flashlight** etc.
+
+#### Barcode scanning
+There are a couple of apps out there that can scan the barcode of cosmetic products. While scanning the text is generally a better idea because not all products have barcodes on them, scanning the barcode still has a **couple of perks**, so **providing both options** is something we will look into as an upcoming feature.
+
+#### Expandable database by users
+One of our ideas would be to **give the users the chance** to **improve our app** by adding useful information to the substances itself. They could either **add additional information** to the content that is already there or just have some **notes** to the substances, like their **prior experiences**, connections to other substances, etc.
+
+