2013-03-31 2 views
2

나는 web-help used by the Play Framework의 거대한 팬이다.Play Framework에 대한 도움이 어떻게 구현됩니까?

가 가 가
    가 이
  • 가 (1.0 문서는만큼 좋은 2.1.0로를 같은 장소에서 모든 버전에 대한 모든 문서는 동일한 스타일을 가지고 (다시 1.0로 모든 방법)
  • 을 문서를 얻을 아주 쉽게 찾아 여기 왜 : 문서)
  • 쉬운 URL을 읽을 수있는 (NO iframe이 많은 다른 웹 도움말 시스템을 사용하는 것 넌센스)

나는 현재 내 응용 프로그램의 문서에 대한 좋은 오래된 .chm을 사용하고 있습니다. 나는 웹 사이트 변환기에 .chm을 구축하는 과정에서 문서를 온라인 상태로 만들 수 있습니다. 내가 너무 멀리 들어가기 전에

는 사람이 플레이 프레임 워크 웹 도움말 시스템을 구현하는 방법을 알고 있나요? 어딘가에서 소스를 다운로드 할 수 있습니까? 나는 내 자신의 응용 프로그램에 대한 유사한 어쨌든 구현 뭔가를 재생의 문서 시스템의 세부 사항을 모르는 here are the help sources

나는 그들이 인하를 사용하여 생각

답변

2

과정은 매우 간단합니다. 그들의 문서는 Git의 소스 코드 근처에 있으므로 Git (태그, 병합/충돌)의 이점을 누릴 수 있습니다.

는 그것은 그래서 간단한 텍스트 편집기로 작성하는 쉬운 마크 다운으로 기록됩니다. 그런 다음 Pegdown library을 사용하여 HTML 파일로 변환됩니다. 이 과정의 예를 들어

,이 프로젝트에서 좀 걸릴 수 있습니다 : 그것은 파일을 HTML하는 Github에서의 REPO에서 Markdown을 비행 파일을 변환 https://github.com/ndeverge/play2-docs-renderer

합니다. 현재 결과를 볼 수있는 링크에 대한 http://play2-docs-snapshot.herokuapp.com/

+0

나는 특히 문서의 여러 버전 유지에 관심이 있어요 - 불필요하게 비용 등, 2.0 1.0, 1.2, 1.3 Pegdown을 통해 가격 인하를 실행하여 문서의 모든 페이지를 봉사 것 같다,하지만 난 어쩌면 웹 dev에와 아주 새로운 해요 실제로 큰 문제는 아닙니다. (나는 최첨단 버전, 훌륭한 아이디어를보고 play2-docs-renderer를 좋아합니다). playframework.org 사이트의 문서가 모든 페이지보기의 양식 마크 다운에 게재되는지 여부를 알고 계십니까? AWS에서 정적으로 호스팅 된 것을 만들 계획 이었지만 역동적 인 무언가가 괜찮을 수도 있습니다. –

+0

AFAIK, Play 팀에서 게재시 정적 문서를 한 번 생성하지만 어떻게 처리하는지는 잘 모릅니다. HTML 파일을 만들기 위해 Pegdown을 사용하고 AWS (또는 정적 인 경우 S3)에 호스트하는 것은 복잡하지 않아야합니다. –

2

에서, StackOverflow의 사용, 이것과 같은 "편집기"로 약 2 시간이 걸렸다 (자바 스크립트).

당신은 편집기로 예를 들어 markdownj Java 용 LIB 및 Pagedown에 사용할 수 있습니다.

+0

감사합니다, 그들은 매우 도움이됩니다! –