← Back to team overview

ubuntu-manual team mailing list archive

Re: [Bug 504058] Re: Currently no uniform method of writing code and directives

 

How about using something like this for code blocks?

\fcolorbox{Bittersweet}{White}{
\texttt{\$sudo apt-get autoremove}
}

You end up with something like the following example:

http://imagebin.org/78854

I'm not great at latex so it's probably not a very elegant solution, but
it's a start perhaps...

Jamin

On Fri, Jan 8, 2010 at 6:14 PM, Wolter Hellmund <wolterh6@xxxxxxxxx> wrote:

> Ok, I think that code blocks is the only way to go as for this matter.
> Why? They make it easy to distinguish between what is author-written
> normal text and what is a command or something.
> Now, I have a little suggestion here respecting commands.
> Commands to be entered as root should be preceded with a # character,
> and non-root commands with a $ character. Of course, it should be
> previously explained to users that sudo, or even su can enable root user
> mode.
> Why? Because then, when a user goes into another linux distro, and tries
> to use sudo, he won't be able to. Moreover, if he opened a root terminal
> he would still attempt to use sudo which would be... um.. unuseful, to
> be polite.
>
> So, I think that code blocks are the way to go for terminal input and
> other instructions of that sort.
>
> Now, as for routes as to where to click and such, I think that we could
> have different types of code blocks, as in having different icons for
> each type. For example, terminal input code blocks must have a terminal
> icon, of course. Routes (as in System > Preferences > ...) must have
> another icon. What will that icon be? I don't know. Lets figure that out
> later.
>
> Sorry for the big post team. I hope I did not just rant in here.
>
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~ubuntu-manual
> Post to     : ubuntu-manual@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~ubuntu-manual
> More help   : https://help.launchpad.net/ListHelp
>

Follow ups

References