Skip to content

Latest commit

 

History

History
240 lines (185 loc) · 7.71 KB

README.org

File metadata and controls

240 lines (185 loc) · 7.71 KB
Raw

Choppella Research Lab

Introduction

This document details the structure of the Choppella’s research lab web pages and the steps to be followed to update the content of the pages.

Repository

Follow the link to access the repository of Gitlab containing sources of these pages.

Structure

This repository is organized as follows :

Structure of the repo

The repository must have a src folder and all the source files must be under src directory. Example ::

—README.org
—make
—init
—index.org
—src
—header.org
—slider.org
—home.org
—team.org
—research.org
—publication.org
—teaching.org
—jobs.org
—contact.org
—style
—style
—style.css
—js
—main.js

Steps to build

Since code is situated within the narrative, one has to build these documents to generate code and documents for publication. While the code is understood by the compiler, the documents will be published in html.

Steps to build and run the appliciton

Refer to a sample makefile for reference.

#SHELL := /bin/bash CODE_DIR=build/code PWD=$(shell pwd) LINT_FILE=${PWD}/${CODE_DIR}/lint_output EXIT_FILE=${PWD}/exit.txt STATUS=0

all: build

init: ./init.sh

build: init make -f tangle-make -k all

clean: make -f tangle-make clean

Run the following command to build

make -k all

Build Directory and .gitignore

The build process generates a build folder containing docs and code directories. This build folder is not version controlled since it is generated and to allow git to ignore generated files.

build/ code/ docs/ elisp/ style/ src/style elisp

Steps to host and test

  • Host source files (build) in the respective server

Steps to add content for pages

Index.org

Purpose :: This file contains all source (.org) pages.

Filename with link :: index.org

Instructions ::

  1. Include all pages in the index.org using the following command example: #+include: “./src/header.org”

Header section

Purpose :: Header section consists logo research lab name and search bar.

Filename with link:: header.org

Instructions::

  1. Go to the header.org
  2. Change the logo and name

Slider section

Purpose:: Slider section consists of

  1. Slider : This will slide different posters.
  2. Latest updates : Latest updates will have current updates of positions at research center.

Filename with link :: slider.org

Instructions ::

  1. Go to the slider.org
  2. Upload the files on fileserver
  3. Take the url and add in the slider section.

Home

Purpose:: Home section consists details about research lab, content should add in the home.org.

Filename with link:: home.org

Instructions::

  1. Go to the home.org
  2. Add the content about search lab in the home menu.

Team

Purpose:: Team section consists students details like photo, name and research topic. photos (Professor/Students) needs to be update. content should add in the team.org.

Filename with link:: team.org

Instructions::

  1. Go to the team.org
  2. Upload photos on fileserver and update url on team section.
  3. Add the student name in the “name field” and research topic name on “research-topic field”.

Research

Purpose:: Research section consists research areas and funded projects details. Content added from the Content added from the pascal link website content should add in the research.org.

Filename with link:: research.org

Instructions::

  1. Go to the research.org
  2. Add research topic in the resection section.

Publications

Purpose:: Publicaitons section consists detaisl of all published papers like paper title, conference details, author names, DOI details (along with url), website details (along with url), published year and pages. Content added from the Content added from the pascal link website

Filename with link:: publications.org

Instructions::

  1. Go to the publication.org
  2. Add publicaiton title, conference name, authors details, DOI details and published website details in the publicaiton menu

Teaching

Purpose:: Teaching section consists detaisl of all teaching topics content added from the Content added from the pascal link website if more content needs to be added update the content in the section of teaching.org.

Filename with link:: teaching.org

Instructions::

  1. Go to the teach.org
  2. Add course details in the teaching menu

Job

Purpose:: Job Section consists details of current positions like PhD Positions, MS by Research Positions, 2018 Summer Internships and BTech and MTech Projects. if more content needs to be added update the content in the section of job.org.

Filename with link:: job.org

Instructions::

  1. Go to the job.org
  2. Add content about job details in the job menu

Contact

Purpose:: Contact Section consists details of research lab Location, Mail address, office/admin Phone numbers, professor email id, route map, Office Hours for 2018 Monsoon and Appointment details. all details added form the pascal link website. if more details needs to be added, update in the section of contact.org.

Filename with link:: contact.org

Instructions::

  1. Go to the contact.org
  2. Update the contact details in the job menu

Footer section

Purpose:: Footer section consists only insitute logo and research lab name details. if more details needs to be added, update in the section of footer.org.

Filename with link:: footer.org

Instrucions::

  1. Go to the footer.org
  2. Add the details about lab details and copyright details.

Styling

Purpose:: Style.org having whole website styling details. We can add enhancement stylings if needed more enhancements.

Filename with link:: styles.org

File Instruction::

  1. Go to the style.org
  2. Add the stylings in the respective section for enhancements if needed.