-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add new commands and adjust the readme/changelog.
- Loading branch information
mauricio.moreira
authored and
mauricio.moreira
committed
Jan 23, 2021
1 parent
61600ab
commit f3207d7
Showing
6 changed files
with
140 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# CHANGELOG | ||
|
||
## [1.0.0] - 2021-01-04 | ||
### Added | ||
- It added the `libs` folder that have this files: | ||
- code-style.tex | ||
- emblemufc.pdf | ||
- logoUFCbackground.png | ||
- preamble.tex | ||
- ufc_format.cls | ||
- It added the `code` folder with some example codes | ||
- helloworld.java | ||
- index.html | ||
- main.py | ||
- source.c | ||
- It was add the `.gitignore` file | ||
|
||
## [1.1.0] - 2021-01-10 | ||
### Fixed | ||
- Fixed the bug of multi-columns. | ||
- Algorithms colors | ||
|
||
### Added | ||
- It added the command `\source{}` in the figures. | ||
|
||
## [1.2.0] - 2021-01-15 | ||
### Fixed | ||
- Adjustment of the documentation | ||
- Adjustment of the `code_styles.tex` file | ||
|
||
## [1.3.0] - 2021-01-22 | ||
### Added | ||
- It added a new command: `\email{}` | ||
- It added a new default slide (the last slide) | ||
|
||
### Fixed | ||
- Adjustment the 'Sumario' slide for two columns | ||
- Fixed the reference's slide bug |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,66 @@ | ||
# What is it? | ||
<!-- UFC figure pixel --> | ||
<div align="center"> | ||
<img class="aligncenter" src="libs/ufcpixel.png" width="220px" height="220px"/> | ||
</div> | ||
|
||
This project aims to create a template for presentation for the Federal University of Ceará (UFC). It was created a class called **ufc_format.cls** with a set of environments and commands related to the document. | ||
<br/> | ||
|
||
<!-- Title --> | ||
<div align="center"> | ||
<h1><b>Template Beamer UFC</b></h1> | ||
</div> | ||
|
||
<!-- Badges --> | ||
[![made-with-latex](https://img.shields.io/badge/Made%20with-LaTeX-1f425f.svg)](https://www.latex-project.org/) | ||
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/maumneto/TemplateBeamerUFC)[![GitHub issues](https://img.shields.io/github/issues/maumneto/TemplateBeamerUFC)](https://github.com/maumneto/TemplateBeamerUFC/issues)[![GitHub stars](https://img.shields.io/github/stars/maumneto/TemplateBeamerUFC)](https://github.com/maumneto/TemplateBeamerUFC/stargazers)[![GitHub forks](https://img.shields.io/github/forks/maumneto/TemplateBeamerUFC)](https://github.com/maumneto/TemplateBeamerUFC/network)[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/maumneto/TemplateBeamerUFC)[![Overleaf badge](https://img.shields.io/badge/Is_in_Oveleaf_Repository%3F-Yes!-<COLOR>.svg)](https://shields.io/) | ||
|
||
|
||
<!-- Table of Contents --> | ||
<p align="center"> | ||
<a href="#what is it?">What is it?</a> • | ||
<a href="#for whom?">For Whom?</a> • | ||
<a href="#tips">Tips</a> • | ||
<a href="#changelog">Changelog</a> • | ||
<a href="#author">Author</a> | ||
</p> | ||
|
||
<!-- Sections --> | ||
## What is it? | ||
|
||
This project aims to create a template for presentation for the Federal University of Ceará (UFC). It was created a class called **ufc_format.cls** with a set of environments and commands related to the document. This template is not an official document from the Federal University of Ceará. However, this template can be used to create classes, presentations, short courses, etc. | ||
|
||
## For Whom? | ||
|
||
This template can be useful for the Federal University of Ceará (UFC) professors and students. | ||
|
||
## Tips of this Template | ||
- <b>Professors:</b> for creating classes and presentations | ||
|
||
- <b>Students:</b> for assignments and presentations | ||
|
||
## Tips | ||
|
||
Some tips for using this template | ||
|
||
### Blocks | ||
|
||
- Default Block | ||
|
||
```tex | ||
\begin{block}{Default Block} | ||
Body of default block. | ||
\end{block} | ||
``` | ||
|
||
- Alert Block | ||
|
||
```tex | ||
\begin{alertblock}{Alert Block} | ||
Body of alert block. | ||
\end{alertblock} | ||
``` | ||
|
||
- Example Block | ||
|
||
```tex | ||
\begin{exampleblock}{Example Block} | ||
Body of example block. | ||
|
@@ -64,13 +100,17 @@ Some tips for using this template | |
``` | ||
|
||
### Codes | ||
|
||
It is possible to insert codes in this presentation. This template uses two packages for algorithms: `algorithm2e` and `listings`. | ||
|
||
- **Documentation** | ||
|
||
- algorithm2e: [Algorithm2e Package Documentation](http://linorg.usp.br/CTAN/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf) | ||
|
||
- listings: [Listings Package Documentation](http://linorg.usp.br/CTAN/macros/latex/contrib/listings/listings.pdf) | ||
|
||
The following example shows how to create a pseudocode: | ||
|
||
```tex | ||
\begin{algorithm}[H] | ||
\SetAlgoLined #includes indentation | ||
|
@@ -132,10 +172,31 @@ The following example shows how to insert a multi-columns: | |
\end{columns} | ||
``` | ||
|
||
### Custom Commands | ||
|
||
This template has some custom commands that are described below: | ||
|
||
To print 'Universidade Federal do Ceará' | ||
```tex | ||
\ufc | ||
``` | ||
|
||
To put the department name | ||
```tex | ||
\department{Department Name} | ||
``` | ||
|
||
To put the email | ||
```tex | ||
\email{user@domain} | ||
``` | ||
|
||
## Changelog | ||
|
||
[Changelog File](./CHANGELOG.md) | ||
|
||
## Author | ||
<center><b>Maurício Moreira Neto</b></center> | ||
<p align="left"> | ||
<a href="https://github.com/maumneto">GitHub</a> • | ||
<a href="https://maumneto.github.io/mauriciomoreira/">Personal Site</a> • | ||
<a href="https://linktr.ee/maumneto">LinkTree</a> | ||
</p> | ||
|
||
Developed by <b>Maurício Moreira Neto</b> :metal: | ||
|
||
[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:[email protected])[![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/maumneto)[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/maumneto/)[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@maumneto)[![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/maumneto) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -182,4 +182,11 @@ | |
\vspace*{0.2cm} | ||
\bfseries | ||
\normalsize{#1} | ||
} | ||
|
||
% | ||
\newcommand{\email}[1]{ | ||
\texttt{ | ||
\href{mailto:#1}{#1} | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.