Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Examples Page #203

Merged
merged 6 commits into from
Sep 25, 2020
Merged

Added Examples Page #203

merged 6 commits into from
Sep 25, 2020

Conversation

TheCedarPrince
Copy link
Member

I added an examples page. Right now the link for the follow-path example does not work yet as it has not been merged to master. When it has been though, the link should be fine.

@Wikunia - for some reason I am having difficulty displaying a gif inside the table. Could you take a look at what is going on and why I cannot see the gif being rendered? Thanks!

@TheCedarPrince TheCedarPrince added the documentation Improvements or additions to documentation label Sep 25, 2020
@TheCedarPrince TheCedarPrince changed the base branch from master to v0.2 September 25, 2020 17:21
@codecov
Copy link

codecov bot commented Sep 25, 2020

Codecov Report

Merging #203 into v0.2 will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             v0.2     #203   +/-   ##
=======================================
  Coverage   96.89%   96.89%           
=======================================
  Files          19       19           
  Lines         676      676           
=======================================
  Hits          655      655           
  Misses         21       21           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 49afaf0...646200c. Read the comment docs.


| Example |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![](assets/follow\_bezier\_path.gif |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like your missing a ) here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦‍♂️

@TheCedarPrince TheCedarPrince marked this pull request as ready for review September 25, 2020 18:11
@Wikunia
Copy link
Member

Wikunia commented Sep 25, 2020

As mentioned I would make this with three columns and one line per example.
The columns are gif, link and used functions. In this case I would mention: follow_path, makebezierpath, appear(:scale)
Don't you think that this will be helpful if people search for follow_path in the docs?
Maybe because it's not much text it can be:
Two column layout: Gif in one and short explanation of what is done with the link and those tag words in the other.

Explanation would be:
Creating a bezier curve to draw a car and let a circle follow a long that path. The animation uses also appear and disappear functionalities to make the animation more pleasing to watch. Blablabla 😄

| [Follow a Path](https://github.com/Wikunia/Javis.jl/blob/master/examples/follow_path.jl) |
| Example | Link | Details |
|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![](assets/follow_bezier_path.gif) | [Follow a Path](https://github.com/Wikunia/Javis.jl/blob/master/examples/follow_path.jl) | This creates a bezier curve to draw the outline of a car and have a circle go around that outlined path. [`follow_path`](@ref), [`makebezierpath`](@ref), and [`appear`](@ref) were used to create this animation. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makebezierpath is not available for ref as this is part of Luxor

@TheCedarPrince TheCedarPrince merged commit 2386128 into v0.2 Sep 25, 2020
TheCedarPrince added a commit that referenced this pull request Sep 25, 2020
* Wik feature progressmeter (#137)

* Merged the latest master into v0.2
* Using ProgressMeter

* VideoIO to render mp4 without saving temp frames (#138)

* first version of VideoIO with mp4

* fixing links in documentation (#144) (#145)

* fixing links in documentation (#144)

* first version of HowTo (#142)

* Using Animations.jl (#125)

* first version of Animations.jl

* don't allow v2.5 of Luxor because of transposing (#149)

* Wik documentation howto (#148)

* made review changes for HowTo

* docstrings for structs (#150)

* Forgot to push sethue to Animations.jl (#153)

* allow sethue in Animations.jl
* allow 2.5.1 of Luxor
* added extra line for an example of `sethue`

* merge master in v0.2

* Format file for the repository

* Removing old contributing file

* Added info on dependencies and JuliaFormatter

* Revert "merge master in v0.2"

This reverts commit a853a0f.

* Revert files to a853a0f

* Tutorial animations (#157)

* Animation tutorial

* Wik feature morphing v2 (#154)

* ability to morph with fill.

* [WIP] Live Preview (#119)

* Starting proof of concept on live preview

* Reverted Javis.jl to previous formatting

* Began work on proof of concept

* Beginning of the javis image viewer

* Continued work on trying to preview images

* Barebones example of GTK image viewer

* get_javis_frame function

* Added compat for images and updated authors

* Proof of concept javis viewer signal emission

* Temporary fix for Image compat

* Added buttons and todos

* Added functionality for buttons

* Fixed up Project TOML for compat with Images

* Fixed merge conflict logic bug

* Got proof of concept of live viewer working

* Beginning clean up of javis image viewer

* Added ColorTypes and color conversion for frames

* Added ColorTypes dependency

* Cleaned up and adding documentation strings

* Exported get_javis_frame function

* Prepped javis viewer for full integration into Javis

* Added Gtk and GtkReactive deps

* Added liveview kwarg

* Finished prototype of javis viewer

* Updated boundaries for deps

* Clarified docstrings

* Added arrow key navigation through frames

* Updated boundaries per Ole suggestion

* Fixed up formatting for CI

* Made live rendering faster

* Added loop around functionality

* Adjusted boundaries of deps

* Increased speed of image preview display

* Functionalized repeated code snippets

* Bug in javis viewer - identification attempt

* Made javis viewer work completely

* Reversion to a6fa540

* Made short circuit eval of live viewer

* Documented javis viewer thoroughly

* Added docstring

* Qualified usage of LightXML.value func

* Qualified textbox usage

* Formatting... 👀

* test with xvfb on ubuntu

* without --project

* try with project=.

* different idea using DISPLAY

* fix Documentation CI

* Added documentation for get_javis_frame

* Reduced code reuse

* Added some clarifications

* Removed export of get_javis_frame

* Changed returns for testing

* Added GtkReactive to Project

* Tests for javis_viewer

* Formatting again

* Final test case for increment/decrement tests

* Formatting test file

* Final clean up to javis viewer

Co-authored-by: Ole Kröger <[email protected]>

* removed possibility to set the fontsize inside the latex function (#180)

* removed possibility to set the fontsize inside the latex function

* ability to animate text (#162)

* ability to animate text

* Let us follow a path (#163)

* Let us follow a path

* push preview (#182)

* Update Change Log (#183)

* Added info about live viewer and javis frame

* Added info about drawing text

* Improved Action Error Msg (#185)

* Added error msg about defining Video first

* Added unit test and cleaned up code

* How To:  draw_text, follow_path and liveview (#184)

* added draw_text, follow_path and liveview in HowTo

* return 1.0 in interpolation for single frame (#188)

* [Bugfix] scaling to 0 (#191)

* don't ever scale to 0 :D

* [Bugfix] Follow path starting after first frame (#192)

* bugfix for follow_path if not on first frame

* Drafted showcase table for README

* Images for drafted showcase

* Formatted tables for showcase

* Wik examples follow path (#198)

* first version of an examples folder: drawing a car

* convert frame only once (#199)

* no need to convert to ARGB32

* refactoring (#194)

* refactoring

* merge fix renaming

* resolved typos

* Added back headers for table

* Update for Tutorial 5 (#200)

* Remove any files stored in test/images (#195)

* Remove any files stored in test/images

* Removed file check and created it as a unit test

* Unit test for test/images dir to check for additional files

* Added formatting

* Began update of tutorial 5

* Updated gifs

* Fixed gifs

* Added additional explanation on SubAction

* Merged unit with v0.2

* Added example of drawing a path

* Resized gif to 350 x 350

* fixed tutorial links in readme

* Changed compat entries to allow more (#202)

* changed compat entries to allow more

* changelog ready for merge

* Tutorial overhaul (#201)

* explaining Action and Scaling and fixing some others

* removed some "The"

* emoji fixes and some other small things

* Corrected grammar and some light editing

* Fixed some grammar issues

Co-authored-by: Jacob Zelko <[email protected]>

* Added Examples Page (#203)

* Added examples page link

* Added bezier path gif

* Drafted first table for examples

* Rendered examples properly

* Added explanation for example

* Fixed reference

Co-authored-by: Jacob Zelko <[email protected]>
@TheCedarPrince TheCedarPrince deleted the documentation-examples branch October 2, 2020 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants