====== Instructions for EECS Faculty Members ======

Assumption: you are a member of the @faculty access control group and thus have edit permissions to the project listing page.  If you do not have access (and are expecting to have access), please email tech@eecs.yorku.ca

===== To list a project: =====

  - On the Project listing page (for which your edit permissions have been set up), locate an available template entry block. 
    * Each block has its own 'Edit' button - scroll down and choose the edit buttom immediately BELOW the template that can receive your content. 
    * You will never need to edit the top chunk with the page title, etc. keep scrolling down
    * The blocks are found here: [[:2024-25:fall:f24-listing| Proposed Projects for Fall 2024, Listing]]
    * Suggestion: choose the next available block from the top
  - Do not edit any blocks that have already been completed.  Dokuwiki will allow this, so we will need to use human not technological means to not clobber existing content.
  - Start editing the block. The block will lock for 15 minutes.
    * Suggestion: look at prior project listings for information about how to articulate the content: [[:projects | Archive of Current and Past Proposed Projects]]
    * You can prepare your content offline and then copy and paste it in if desired.
  - The course coordinator will monitor the project listing page and attempt to repair any malformed content or errors that crop up.
  - If you don't wish to paste in your own project listing, then email the course coordinator with the content (see the main landing page for the email address) and they will mount the content for you.

===== Guidance: =====
  * One project per block. If you have multiple projects to offer, place each project in its own block.
  * Re: preparing the project listing in advance and then pasting it in... DokuWiki supports its own simple markup language, which tries to make the datafiles to be as readable as possible. It is similar to markdown. Here is the documentation: [[https://www.dokuwiki.org/wiki:syntax|Formatting Syntax]]
  * If you are open to supervising a project, but don't have a specific project to list, you may use the entry block to describe this situation.  Provide some parameters to signal to students what type of projects (topics & methodology) you are open to co-developing.
  * So that we can have a reusable structure, the page [[:projects-upcomingterm|Proposed Projects for the upcoming term]] will point to a new page each term.  This "parent" page will not be editable and instead will contain a link to a child page that will contain the project listings and can be editted by faculty.

===== TEMPLATE =====
Each project must have:
  - a title (formatted as a "Level 3 Headline")
  - timestamp (when was this project listing added or revised?)
  - the course: **must** be one of EECS4080 3.0 Computer Science Project, EECS4088 6.0 Computer Science Capstone Project, or EECS4480 3.0 Computer Security Project
        * the course "EECS 4070 3.0 Directed Studies" is not included in this listing
        * the course "EECS 4090 6.0 Software Development Capstone Project" can be included here; please work with the coordinator of the Software Development Stream to ensure that these project meet criteria. 
  - supervisor info (name, email)
  - description
  - required and recommended skills and pre-reqs
      * under required pre-requisites, please **do not** add pre-reqs that already exist for the course, see [[:course_descriptions]]
      * you cannot relax pre-requisites that already exist for the course.
      * you are responsible for verification of required and recommended skills and pre-requisite courses.  The coordinator will also verify required pre-requisite courses.
  - instructions to students how to proceed (e.g., how to contact you and what they should send you if interested, such as expression of interest, transcript, etc)

<code>
==== TEMPLATE ENTRY 1 - PUT PROJECT TITLE HERE ====

**[added YYYY-MM-DD]**

**Course:**  { EECS4080 | EECS4088 | EECS4480}

**Supervisor:**  NAME

**Supervisor's email address:**  EMAIL

**Project Description:** 
lorem ipsum...

**Required skills or prerequisite courses:**  
  - pre-req 1... **do not** add pre-reqs that already exist for the course, see [[:course_descriptions]]
  - pre-req 2... 

**Recommended skills or prerequisite courses:**
  - recommended skil/prereq1...

**Instructions:**
//state how you wish to receive inquiries of interest//
</code>