Skip to content

Conversation

daniel-birket
Copy link
Contributor

See #6270, #2580.

This pull-request contains the other seven graphviz layout commands in
addition to dot, which is awaiting approval at #6270. These files
are generated from the same template as dot.md there. The eight
commands differ in the command name, description line and the content
of the echo command in one example. (If any more changes are
required, I will regenerate all the files together.)

  • The page (if new), does not already exist in the repository.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

These changes are in preparation for adding commands: `neato`,
`circo`, `twopi`, `pfd`, `spfd`, `osage` and `patchwork`, which use
the same command syntax. This one is to argue over before posting the
other seven that are generated from the same template. Changes:

- use `gv` extension, not `dot`. Author uses `gv`.
- link to command usage guide page
- specify the type of layout in the description (varies)
- use `input` and `image` not `file` or `out_file`
- provide a list of available image formats
- show how to use the engine as a filter
- give the help command
See #6270, #2580.

This pull-request contains the other seven graphviz layout commands in
addition to `dot`, which is awaiting approval at #6270. These files
are generated from the same template as `dot.md` there. The eight
commands differ in the command name, description line and the content
of the `echo` command in one example. (If any more changes are
required, I will regenerate all the files together.)
@CleanMachine1 CleanMachine1 added mass changes Changes that affect multiple pages. new command Issues requesting creation of a new page or PRs adding a new page for a command. labels Jul 31, 2021
@navarroaxel navarroaxel changed the title circo, fdp, neato, osage, patchwork, sfdp, twopi : add pages circo, fdp, neato, osage, patchwork, sfdp, twopi: add page Aug 1, 2021
@daniel-birket daniel-birket mentioned this pull request Aug 1, 2021
41 tasks
Copy link
Contributor

@marchersimon marchersimon left a comment

Choose a reason for hiding this comment

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

Apart from the -T ...-T {{...}} changes I requested in the dot PR, everything looks good.
(For fellow maintainers: All the pages are the same, except for the command, so there isn't much to review)

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Looks ok to me! Thanks, @daniel-birket :D

Not sure if we should be encouraging people to use the GIF image format though, since it's old, obsolete, and has many limitations such as 256 colours (PNG replaces it in pretty much every way - including animation, though for animation you may wish to consider an actual video file, as it's likely to have an exponentially smaller filesize).

Copy link
Contributor

@marchersimon marchersimon left a comment

Choose a reason for hiding this comment

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

@sbrl sbrl merged commit 31fa8a0 into tldr-pages:main Aug 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mass changes Changes that affect multiple pages. new command Issues requesting creation of a new page or PRs adding a new page for a command.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants