xournalpp / xournalpp/xournalpp.github.io

Content to be added

Open
#21 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
66
Forks
66
PR merge metrics
No merged PRs in 30d

Description

I made some thoughts about what needs to be added content-wise to make the website (more or less) complete. Feel free to add/remove and restructure. The + stands for "has to be added from scratch".

  • Overview (+typical workflow, +overview over content of other sections)
  • Tools & Editing (+text, +font/font size, +images, + tool switching including floating toolbox and tool cycle plugin, + vertical space, +colors, +fill, +opacity, +line width, +pressure sensitivity)
  • Configuration (+preferences, +page default, +toolbar customization, +colors, +setting up device classes, +setting up stylus and mouse buttons)
  • Tips (+some useful tips of how to use Xournal++ efficiently)
  • +Selection & Snapping (rectangle, region and object select, snapping to grid, rotation snapping, modifiers, explain moving, scaling and rotation with snapping turned on)
  • +Pages & Layers (sidebar, inserting, deleting, backgrounds)
  • +Layout, Zoom & Navigation (managing different layouts, zoom modes, zoom steps, navigation with keyboard, hand tool, toolbar, accelerators)
  • +File operations (load, annotate pdf, attached mode, export as pdf, export in various formats, export options)
  • +Audio recording (how to record, playback, pause, select play object, set audio folder and options)
  • +Getting help (website, issues, disussions, gitter)
  • +File structure (+where to find which files on what OS and with what version)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the checklist in this issue as the scope, starting with the unfinished Overview, Tools & Editing, Configuration, Tips, Pages & Layers, Layout, File operations, and Audio recording sections. Review the existing website content structure before writing; done means the remaining sections are added, accurate, and the checklist reflects their completion.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.