HTML로 프로젝트 문서 작성
HyperText에는 문서의 수준을 높이기 위해 일반 텍스트보다 더 많은 기능이 있습니다.
문서화는 모든 기술 프로젝트에서 중요한 부분입니다. 좋은 문서는 최종 사용자에게 프로그램 실행 방법, 사용 방법, 컴파일 방법을 알려줍니다. 많은 프로젝트에서는 일반 텍스트 문서가 표준입니다. 결국 모든 시스템은 일반 텍스트 파일을 표시할 수 있습니다.
그러나 일반 텍스트에는 제한이 있습니다. 일반 텍스트 파일에는 기울임꼴 텍스트, 굵은 텍스트, 제목과 같은 서식 요소가 없습니다. 이러한 요소를 추가하기 위해 HTML을 활용할 수 있습니다. HTML(HyperText Markup Language)은 모든 웹 브라우저에서 사용되는 마크업 언어입니다. 그리고 조금만 더 노력하면 HTML을 사용하여 모든 사람이 읽을 수 있는 프로젝트 문서를 작성할 수 있습니다.
HTML은 꺾쇠 괄호로 묶인 일련의 태그를 사용하여 문서의 다양한 부분이 표시되는 방법을 제어합니다. 이러한 태그는 문서 제목, 단락, 기울임꼴 텍스트, 굵은 텍스트 및 기타 종류의 텍스트와 같은 HTML 문서의 요소를 정의합니다. 거의 모든 태그는 한 쌍으로 제공됩니다.
와 같이 단락을 시작하는 열기 태그와 요소를 끝내는 닫는 태그(예:
) 단락을 끝내려면. 이러한 태그를 사용할 때는 태그를 열면 닫아야 합니다라는 규칙을 기억하세요. 태그를 제대로 닫지 않으면 웹 브라우저가 제대로 작동하지 않을 수 있습니다.일부 태그는 HTML 문서 내의 블록을 정의하는 반면 다른 태그는 인라인입니다. 블록 및 인라인 요소에 대한 자세한 내용은 HTML에 대한 간단한 소개에 대한 다른 기사를 읽어보세요.
빈 문서 시작
상용구 빈 HTML 문서를 만드는 것부터 시작하세요. 모든 HTML 문서는 문서 유형 선언을 제공해야 합니다. HTML 문서를 정의하려면 HTML 파일의 첫 번째 줄에 단일 태그 을 사용하세요. 또한 HTML 표준에서는 페이지가 HTML 문서를 정의하는 과 본문 텍스트를 정의하는 <body>라는 두 개의 블록 요소로 문서 텍스트를 래핑해야 합니다. HTML은 각각의 새로운 코드 블록을 들여쓰기할 필요가 없지만 어쨌든 추가하여 <body>가 실제로 블록 "내부"에 있다는 것을 알 수 있습니다.
<!DOCTYPE html>
<html>
<body>
</body>
</html>HTML 문서에는 페이지에 대한 메타데이터라는 추가 정보를 제공하는 <body> 앞에 <head> 블록도 필요합니다. 유일한 필수 메타데이터는
<!DOCTYPE html>
<html>
<head>
<title>Title of the document</title>
</head>
<body>
</body>
</html>텍스트를 추가하세요
기존 일반 텍스트 "Readme" 파일을 HTML에 적용하여 HTML 지식을 연습해 보겠습니다. 이 예에서는 Simple Senet이라는 오픈 소스 보드 게임을 플레이하는 방법에 대한 문서의 일부를 사용하고 있습니다.
HOW TO PLAY SIMPLE SENET
The game will automatically "throw" the throwing sticks for you, and
display the results in the lower-right corner of the screen.
If the "throw" is zero, then you lose your turn.
When it's your turn, the game will automatically select your first
piece on the board. You may or may not be able to make a move with
this piece, so select your piece to move, and hit Space (or Enter) to
move it. You can select using several different methods:
- Up/down/left/right to navigate to a specific square.
- Plus (+) or minus (-) to navigate "left" and "right" on the
board. Note that this will automatically follow the "backwards S"
shape of the board.
- Tab to select your next piece on the board.
To quit the game at any time, press Q (uppercase Q) or hit Esc, and
the game will prompt if you want to forfeit the game.
You win if you move all of your pieces off the board before your
opponent. It takes a combination of luck and strategy!빈 HTML 파일에 이 추가 정보 텍스트를 추가하여 시작하세요. HTML 페이지의 주요 콘텐츠는 <body>이므로 여기에 텍스트를 입력합니다.
<!DOCTYPE html>
<html>
<head>
<title>Title of the document</title>
</head>
<body>
HOW TO PLAY SIMPLE SENET
The game will automatically "throw" the throwing sticks for you, and
display the results in the lower-right corner of the screen.
If the "throw" is zero, then you lose your turn.
When it's your turn, the game will automatically select your first
piece on the board. You may or may not be able to make a move with
this piece, so select your piece to move, and hit Space (or Enter) to
move it. You can select using several different methods:
- Up/down/left/right to navigate to a specific square.
- Plus (+) or minus (-) to navigate "left" and "right" on the
board. Note that this will automatically follow the "backwards S"
shape of the board.
- Tab to select your next piece on the board.
To quit the game at any time, press Q (uppercase Q) or hit Esc, and
the game will prompt if you want to forfeit the game.
You win if you move all of your pieces off the board before your
opponent. It takes a combination of luck and strategy!
</body>
</html>추가 변경 없이 이 HTML 문서를 웹 브라우저에서 보면 완전히 잘못된 것처럼 보입니다. 이는 대부분의 마크업 시스템과 마찬가지로 HTML이 입력 파일에서 단어를 수집하고 출력에서 문단을 채우기 때문입니다. 아직 다른 마크업을 추가하지 않았기 때문에 웹 브라우저는 단일 단락에 텍스트를 표시합니다.
(짐 홀, CC BY-SA 4.0)
본문 단락
이 Readme 파일을 HTML로 업데이트하는 첫 번째 단계는 웹 브라우저가 올바르게 표시할 수 있도록 모든 단락을 표시하는 것입니다. 단락을 정의하는 태그는
입니다. 이 파일의 모든 내용이 실제로 단락은 아니지만 모든 내용을
및
태그로 묶어서 시작하세요.<!DOCTYPE html>
<html>
<head>
<title>Title of the document</title>
</head>
<body>
<p>HOW TO PLAY SIMPLE SENET</p>
<p>The game will automatically "throw" the throwing sticks for you, and
display the results in the lower-right corner of the screen.</p>
<p>If the "throw" is zero, then you lose your turn.</p>
<p>When it's your turn, the game will automatically select your first
piece on the board. You may or may not be able to make a move with
this piece, so select your piece to move, and hit Space (or Enter) to
move it. You can select using several different methods:</p>
<p>- Up/down/left/right to navigate to a specific square.</p>
<p>- Plus (+) or minus (-) to navigate "left" and "right" on the
board. Note that this will automatically follow the "backwards S"
shape of the board.</p>
<p>- Tab to select your next piece on the board.</p>
<p>To quit the game at any time, press Q (uppercase Q) or hit Esc, and
the game will prompt if you want to forfeit the game.</p>
<p>You win if you move all of your pieces off the board before your
opponent. It takes a combination of luck and strategy!</p>
</body>
</html>
이렇게 하면 Readme가 읽고 싶은 문서처럼 보이게 됩니다. 웹 브라우저에서 새 문서를 볼 때 모든 단락은 위와 아래에 약간의 추가 공간이 있는 새 줄에서 시작됩니다. 단락은 블록 요소의 가장 일반적인 예입니다.
(짐 홀, CC BY-SA 4.0)
제목 및 부제목
콘텐츠의 첫 번째 줄은 문서의 제목이므로 이를 제목으로 만들어야 합니다. HTML은
부터 까지 6가지 수준의 제목을 제공합니다. 대부분의 문서에서는 을 사용하여 문서 제목을 정의하고 를 주요 하위 섹션에 정의할 수 있습니다. 샘플 Readme 문서에서 이렇게 변경하세요. 문서의 주요 섹션 제목으로 프로그램 이름("Simple Senet")을 사용하고 문서의 하위 섹션으로 "플레이 방법"을 사용합니다.
을 사용하여 문서 제목을 정의하고 를 주요 하위 섹션에 정의할 수 있습니다. 샘플 Readme 문서에서 이렇게 변경하세요. 문서의 주요 섹션 제목으로 프로그램 이름("Simple Senet")을 사용하고 문서의 하위 섹션으로 "플레이 방법"을 사용합니다.
이 예에서는
제목과 동일한 제목을 사용하도록 문서 메타데이터의 도 업데이트했습니다. 이는 브라우저가 문서를 표시하는 방식을 실제로 변경하지는 않지만 다음을 사용하는 것이 좋습니다.<!DOCTYPE html>
<html>
<head>
<title>Simple Senet</title>
</head>
<body>
<h1>Simple Senet</h1>
<h2>How to Play</h2>
...
</body>
</html>
다음 섹션 제목을 추가하면 문서를 더 쉽게 읽을 수 있습니다.
(짐 홀, CC BY-SA 4.0)
순서가 있는 목록과 순서가 없는 목록
문서에는 보드 게임을 탐색하는 다양한 방법의 목록이 포함되어 있습니다. 이 문서는 일반 텍스트 파일로 시작되었기 때문에 목록의 각 항목은 하이픈으로 시작됩니다. 그러나 HTML을 사용하여 이 세 단락을 목록 항목으로 정의할 수 있습니다.
HTML은 순서가 지정된 목록과 순서가 지정되지 않은 목록이라는 두 가지 종류의 목록을 지원합니다. 순서가 지정된 목록
은 일련의 단계를 정의하는 데 사용할 수 있는 번호가 매겨진 시리즈입니다. 순서가 지정되지 않은 목록 은 관련될 수도 있고 관련되지 않을 수도 있지만 일반적으로 순서대로 수행되지 않는 항목의 목록을 정의합니다. 두 목록 모두 목록 내의 항목에 대해 목록 항목 - 을 사용합니다.
단락 대신 정렬된 목록을 사용하도록 추가 정보 문서를 업데이트합니다. 번호가 매겨진 목록에 세 가지 탐색 옵션이 표시됩니다.
<ol>
<li>Up/down/left/right to navigate to a specific square.</li>
<li>Plus (+) or minus (-) to navigate "left" and "right" on the
board. Note that this will automatically follow the "backwards S"
shape of the board.</li>
<li>Tab to select your next piece on the board.</li>
</ol>
번호가 매겨진 목록에 세 가지 옵션이 표시됩니다.
(짐 홀, CC BY-SA 4.0)
그러나 이 세 가지 항목은 실제로 일련의 단계가 아니라 Simple Senet 게임에서 선택 항목을 이동하는 서로 다른 옵션입니다. 따라서 순서가 있는 목록 대신 순서가 없는 목록을 사용하고 싶습니다. 이를 위해서는 문서에서
을 로 업데이트해야 합니다.
<ul>
<li>Up/down/left/right to navigate to a specific square.</li>
<li>Plus (+) or minus (-) to navigate "left" and "right" on the
board. Note that this will automatically follow the "backwards S"
shape of the board.</li>
<li>Tab to select your next piece on the board.</li>
</ul>
순서가 지정되지 않은 목록은 항목이 순서의 일부가 아니기 때문에 각 목록 항목에 글머리 기호를 사용합니다.
(짐 홀, CC BY-SA 4.0)
굵게 및 이탤릭체
굵게 및 기울임꼴 스타일을 적용하여 문서의 특정 정보를 강조표시할 수 있습니다. 이는 기술 문서 작성에서 매우 일반적인 텍스트 스타일입니다. 중요한 정보를 강조하려면 굵은 글씨를 사용하고 핵심 문구와 새로운 용어를 강조하려면 기울임체를 사용할 수 있습니다.
굵은 태그는 원래 로 정의되었지만 최신 버전의 HTML 표준에서는 일련의 지침 중 주요 단계와 같은 강력한 중요성을 나타내기 위해 태그를 선호합니다. 두 태그 모두 유효하지만 의미상 약간 다릅니다. 는 이제 "주의를 끌다"를 의미합니다.
마찬가지로 원래 HTML 표준에서는 기울임꼴 텍스트에 를 사용했습니다. 대신 최신 버전의 HTML에서는 텍스트의 일부를 강조하기 위해 을 선호합니다. 대신 는 이제 관용적인 텍스트나 기술 용어를 식별합니다.
이 예에서는 단일 문자 키 누르기를 식별하려면 굵은 글꼴을 사용하고 Enter 및 Space와 같은 키보드의 특수 키를 나타내려면 기울임꼴을 사용하십시오. 단순화를 위해 여기서는 및 태그를 사용합니다(그러나 대신 및 태그를 사용하면 동일한 효과를 얻을 수 있습니다).
<!DOCTYPE html>
<html>
<head>
<title>Simple Senet</title>
</head>
<body>
<h1>Simple Senet</h1>
<h2>How to Play</h2>
<p>The game will automatically "throw" the throwing sticks for you, and
display the results in the lower-right corner of the screen.</p>
<p>If the "throw" is zero, then you lose your turn.</p>
<p>When it's your turn, the game will automatically select your first
piece on the board. You may or may not be able to make a move with
this piece, so select your piece to move, and hit <i>Space</i> (or <i>Enter</i>) to
move it. You can select using several different methods:</p>
<ul>
<li><i>Up</i>/<i>down</i>/<i>left</i>/<i>right</i> to navigate to a specific square.</li>
<li>Plus (<b>+</b>) or minus (<b>-</b>) to navigate "left" and "right" on the
board. Note that this will automatically follow the "backwards S"
shape of the board.</li>
<li><em>Tab</em> to select your next piece on the board.</li>
</ul>
<p>To quit the game at any time, press <b>Q</b> (uppercase Q) or hit <i>Esc</i>, and
the game will prompt if you want to forfeit the game.</p>
<p>You win if you move all of your pieces off the board before your
opponent. It takes a combination of luck and strategy!</p>
</body>
</html>
이러한 추가 스타일은 특별한 항목이 텍스트에서 눈에 띄게 만드는 데 도움이 됩니다.
(짐 홀, CC BY-SA 4.0)
문서 작성의 핵심은 사용자가 소프트웨어 사용 방법을 이해하는 것이므로 모든 오픈 소스 프로젝트는 읽기 쉬운 방식으로 문서를 작성하도록 노력해야 합니다. 몇 가지 기본 HTML 태그를 사용하면 사용자에게 정보를 보다 명확하게 표시하는 문서를 작성할 수 있습니다.
HTML을 사용하여 문서를 작성하는 방법에 대한 자세한 내용은 Mozilla 웹 프로젝트에서 호스팅하는 Mozilla 개발자 네트워크인 MDN에서 전체 HyperText Markup Language 참조를 확인하세요.
<!DOCTYPE html>
<html>
<head>
<title>Simple Senet</title>
</head>
<body>
<h1>Simple Senet</h1>
<h2>How to Play</h2>
...
</body>
</html>다음 섹션 제목을 추가하면 문서를 더 쉽게 읽을 수 있습니다.
(짐 홀, CC BY-SA 4.0)
순서가 있는 목록과 순서가 없는 목록
문서에는 보드 게임을 탐색하는 다양한 방법의 목록이 포함되어 있습니다. 이 문서는 일반 텍스트 파일로 시작되었기 때문에 목록의 각 항목은 하이픈으로 시작됩니다. 그러나 HTML을 사용하여 이 세 단락을 목록 항목으로 정의할 수 있습니다.
HTML은 순서가 지정된 목록과 순서가 지정되지 않은 목록이라는 두 가지 종류의 목록을 지원합니다. 순서가 지정된 목록
- 은 일련의 단계를 정의하는 데 사용할 수 있는 번호가 매겨진 시리즈입니다. 순서가 지정되지 않은 목록
- 을 사용합니다.
단락 대신 정렬된 목록을 사용하도록 추가 정보 문서를 업데이트합니다. 번호가 매겨진 목록에 세 가지 탐색 옵션이 표시됩니다.
<ol> <li>Up/down/left/right to navigate to a specific square.</li> <li>Plus (+) or minus (-) to navigate "left" and "right" on the board. Note that this will automatically follow the "backwards S" shape of the board.</li> <li>Tab to select your next piece on the board.</li> </ol>번호가 매겨진 목록에 세 가지 옵션이 표시됩니다.
(짐 홀, CC BY-SA 4.0)
그러나 이 세 가지 항목은 실제로 일련의 단계가 아니라 Simple Senet 게임에서 선택 항목을 이동하는 서로 다른 옵션입니다. 따라서 순서가 있는 목록 대신 순서가 없는 목록을 사용하고 싶습니다. 이를 위해서는 문서에서
- 을
- 로 업데이트해야 합니다.
<ul> <li>Up/down/left/right to navigate to a specific square.</li> <li>Plus (+) or minus (-) to navigate "left" and "right" on the board. Note that this will automatically follow the "backwards S" shape of the board.</li> <li>Tab to select your next piece on the board.</li> </ul>순서가 지정되지 않은 목록은 항목이 순서의 일부가 아니기 때문에 각 목록 항목에 글머리 기호를 사용합니다.
(짐 홀, CC BY-SA 4.0)
굵게 및 이탤릭체
굵게 및 기울임꼴 스타일을 적용하여 문서의 특정 정보를 강조표시할 수 있습니다. 이는 기술 문서 작성에서 매우 일반적인 텍스트 스타일입니다. 중요한 정보를 강조하려면 굵은 글씨를 사용하고 핵심 문구와 새로운 용어를 강조하려면 기울임체를 사용할 수 있습니다.
굵은 태그는 원래 로 정의되었지만 최신 버전의 HTML 표준에서는 일련의 지침 중 주요 단계와 같은 강력한 중요성을 나타내기 위해 태그를 선호합니다. 두 태그 모두 유효하지만 의미상 약간 다릅니다. 는 이제 "주의를 끌다"를 의미합니다.
마찬가지로 원래 HTML 표준에서는 기울임꼴 텍스트에 를 사용했습니다. 대신 최신 버전의 HTML에서는 텍스트의 일부를 강조하기 위해 을 선호합니다. 대신 는 이제 관용적인 텍스트나 기술 용어를 식별합니다.
이 예에서는 단일 문자 키 누르기를 식별하려면 굵은 글꼴을 사용하고 Enter 및 Space와 같은 키보드의 특수 키를 나타내려면 기울임꼴을 사용하십시오. 단순화를 위해 여기서는 및 태그를 사용합니다(그러나 대신 및 태그를 사용하면 동일한 효과를 얻을 수 있습니다).
<!DOCTYPE html> <html> <head> <title>Simple Senet</title> </head> <body> <h1>Simple Senet</h1> <h2>How to Play</h2> <p>The game will automatically "throw" the throwing sticks for you, and display the results in the lower-right corner of the screen.</p> <p>If the "throw" is zero, then you lose your turn.</p> <p>When it's your turn, the game will automatically select your first piece on the board. You may or may not be able to make a move with this piece, so select your piece to move, and hit <i>Space</i> (or <i>Enter</i>) to move it. You can select using several different methods:</p> <ul> <li><i>Up</i>/<i>down</i>/<i>left</i>/<i>right</i> to navigate to a specific square.</li> <li>Plus (<b>+</b>) or minus (<b>-</b>) to navigate "left" and "right" on the board. Note that this will automatically follow the "backwards S" shape of the board.</li> <li><em>Tab</em> to select your next piece on the board.</li> </ul> <p>To quit the game at any time, press <b>Q</b> (uppercase Q) or hit <i>Esc</i>, and the game will prompt if you want to forfeit the game.</p> <p>You win if you move all of your pieces off the board before your opponent. It takes a combination of luck and strategy!</p> </body> </html>이러한 추가 스타일은 특별한 항목이 텍스트에서 눈에 띄게 만드는 데 도움이 됩니다.
(짐 홀, CC BY-SA 4.0)
문서 작성의 핵심은 사용자가 소프트웨어 사용 방법을 이해하는 것이므로 모든 오픈 소스 프로젝트는 읽기 쉬운 방식으로 문서를 작성하도록 노력해야 합니다. 몇 가지 기본 HTML 태그를 사용하면 사용자에게 정보를 보다 명확하게 표시하는 문서를 작성할 수 있습니다.
HTML을 사용하여 문서를 작성하는 방법에 대한 자세한 내용은 Mozilla 웹 프로젝트에서 호스팅하는 Mozilla 개발자 네트워크인 MDN에서 전체 HyperText Markup Language 참조를 확인하세요.
- 은 관련될 수도 있고 관련되지 않을 수도 있지만 일반적으로 순서대로 수행되지 않는 항목의 목록을 정의합니다. 두 목록 모두 목록 내의 항목에 대해 목록 항목





