Difference between revisions of "Help talk:Reading"

From ArchWiki
Jump to: navigation, search
(Revision criteria: rm old discussion)
(Optional dependencies: re, close)
 
(48 intermediate revisions by 7 users not shown)
Line 6: Line 6:
 
Just like article:[[ABS]] is referred to in every page that involves compiling, this page could serve the same kind of utility.
 
Just like article:[[ABS]] is referred to in every page that involves compiling, this page could serve the same kind of utility.
  
== Merge Common Shell files ==
+
{{Unsigned|16:39, 12 November 2009 (UTC)|Manolo}}
Section [[Help:Reading#Common shell files]] should be merged with [[Bash]] and [[Zsh]]. [[User:Manolo|manolo]] 14:53, 13 November 2009 (EST)
+
  
: I think that 'Common shell files' should be in their respected pages. And remove any mention of common files. Is it not the purpose of this page to make the wiki in general easier to read and remove repetition? [[User:M l|M l]] 16:42, 13 November 2009 (EST)
+
== <s>Optional dependencies</s> ==
  
::Yes, but the common files section is specific to Bash and Zsh. Repetition would still be avoided, articles could be:
+
It may be a good idea to add a mention on optional dependencies in [[Help:Reading#Installation of packages]], as articles implicitly assume users are aware of them, and link to [[PKGBUILD#optdepends]]. -- [[User:Alad|Alad]] ([[User talk:Alad|talk]]) 11:54, 18 November 2015 (UTC)
  
:::Add to [[Bash#Configuration|Bash]] files:
+
:I don't know, I thought it was a bit out of scope here and for the moment expanded [https://wiki.archlinux.org/index.php?title=Pacman&type=revision&diff=409546&oldid=409045] instead, do you think it's enough? — [[User:Kynikos|Kynikos]] ([[User talk:Kynikos|talk]]) 02:37, 19 November 2015 (UTC)
      # This alias makes ls colorize the listing
+
      alias ls='ls --color=auto'
+
  
::Instead of what we have now:
+
::Yeah, it's mentioned at the top of the [[pacman]] article, which [[Help:Reading]] isn't supposed to replace. Thanks, closing. -- [[User:Alad|Alad]] ([[User talk:Alad|talk]]) 14:09, 26 August 2016 (UTC)
  
:::Add the following using [[nano]], or [[vim]] to {{ic|~/.bashrc}} for personal settings, or {{ic|/etc/bash.bashrc}} for system-wide changes:
+
== Meaning of comment: location in the article ==
      # This alias makes ls colorize the listing
+
      alias ls='ls --color=auto'
+
:::Don't forget to source the file in order to blahblah:
+
      $ source /etc/bash.bashrc
+
:::{{Tip|'source' can be abbreviated with '.' (a dot).}}
+
  
::Strictly speaking, $ and # differentiation is also specific to Bash, but for the sake of consistency every article should be using Bash-style denotation instead of "run as root" or "if using zsh, the root prompt will look different" etc. etc., so that excerpt belongs here. The same reasons apply with ''editing'' and ''sourcing''. Although I do see why somebody else would argue that it ''also'' belongs in [[Bash]].
+
The meaning of a code comment is mentioned in [[Help:Reading#Regular_user_or_root]], which is before [[Help:Reading#Append.2C_add.2C_create.2C_edit]] linked throughout the wiki (the [[Create]], [[Edit]] and similar redirects). -- [[User:Alad|Alad]] ([[User talk:Alad|talk]]) 14:38, 5 July 2016 (UTC)
  
::And the last section leads to other repetitive tasks that ''should not'' be repeated in every article. This is temporary, and once all editors conform to not including pacman and rc.conf tutorials in their docs, it'll be removed.
+
:And what is the problem? We can either avoid the forward reference ("''Append'' to {{ic|~/path/to/file}}) in [[Help:Reading#Regular_user_or_root]] or keep the root prompts in [[Help:Reading#Append.2C_add.2C_create.2C_edit]]. -- [[User:Lahwaacz|Lahwaacz]] ([[User talk:Lahwaacz|talk]]) 19:02, 5 July 2016 (UTC)
  
::I.e., this article is about interpreting the wiki (but will ''not'' include sections that belong in other articles). The new to GNU/Linux introduction part is a bit misleading.
+
::The idea was that linking [[textedit]] doesn't mention comments or root prompts. By itself however, the structure of [[Help:Reading]] makes sense (if the concept of root prompt is known, demonstrating how to edit system files is easy). Perhaps we should simply generalize the redirects, pointing them to [[Help:Reading]] ? -- [[User:Alad|Alad]] ([[User talk:Alad|talk]]) 14:08, 26 August 2016 (UTC)
 +
 
 +
== Mention tab completion? ==
 +
 
 +
Tab completion makes enabling services and other common commands far easier, also regarding the [[Installation]]. I've added a note to the Installation guide for now [https://wiki.archlinux.org/index.php?title=Installation_guide&diff=442022&oldid=441809], but I think it's better in the long term to mention it here instead. -- [[User:Alad|Alad]] ([[User talk:Alad|talk]]) 14:23, 18 July 2016 (UTC)
 +
 
 +
:Mentioned in [https://wiki.archlinux.org/index.php?title=Help:Reading&diff=442050&oldid=435992], but maybe we should point out that some configuration will be needed ([[Bash#Tab_completion]], [[Zsh#Installation]]/[[Zsh#Command completion]]). -- [[User:Lahwaacz|Lahwaacz]] ([[User talk:Lahwaacz|talk]]) 17:08, 18 July 2016 (UTC)

Latest revision as of 14:09, 26 August 2016

Purpose

Besides covering basic differentiations, this article could serve to improve the quality of the Wiki by avoiding repetition. How many articles say: "edit in ~/.bashrc, or zhrc (if you're using zsh) -- alternatively, edit /etc/profile.bash for system-wide changes" or something to that effect? And even though it sounds counterintuitive, expanding this article makes the Wiki better for advanced users as well, since they won't be presented with the same old information they're accustomed to skip.

We could have a basic run down of common file locations and what they mean, instead of explaining them in every article. Editors can just say "add the following to the shell's configuration" and readers would then decide whether they want it system-wide or not, etc.

Just like article:ABS is referred to in every page that involves compiling, this page could serve the same kind of utility.

—This unsigned comment is by Manolo (talk) 16:39, 12 November 2009 (UTC). Please sign your posts with ~~~~!

Optional dependencies

It may be a good idea to add a mention on optional dependencies in Help:Reading#Installation of packages, as articles implicitly assume users are aware of them, and link to PKGBUILD#optdepends. -- Alad (talk) 11:54, 18 November 2015 (UTC)

I don't know, I thought it was a bit out of scope here and for the moment expanded [1] instead, do you think it's enough? — Kynikos (talk) 02:37, 19 November 2015 (UTC)
Yeah, it's mentioned at the top of the pacman article, which Help:Reading isn't supposed to replace. Thanks, closing. -- Alad (talk) 14:09, 26 August 2016 (UTC)

Meaning of comment: location in the article

The meaning of a code comment is mentioned in Help:Reading#Regular_user_or_root, which is before Help:Reading#Append.2C_add.2C_create.2C_edit linked throughout the wiki (the Create, Edit and similar redirects). -- Alad (talk) 14:38, 5 July 2016 (UTC)

And what is the problem? We can either avoid the forward reference ("Append to ~/path/to/file) in Help:Reading#Regular_user_or_root or keep the root prompts in Help:Reading#Append.2C_add.2C_create.2C_edit. -- Lahwaacz (talk) 19:02, 5 July 2016 (UTC)
The idea was that linking textedit doesn't mention comments or root prompts. By itself however, the structure of Help:Reading makes sense (if the concept of root prompt is known, demonstrating how to edit system files is easy). Perhaps we should simply generalize the redirects, pointing them to Help:Reading ? -- Alad (talk) 14:08, 26 August 2016 (UTC)

Mention tab completion?

Tab completion makes enabling services and other common commands far easier, also regarding the Installation. I've added a note to the Installation guide for now [2], but I think it's better in the long term to mention it here instead. -- Alad (talk) 14:23, 18 July 2016 (UTC)

Mentioned in [3], but maybe we should point out that some configuration will be needed (Bash#Tab_completion, Zsh#Installation/Zsh#Command completion). -- Lahwaacz (talk) 17:08, 18 July 2016 (UTC)