Preface

This is the site to hold a curated place for documentation about anything techie.

Conventions

The text presents some conventions to emphasize content or draw attention.

To emphasize general concepts.
To emphasize advices.
To emphasize relevant contents.
Concepts to bear in mind.
Concepts to care about.

We use a number of typographical conventions within this book that distinguish between different kinds of information.

Code in the text, including commands, variables, file names, CSS class names, and property names are shown as follows:

Spring Boot uses a public static void main entry-point that launches an embedded web server for you.

A block of code is set out as follows. It may be colored, depending on the format in which you’re reading this book.

<form>
  <input type="search" name="query" [(ngModel)]="query" (keyup.enter)="search()">
  <button type="button" (click)="search()">Search</button>
</form>
@RestController
class BlogController {
    private final BlogRepository repository;

    // Yay! No annotations needed for constructor injection in Spring 4.3+.
    public BlogController(BlogRepository repository) {
        this.repository = repository;
    }

    @RequestMapping("/blogs")
    Collection<Blog> list() {
        return repository.findAll();
    }
}

When we want to draw your attention to certain lines of code, those lines are annotated using numbers accompanied by brief descriptions.

export class SearchComponent {
  constructor(private searchService: SearchService) {} (1)

  search(): void { (2)
    this.searchService.search(this.query).subscribe( (3)
      data => { this.searchResults = data; },
      error => console.log(error)
    );
  }
}
1 To inject SearchService into SearchComponent, add it as a parameter to the constructors’s argument list.
2 search() is a method that’s called from the HTML’s <button>, wired up using the (click) event handler.
3 this.query is a variable that’s wired to <input> using two-way binding with [(ngModel)]="query".
Tips are shown using callouts like this.
Warnings are shown using callouts like this.
Sidebar

Additional information about a certain topic may be displayed in a sidebar like this one.

Finally, this text shows what a quote looks like:

In the end, it’s not the years in your life that count. It’s the life in your years.
— Abraham Lincoln

Four score and seven years ago our fathers brought forth on this continent a new nation…​

— Abraham Lincoln
Address delivered at the dedication of the Cemetery at Gettysburg
A person who never made a mistake never tried anything new.
— Albert Einstein

A person who never made a mistake never tried anything new.

If you don’t know where you are going, any road will get you there.

— Charles Lutwidge Dodgson
Mathematician and author, also known as Lewis Carroll