문서 출처

문서 소스에는 일반 텍스트 파일, 사람 페이지 및 HTML. 그러나 대부분의 새로운Postgres문서는를 사용하여 작성됩니다.표준 일반 마크 업 언어(토토 캔)docbook 문서 유형 정의(dtd). 기존 문서의 대부분은있었습니다 또는로 변환됩니다.토토 캔.

목적토토 캔허용하는 것입니다 문서의 구조 및 내용을 지정하려면 저자 (예 : 사용 사용docbook dtd), 문서 스타일이 방법을 정의하도록합니다 해당 콘텐츠는 최종 형식으로 렌더링됩니다 (예 : Norm Walsh의 사용 스타일 시트).

문서는 여러 출처에서 축적되었습니다. 우리처럼 기존 문서를 일관된 상태로 통합하고 동화시킵니다 문서 세트, 이전 버전은 쓸모없고 분포에서 제거됩니다. 그러나 이것은 일어나지 않을 것입니다 즉시, 동시에 모든 문서에 발생하지는 않습니다. 전환을 완화하고 개발자와 작가를 안내하기 위해 우리는 전환 로드맵을 정의했습니다.

v6.5에 대한 문서 계획이 있습니다 :

• 사용자의 색인 정보 컴파일 시작 관리자 가이드.

• 사용자 가이드 커버 영역에 대한 더 많은 섹션을 작성하십시오 참조 페이지 외부. 여기에는 입문이 포함됩니다 전형적인 디자인에 대한 접근법에 대한 정보 및 제안 문제.

• 기존 사람 페이지의 정보를 참조 페이지 및 사용자 안내서. 남자 페이지를 압축하십시오 기본 문서에 대한 참조와 함께 정보를 상기시키기 위해 세트.

• 새 토토 캔 참조 페이지를 New Man Pages로 변환합니다. 기존 사람 페이지 교체.

• 모든 소스 그래픽을 CGM 형식 파일로 변환합니다 이식성. 현재 우리는 주로 Applix 그래픽 소스를 가지고 있습니다 .gif 출력을 생성 할 수 있습니다. 하나의 그래픽은 전용입니다 .gif 및 .ps로 제공되며 다시 작성되거나 제거됨.

문서 구조

현재 Docbook에 작성된 5 개의 별도 문서가 있습니다. 각 문서에는 문서 환경 및 기타 문서 소스 파일. 이 기본 소스 파일이에 있습니다.doc/src/토토 캔/, 다른 많은 소스와 함께 문서에 사용되는 파일. 기본 소스 파일은 다음과 같습니다.

postgres.토토 캔

이것은 다른 모든 것을 포함하여 통합 된 문서입니다 부분으로 문서. 출력은에서 생성됩니다.html브라우저 인터페이스를 사용하면 쉽게 만들어집니다 클릭하면 모든 문서를 이동합니다. 그만큼 기타 문서는 둘 다 가능합니다.html및 하드 코피.

Tutorial.토토 캔

입문 자습서, 예제. 포함하지 않습니다 프로그래밍 주제, 독자가 익숙하지 않도록 돕기위한 것입니다. 와 함께SQL. 이것은 "얻는 것입니다 시작 "문서.

user.토토 캔

사용자 안내서. 데이터 유형에 대한 정보가 포함되어 있습니다 사용자 수준 인터페이스. 이곳은 정보를 입을 수있는 곳입니다 "왜".

Reference.토토 캔

참조 설명서. 포함Postgres SQL구문. 이곳은 "방법"에 대한 정보를 넣을 곳입니다.

프로그래밍 .토토 캔

프로그래머 안내서. 정보 포함Postgres확장 성 및 인터페이스 프로그래밍.

admin.토토 캔

관리자 안내서. 설치 및 릴리스를 포함합니다 노트.

문서 파일

문서 변환

스타일 및 컨벤션

docbook풍부한 태그 세트가 있습니다 그리고 구성물, 그리고 놀랍게도 많은 비율은 직접적으로 잘 형성된 문서에 분명히 유용합니다. 그만큼Postgres문서 세트는 최근에만 있습니다 에 적응되었습니다.토토 캔그리고 가까운 곳 미래 세트의 여러 섹션이 선택되고 유지됩니다. 프로토 타입의 예로docbook사용법. 또한, 짧은 요약docbook태그가 포함됩니다 아래에.

토토 캔 저자 도구

현재Postgres문서 세트는 일반 텍스트 편집기 (또는 EMACS/P토토 캔; SEE를 사용하여 작성되었습니다. 아래) 컨텐츠를 사용하여토토 캔Docbook 태그.

토토 캔anddocbook공급 과잉으로 고통받지 마십시오 오픈 소스 저작 도구. 가장 일반적인 도구 세트는입니다 P토토 캔 기능 확장자가 장착 된 EMACS/XEMACS 편집 패키지. ~에 일부 시스템 (예 : Redhat Linux)이 도구는 일반적인 전체 설치.

EMACS/P토토 캔

emacs(및xemacs)토토 캔 주요 모드. 언제 올바르게 구성하면 사용할 수 있습니다emacs태그를 삽입하고 마크 업을 확인합니다 일관성.

다음을 귀하의~/.emacs환경 파일 :

; ********** 토토 캔 모드 (P토토 캔)

(setq sgml-catalog-files "/usr/lib/sgml/catalog")
(setq sgml-local-catalogs "/usr/lib/sgml/catalog")

(Autoload '토토 캔-Mode "P토토 캔" "토토 캔 파일을 편집하려는 주요 모드."T).

동일한 파일에 항목을 추가하십시오토토 캔(기존) 정의로 자동 모드 알리스트 :

(setq
  자동 모드 알리스트
  '(( "\\. 토토 캔 $". 토토 캔-mode)
   ))

각토토 캔소스 파일이 있습니다 파일 끝에서 다음 블록 :

!- 파일 끝에이 주석을 유지하십시오.
로컬 변수 :
모드 : 토토 캔
sgml-omittag : t
sgml-shorttag : t
토토 캔- 미니 화-부품 : NIL
토토 캔-Always-Quote-Attributes : t
토토 캔-INDENT- 단계 : 1
토토 캔-INDENT-DATA : T.
토토 캔-Parent-Document : NIL
sgml-default-dtd-file : "./ reference.ced"
토토 캔 노출 태그 : NIL
토토 캔-local-catalogs : "/usr/lib/sgml/catalog"
sgml-local-ecat-files : nil
끝:
-

thePostgres분포 구문 분석 DTD 정의 파일 포함Reference.ced. 당신은 그것을 찾을 수 있습니다

사용시emacs/psgml, a 이 별도의 책 부품 파일로 편안한 작업 방법 편집하는 동안 적절한 DocType 선언을 삽입하는 것입니다. 그들을. 예를 들어이 소스에서 작업하는 경우 부록 장, 따라서 문서를 첫 번째 줄을 만들어 문서 문서의 "부록"인스턴스 이렇게 보인다 :

! DocType 부록 공개 "-// Davenport // dtd Docbook v3.0 // en"

이것은 읽는 모든 것과 모든 것을 의미합니다토토 캔올바르게 얻을 수 있습니다 "n토토 캔s -s docguide.토토 캔"로 문서를 확인하십시오.