Alexader/RIO

Web app for multi-user annotation on PDF files

Variorum

This is a project for NUS 2016 summer Orbital Program

the idea of this project comes from NotaBene

the following is to unify the coding style

• html

  • the assignment of HTML elements should NOT use space to seperate "="

  <div class="container"></div>

  • the class name in html should also follow JAVA convention (camelCase), while attribute "id" and "name" should use lower-case letters seperated with underscore "_"

  <div class= "FileViewer">
      <div class="Page">     
          <img id="first_page_picture" src="">
          <iframe name="first_page_iframe"></iframe>
      </div>
  </div>

  • all the html file should be named with words seperated using "_"

  sign_up_page.html
  

• javascript/jquery

  • the style for javascript code should follow CS1101S standard EXCEPT the naming convention

  function mouseInChangeColor(obj) {
      if (obj.innerHTML == "submit")
          obj.className = "btn btn-info";
      else if (obj.innerHTML = "clear")
          obj.className = "btn btn-warning";
  }

  • the naming for author-created functions and classes should follow JAVA convention (camelCase)

  var nextStep = false;

• python

  • the names for the classes should also follow JAVA convention (CamelCase)

  • the names for the pyton modules (python files), methods, functions, fields, variables shuld all use lower-case words seperated using underscore "_" (PEP8)

  • django style

  • PEP8