Introduction

This is the API documentation the functions which drive this page. It will be written in a style to enable reusage of these functions in your page. I assume that you have running a basic AngularJS web app running and load the libraries defined in /app/js/main.js.

Members

• Introduction

Controllers

The controller must be responsible for binding model data to views using $scope, and control information flow. It does not contain logic to fetch the data or manipulating it.

Members

• Controllers
  • Controllers.CommentsCtrl
    • CommentsCtrl.getComments()
    • CommentsCtrl.deleteComment(event)
    • CommentsCtrl.submit()
  • Controllers.DocCtrl
  • Controllers.KeenioMasterCtrl
  • Controllers.WikiquoteCtrl
  • Controllers.TableCtrl
  • Controllers.GithubModalCtrl
  • Controllers.GithubCtrl
    • GithubCtrl.login()
    • GithubCtrl.requestCode()
    • GithubCtrl.logout()
    • GithubCtrl.UserModel::userLoggedIn()
    • GithubCtrl.UserModel::userLoggedOut()
  • Controllers.ConfigCtrl
    • ConfigCtrl.saveFrontendConfig()
    • ConfigCtrl.saveBackendConfig()
  • Controllers.ToasterController
    • ToasterController.pop(toast)
  • Controllers.GithubForkCtrl
    • GithubForkCtrl.checkUnique()
    • GithubForkCtrl.fork()
  • Controllers.AdminCtrl
  • Controllers.ExportCtrl
    • ExportCtrl.zip()
  • Controllers.ImportCtrl
  • Controllers.GithubEditCtrl
    • GithubEditCtrl.getTagClass(city)
  • Controllers.RatingCtrl

Controllers.CommentsCtrl

Bundles functions to receive and save comments

Members

• Controllers.CommentsCtrl
  • CommentsCtrl.getComments()
  • CommentsCtrl.deleteComment(event)
  • CommentsCtrl.submit()

CommentsCtrl.getComments()

receive comments

CommentsCtrl.deleteComment(event)

receive comments

Params

• event

CommentsCtrl.submit()

receive comments

Controllers.DocCtrl

xyz

Members

• Controllers.DocCtrl

Controllers.KeenioMasterCtrl

xyz

Members

• Controllers.KeenioMasterCtrl

Controllers.WikiquoteCtrl

xyz

Members

• Controllers.WikiquoteCtrl

Controllers.TableCtrl

xyz

Members

• Controllers.TableCtrl

Controllers.GithubModalCtrl

xyz

Members

• Controllers.GithubModalCtrl

Controllers.GithubCtrl

As soon as the GithubCtrl is injected it checks if config.heroku.authenticate is in the configuration file config.js . If it is available it will use the oAuth workflow - if not it will ask for Username/Password.

if the owner of the repository login:

• edits on the blog are possible
• login by someone else: create an empty fork of the repository, automatically available
• ask for a name: the fork will be created for that name: xyz.github.io
• poll for repo.contents until the forked repo is ready
• guide them with a link to the new repo and encourage them to click on “edit”

Members

• Controllers.GithubCtrl
  • GithubCtrl.login()
  • GithubCtrl.requestCode()
  • GithubCtrl.logout()
  • GithubCtrl.UserModel::userLoggedIn()
  • GithubCtrl.UserModel::userLoggedOut()

GithubCtrl.login()

if no token is available listen for button click…

GithubCtrl.requestCode()

request a oAuth token from Github

GithubCtrl.logout()

Calls GithubAuthService.logout() - this is not really a logout from github, but the access token is deleted

GithubCtrl.UserModel::userLoggedIn()

bind user model to the view and listen for events

GithubCtrl.UserModel::userLoggedOut()

clears logged in user

Controllers.ConfigCtrl

xyz

Members

• Controllers.ConfigCtrl
  • ConfigCtrl.saveFrontendConfig()
  • ConfigCtrl.saveBackendConfig()

ConfigCtrl.saveFrontendConfig()

Commit frontend config file back to github

ConfigCtrl.saveBackendConfig()

Commit backend config file to github

Controllers.ToasterController

xyz

Members

• Controllers.ToasterController
  • ToasterController.pop(toast)

ToasterController.pop(toast)

Show popup message

Params

• toast

Controllers.GithubForkCtrl

xyz

Members

• Controllers.GithubForkCtrl
  • GithubForkCtrl.checkUnique()
  • GithubForkCtrl.fork()

GithubForkCtrl.checkUnique()

This checks if the repo already exists

GithubForkCtrl.fork()

manages to fork this page

Controllers.AdminCtrl

Unlock admin functionality

Members

• Controllers.AdminCtrl

Controllers.ExportCtrl

This controller exports/imports post as a zip

Members

• Controllers.ExportCtrl
  • ExportCtrl.zip()

ExportCtrl.zip()

zip files

Controllers.ImportCtrl

This controller imports posts from a zip archive

Members

• Controllers.ImportCtrl

Controllers.GithubEditCtrl

This controller manages edits on content on github

Members

• Controllers.GithubEditCtrl
  • GithubEditCtrl.getTagClass(city)

GithubEditCtrl.getTagClass(city)

Set the css style for tags / categories

Params

• city

Controllers.RatingCtrl

Star rating

Members

• Controllers.RatingCtrl

Routes

The controller must be responsible for binding model data to views using $scope, and control information flow. It does not contain logic to fetch the data or manipulating it. ngSantinize - confirm dialogs

Members

• Routes

Services

Services are singleton objects used to share data (e.g. among several controllers) and generallyencapsulate reusable pieces of code (since they can be injected and offer their “services” in any part of your app that needs them: controllers, directives, filters, other services etc).

Members

• Services
  • Services.GithubSrvc
    • GithubSrvc.renameRepo(forkName)
    • GithubSrvc.deleteBranch(forkName, branchName)
    • GithubSrvc.getContent(path)
    • GithubSrvc.editContent(path)
    • GithubSrvc.commit(text, path, branch, showMessage, force)
    • GithubSrvc.commitMany(posts, message, showMessage, force)
    • GithubSrvc.deleteContent(path)
  • Services.UserModel
  • Services.UrlSrvc
    • UrlSrvc.parseDateTitle(path)
  • Services.PollingSrvc
  • Services.YamlSrvc
  • Services.EditorSrvc
  • Services.PollingImgSrvc
  • Services.StyleSwitcher

Services.GithubSrvc

xyz

Members

• Services.GithubSrvc
  • GithubSrvc.renameRepo(forkName)
  • GithubSrvc.deleteBranch(forkName, branchName)
  • GithubSrvc.getContent(path)
  • GithubSrvc.editContent(path)
  • GithubSrvc.commit(text, path, branch, showMessage, force)
  • GithubSrvc.commitMany(posts, message, showMessage, force)
  • GithubSrvc.deleteContent(path)

GithubSrvc.renameRepo(forkName)

xyz

Params

• forkName

GithubSrvc.deleteBranch(forkName, branchName)

With the help of this function the template brach is deleted after forkin

Params

• forkName
• branchName

GithubSrvc.getContent(path)

Get content of a file hosted on GitHub

Params

• path

GithubSrvc.editContent(path)

Edit content on a file hosted on github

Params

• path

GithubSrvc.commit(text, path, branch, showMessage, force)

Commit a file back to GitHub

Params

• text
• path
• branch
• showMessage
• force

GithubSrvc.commitMany(posts, message, showMessage, force)

Commit many files back to GitHub

Params

• posts
• message
• showMessage
• force

GithubSrvc.deleteContent(path)

Delete content from GitHub

Params

• path

Services.UserModel

xyz

Members

• Services.UserModel

Services.UrlSrvc

xyz

Members

• Services.UrlSrvc
  • UrlSrvc.parseDateTitle(path)

UrlSrvc.parseDateTitle(path)

This function extracts date and title from a Jekyll path

Params

• path

Services.PollingSrvc

xyz

Members

• Services.PollingSrvc

Services.YamlSrvc

YamlSrvc can parse files with frontmatter (normal post) and the _config.yaml without frontmatter

Members

• Services.YamlSrvc

Services.EditorSrvc

xyz

Members

• Services.EditorSrvc

Services.PollingImgSrvc

xyz

Members

• Services.PollingImgSrvc

Services.StyleSwitcher

xyz

Members

• Services.StyleSwitcher

event: “githubCommitSuccess”

githubCommitSuccess event

loadDevDoc()

Description

loadApiDoc()

Description

loadUserDoc()

Description

login()

Description

Drop me a line!