Quarto Documentation

Thu Sep 14 00:13:28 BST 2023

 Hi there.
Back after a couple of weeks, was finishing my college exams...
I don't know how to use a script to take the screenshots and think it would be great doing this way. I took the screenshots by hand and it was boring :)
About the format of the documentation, i agre that an example project would be much more interesting.
Luis

    Em terça-feira, 29 de agosto de 2023 às 08:00:38 BRT, <rkward-devel-request at kde.org> escreveu:  

 Send rkward-devel mailing list submissions to
    rkward-devel at kde.org

To subscribe or unsubscribe via the World Wide Web, visit
    https://mail.kde.org/mailman/listinfo/rkward-devel
or, via email, send a message with subject or body 'help' to
    rkward-devel-request at kde.org

You can reach the person managing the list at
    rkward-devel-owner at kde.org

When replying, please edit your Subject line so it is more specific
than "Re: Contents of rkward-devel digest..."

Today's Topics:

  1. Re: Quarto Documentation (meik michalke)
  2. Re: Quarto Documentation (Stefan)

----------------------------------------------------------------------

Message: 1
Date: Mon, 28 Aug 2023 13:17:05 +0200
From: meik michalke <meik.michalke at uni-duesseldorf.de>
To: rkward-devel at kde.org
Subject: Re: Quarto Documentation
Message-ID: <23133948.MsLHQvMQhP at yrla>
Content-Type: text/plain; charset="iso-8859-1"

hi,

Am Sonntag, 27. August 2023, 03:27:41 CEST schrieb Luís Gustavo Schuck:
> I worked more then I expected and generated some pages with quarto as
> documentation. Basically just made some screenshots of menus  and mixed
> with some of the things that already exist in the RKWard website.

looking great already :)

> Tried to use RKWard with the default configurations, just altered the theme
> to Breeze Classic because the images of the menus are better (the name of
> the selected menu, using the default theme, is changed to white).

i would suggest to script the screenshot taking procedure as much as possible, 
i.e., let a script open menus and save the result in a defined format. this 
makes it much easier to keep them all up to date in a consistent layout, also 
when RKWard changes with future releases.

i can help with that, i had done that last year to produce the slides for our 
presentation at the UseR! 2022 conference:

 https://www.youtube.com/watch?v=-_6ehPF61t4&t=3445s

> For now i created a github repository to host the material:
> https://github.com/lgschuck/rkward_manual The quarto book can be accessed
> in: https://lgschuck.github.io/rkward_manual/ Luís Gustavo Schuck

we should perhaps discuss the audience and approach of such a book first. i 
think after a short overview of the application it's helpful to go through an 
example project -- importing data, manually editing/adding new data, writing a 
script, some analysis and plots, adding rmarkdown, producing the paper... 
something like that, maybe? all of RKWards main features could be showcased in 
action, and the book could use an index so you can quickly find what you are 
looking for. sounds good?

viele grüße :: m.eik

-- 
  dipl. psych. meik michalke
  institut f"ur experimentelle psychologie
  abt. f"ur diagnostik und differentielle psychologie
  heinrich-heine-universit"at 40204 d"usseldorf
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/rkward-devel/attachments/20230828/4cc6484c/attachment-0001.sig>

------------------------------

Message: 2
Date: Mon, 28 Aug 2023 14:39:48 +0200
From: Stefan Rödiger [GMX] <stefan_roediger at gmx.de>
To: rkward-devel at kde.org
Subject: Re: Quarto Documentation
Message-ID: <8889779.VV5PYv0bhD at box>
Content-Type: text/plain; charset="iso-8859-1"

On Monday, August 28, 2023 1:17:05 PM CEST meik michalke wrote:
> hi,
> 
> Am Sonntag, 27. August 2023, 03:27:41 CEST schrieb Luís Gustavo Schuck:
> > I worked more then I expected and generated some pages with quarto as
> > documentation. Basically just made some screenshots of menus  and mixed
> > with some of the things that already exist in the RKWard website.
> 
> looking great already :)

I agree on that

> 
> > Tried to use RKWard with the default configurations, just altered the
> > theme
> > to Breeze Classic because the images of the menus are better (the name of
> > the selected menu, using the default theme, is changed to white).
> 
> i would suggest to script the screenshot taking procedure as much as
> possible, i.e., let a script open menus and save the result in a defined
> format. this makes it much easier to keep them all up to date in a
> consistent layout, also when RKWard changes with future releases.
> 
> i can help with that, i had done that last year to produce the slides for
> our presentation at the UseR! 2022 conference:
> 
>  https://www.youtube.com/watch?v=-_6ehPF61t4&t=3445s

That is true.

> 
> > For now i created a github repository to host the material:
> > https://github.com/lgschuck/rkward_manual The quarto book can be accessed
> > in: https://lgschuck.github.io/rkward_manual/ Luís Gustavo Schuck
> 
> we should perhaps discuss the audience and approach of such a book first. i
> think after a short overview of the application it's helpful to go through
> an example project -- importing data, manually editing/adding new data,
> writing a script, some analysis and plots, adding rmarkdown, producing the
> paper... something like that, maybe? all of RKWards main features could be
> showcased in action, and the book could use an index so you can quickly
> find what you are looking for. sounds good?
> 

I totally agree with that too. I showed RKWard to an RStudio user last week. 
She has been using R for a long time, but only knew RStudio. She was already a 
little enthusiastic about RKWard.

Thomas has always integrated ingenious features. My favourite technologies are 
the code snippets, with which I could provide many useful templates for R code 
and RMarkdown. In the future, I would also like to provide more YAML snippets 
and LaTeX snippets. The RStudio user was also impressed by the previews. I find 
them more and more ingenious. You could show something like that when the 
basic framework is ready.

> 
> viele grüße :: m.eik

Kind regards
Stefan

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/rkward-devel/attachments/20230828/2fa364b1/attachment-0001.sig>

------------------------------

Subject: Digest Footer

_______________________________________________
rkward-devel mailing list
rkward-devel at kde.org
https://mail.kde.org/mailman/listinfo/rkward-devel

------------------------------

End of rkward-devel Digest, Vol 98, Issue 6
*******************************************

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/rkward-devel/attachments/20230913/65057a3a/attachment.htm>