Difference between revisions of "How to avoid DOS line endings in Windows tools"

From Second Life Wiki
Jump to navigation Jump to search
(Added Programmer's Notepad to the list, in alphabetical order)
(Coding standard says to prefer tabs, not spaces)
Line 4: Line 4:
Standards your editor must support:
Standards your editor must support:
* Lines must end with a <code>LF</code> (linefeed) character.
* Lines must end with a <code>LF</code> (linefeed) character.
* A tab must generate 4 spaces.
* A tab must be the same width as 4 spaces.


==Notepad++==
==Notepad++==
Line 14: Line 14:
** Go to '''Settings''' > '''Preferences''' > '''Language Menu/Tab Settings'''.
** Go to '''Settings''' > '''Preferences''' > '''Language Menu/Tab Settings'''.
** Click on '''Default'''
** Click on '''Default'''
** Change Tab Size to <code>4</code>
** Change '''Tab Size''' to <code>4</code>
** Check the box '''Replace by space'''
** Uncheck the box '''Replace by space'''
** Note: if you are going to be using the program as a general editor you can customize which file types this tab to space conversion applies to.
** Note: if you are going to be using the program as a general editor, you can customize which file types this tab to space conversion applies to.




Line 29: Line 29:
* Tab spacing
* Tab spacing
** Go to '''Tools''' > '''Options''' > '''General''' > '''Defaults'''
** Go to '''Tools''' > '''Options''' > '''General''' > '''Defaults'''
** Make sure the '''Use the tab character for indentation''' setting is ''not'' checked.
** Make sure the '''Use the tab character for indentation''' setting is checked.
** Set '''Tab Width''' to <code>4</code>
** Set '''Tab Width''' to <code>4</code>
* Visible whitespace
* Visible whitespace

Revision as of 11:51, 1 February 2011

If you are going to work on the viewer code you need to conform to the Coding Standard. Standards your editor must support:

  • Lines must end with a LF (linefeed) character.
  • A tab must be the same width as 4 spaces.

Notepad++

Configuring Notepad++ (download Notepad++)

  • Line ending
    • You should not need to specify the line ending for an existing file but for a new file you will want to set Edit > EOL Conversion > UNIX Format
  • Tab spacing
    • Go to Settings > Preferences > Language Menu/Tab Settings.
    • Click on Default
    • Change Tab Size to 4
    • Uncheck the box Replace by space
    • Note: if you are going to be using the program as a general editor, you can customize which file types this tab to space conversion applies to.


Programmer's Notepad

Configuring Programmer's Notepad (download Programmer's Notepad)

  • Per-file Line-ending Setting
    • You should not need to specify the line ending for an existing file but for a new file you will want to set File > Properties... > Line Endings to Unix (LF)
  • To set "Unix" line endings as default for new files
    • Go to Tools > Options > General > Defaults
    • Set Line Endings to Unix (LF)
  • Tab spacing
    • Go to Tools > Options > General > Defaults
    • Make sure the Use the tab character for indentation setting is checked.
    • Set Tab Width to 4
  • Visible whitespace
    • It is convenient to be able to tell at a glance if there are incorrect characters used for indentation or line endings
    • Go to Tools > Options > General > Defaults
    • Check the box Visible Line Endings
    • Check the box Visible Whitespace Characters
  • Correcting line endings on existing files
    • Go to Tools > Line Endings > Unix (LF) to convert the file