Skip to content

Plasma/KWin Scripting Cleanup

Chris Holland requested to merge cholland/develop-kde-org:work/scripting3 into master

Plasma Scripting

  • Cleanup Desktop/Panel/Containement scripting sections.
  • Fix missing changes from PlasmaTwoDesktopScripting (Issue #52).
  • Fix "Running Scripts" sections based on PlasmaTwoDesktopScripting.
  • Move filepaths and commands to pre tags.
  • Wrap shortcut in code tag.
  • Add ~/.config/plasmashellrc [Updates] example.
  • Remove duplicate "Update Scripts" section.
  • Link to plasmoidsetupscripts example in plasma-phone-components.
  • Reword the Activities blurb with screenshots.
  • Confirm createActivity(name, plugin) is the proper arguments, however it seems that the plugin argument does not matter since it always uses the default desktop layout. (Issue #52)
  • Demonstrate how to set the wallpaper of a new activity.
  • Mention there is no Activity type.
  • List createActivity() in the function list.
  • Link to scripting panel.h and containment.h
  • Link formFactor to API docs.
  • Move Panel properties to it's section.
  • Document Panel.offset property.
  • Create a Desktops section for Desktop specific properties like the wallpaperPlugin property.
  • Fix auto-closed backticks with 4 backticks.
  • Fix plasma/layout-templates/ path. Mention ~/.local/ path too.

KWin Scripting

  • Wrap various enum types in code tags. Format a multiline example.
  • Rewrite kwinscript example as plasmapkg2 cannot install with just a js file
  • Capitalize JavaScript for consistency elsewhere in the paragraph.
  • Link to KWin Scripts on store.kde.org.
  • Fix type where : separator is in the code tag.
  • Add various code tags.

Plasma Widget

  • Cleanup ComboBox._valueRole example and add qml syntax.
  • Fix mutiple typo

TODO:

  • Fix "Containement" and "type" typos in commit messages.
  • Still need to finish cleaning up Plasma Scripting but will probably put that in the next MR.
Edited by Chris Holland

Merge request reports