Skip to content

Commit 5b11d32

Browse files
lavalserobocoop-shioguchiMidori-UrashimaKazumiHanaokaMightyEliyah
authored
feat: update getting started (#44)
* fix typo * init branch * add components * fix image * init * update overview for user-manua; * update translation * update translation * finish create your first project section * fix broken link * fix user manual * updating understand UI * add the old docs * add to Ja * Update browser-setup.md change title * add ja browser-setup * add ja article * タイトル変更 (#47) 変更しました * 20221216_更新しました_浦島翠 (#53) 20221216_更新しました_浦島翠 * 20221216_更新しました_浦島翠 (#54) 20221216_更新しました_浦島翠 * 20221217_更新しました_浦島翠 (#55) 20221217_更新しました_浦島翠 * 20221217_更新しました_浦島翠 (#56) 20221217_更新しました_浦島翠 * 更新 (#57) 20221218_更新_花岡 * 更新 (#58) 20221218_更新_花岡 * 更新 (#59) 20221218_更新_花岡 * Update overview.mdx * Update color-theme-switch.mdx * fix error * translate overview * Update _category_.json update folder name * 更新 (#60) * 更新 20221220_更新_花岡 * Update adding-layers.mdx fix typo Co-authored-by: XU Cong <[email protected]> * 更新 (#61) * 更新 20221220_更新_花岡 * Update publilshing-project.mdx fix typo Co-authored-by: XU Cong <[email protected]> * 更新 (#62) * 更新 20221221_更新_花岡 * Update header.mdx fix typo Co-authored-by: XU Cong <[email protected]> * 20221222_EnglishChecked_Eliyah (#63) 20221222_EnglishChecked_Eliyah * Update overview.mdx (#64) * 20221222_EnglishChecked_Mido (#65) 20221222_EnglishChecked_Mido * 20221222_更新しました_浦島翠 (#66) 20221222_更新しました_浦島翠 * 20221222_更新しました_浦島翠 (#67) 20221222_更新しました_浦島翠 * 20221222_更新しました_浦島翠 (#68) * 20221222_更新しました_浦島翠 20221222_更新しました_浦島翠 * Update Dashboard.mdx no need to change the header part Co-authored-by: XU Cong <[email protected]> * 20221222_EnglishChecked_Mido (#69) 20221222_EnglishChecked_Mido * 20221222_EnglishChecked_Mido (#70) 20221222_EnglishChecked_Mido * 20221224_更新しました_浦島翠 (#71) * 20221224_更新しました_浦島翠 20221224_更新しました_浦島翠 * Update overview.mdx Co-authored-by: XU Cong <[email protected]> * 20221226_EnglishChecked_Eliyah (#74) * 20221226_EnglishChecked_Eliyah Eliyah has corrected this write-up on 20221226 * Update color-theme-switch.mdx fix error * Update color-theme-switch.mdx Co-authored-by: XU Cong <[email protected]> * 20221226_EnglishChecked_Eliyah (#75) Correction completed. 20221226_EnglishChecked_Eliyah * 20221226_EnglishChecked_Eliyah (#76) Correction Completed. 20221226 * 20221222_EnglishChecked_Mido (#77) 20221222_EnglishChecked_Mido * 20221222_EnglishChecked_Mido (#80) 20221222_EnglishChecked_Mido * 20221222_EnglishChecked_Mido (#81) 20221222_EnglishChecked_Mido * 20221231_EnglishChecked_Eliyah (#84) * 20221231_EnglishChecked_Eliyah Correction completed * Update editor.mdx fix again * Update editor.mdx Co-authored-by: XU Cong <[email protected]> * 20221229_EnglishChecked_Eliyah (#83) * 20221229_EnglishChecked_Eliyah Eliyah made corrections. 20221229 * Update header.mdx Co-authored-by: XU Cong <[email protected]> * 20221229_EnglishChecked_Eliyah (#82) * 20221229_EnglishChecked_Eliyah Corrections done by Eliyah. 20221226 * Update publilshing-project.mdx Co-authored-by: XU Cong <[email protected]> * 20221222_EnglishChecked_Mido (#78) * 20221222_EnglishChecked_Mido 20221222_EnglishChecked_Mido * Update overview.mdx Co-authored-by: XU Cong <[email protected]> * 20221224_更新しました_浦島翠 (#73) * 20221224_更新しました_浦島翠 20221224_更新しました_浦島翠 * Update interacting-with-viewer.mdx Co-authored-by: XU Cong <[email protected]> * fix translation * fix error * fix typo * fix link * fix error * fix link * fix link * 20230118_更新しました_浦島翠 (#85) 20230118_更新しました_浦島翠 * 20230118_更新しました_浦島翠 (#86) 20230118_更新しました_浦島翠 * 20230118_更新しました_浦島翠 (#87) 20230118_更新しました_浦島翠 * 2023_01_18 修正 (#88) 修正 花岡 * 23_01_18_修正_花岡 (#89) 修正 * 23_01_18 仮修正_花岡 (#90) 23_01_18 花岡 * 20230118_更新しました_浦島翠 (#91) 20230118_更新しました_浦島翠 * 23_01_18 再修正 (#92) 再修正 花岡 * 20230120_修正しました_浦島翠 (#93) 20230120_修正しました_浦島翠 * 2023_修正しました_ (#94) * 20230121_修正しました_花岡(浦島) (#95) 20230121_修正しました_ * 20230121_修正しました_花岡(浦島) (#96) 20230121_修正しました * 20230121_修正しました_花岡(浦島) (#97) 20230121_修正しました * 20230121_修正しました_花岡(浦島) (#98) 20230121_修正しました * Update adding-layers.mdx fix type * Update overview.mdx * Update creating-a-infobox-for-layer.mdx * 20230124_修正しました_浦島 (#99) 20230124_修正しました_浦島 * 2024125_塩口( * Update Dashboard.mdx * タイトルの更新 タイトルを適切な日本語に変更 * 項目名更新 対応した項目名に変更 * 項目名更新 対応した項目名に変更 * 項目名更新 対応した項目名に変更 * 項目名更新 対応した項目名に変更 * マークダウン対応 マークダウン対応 * 文章追加 文章的に、次の説明は「ダッシュボード」かな?と勘違いしてしまうため、12行目を追加し勘違いを回避 Co-authored-by: robocoop-shioguchi <[email protected]> Co-authored-by: Midori-Urashima <[email protected]> Co-authored-by: KazumiHanaoka <[email protected]> Co-authored-by: Eliyah Eziwhuo <[email protected]> Co-authored-by: Mido-m-93 <[email protected]>
1 parent 0203f4a commit 5b11d32

File tree

145 files changed

+1677
-64
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

145 files changed

+1677
-64
lines changed

docusaurus.config.js

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,8 @@ const lightCodeTheme = require("prism-react-renderer/themes/github");
8989
},
9090
items: [
9191
{
92-
to: "https://docs2.reearth.io/getting-started",
93-
label: "Getting started",
94-
position: "left",
95-
activeBaseRegex: `/userManual/`,
96-
},
97-
{
98-
to: "/user-manual/reference",
99-
label: "Reference",
92+
to: "/user-manual/overview",
93+
label: "User Manual",
10094
position: "left",
10195
activeBaseRegex: `/userManual/`,
10296
},
@@ -140,12 +134,8 @@ const lightCodeTheme = require("prism-react-renderer/themes/github");
140134
title: "Docs",
141135
items: [
142136
{
143-
label: "Getting started",
144-
to: "https://docs2.reearth.io/getting-started",
145-
},
146-
{
147-
label: "Reference",
148-
to: "/user-manual/reference",
137+
label: "User Manual",
138+
to: "/user-manual/overview",
149139
},
150140
{
151141
label: "Developer guide",

i18n/ja/code.json

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,5 +324,144 @@
324324
"theme.blog.post.readMoreLabel": {
325325
"message": "Read more about {title}",
326326
"description": "The ARIA label for the link to full blog posts from excerpts"
327+
},
328+
"User Manual": {
329+
"message": "ユーザーマニュアル",
330+
"description": "Top page/ Card / Title"
331+
},
332+
"The user manual will dive deeper into the core functionality and teach you how to get the most out of Re:Earth.": {
333+
"message": "ユーザーマニュアルでは、Re:Earthのコアとなる機能を深く掘り下げ、最大限に活用する方法をお伝えします。",
334+
"description": "Top page / Card / Description"
335+
},
336+
"theme.SearchBar.seeAll": {
337+
"message": "See all {count} results"
338+
},
339+
"theme.SearchPage.documentsFound.plurals": {
340+
"message": "{count}件のドキュメントが見つかりました",
341+
"description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
342+
},
343+
"theme.SearchPage.existingResultsTitle": {
344+
"message": "『{query}』の検索結果",
345+
"description": "The search page title for non-empty query"
346+
},
347+
"theme.SearchPage.emptyResultsTitle": {
348+
"message": "ドキュメントを検索",
349+
"description": "The search page title for empty query"
350+
},
351+
"theme.SearchPage.inputPlaceholder": {
352+
"message": "ここに検索するキーワードを入力してください",
353+
"description": "The placeholder for search page input"
354+
},
355+
"theme.SearchPage.inputLabel": {
356+
"message": "検索",
357+
"description": "The ARIA label for search page input"
358+
},
359+
"theme.SearchPage.algoliaLabel": {
360+
"message": "Algoliaで検索",
361+
"description": "The ARIA label for Algolia mention"
362+
},
363+
"theme.SearchPage.noResultsText": {
364+
"message": "検索結果が見つかりませんでした",
365+
"description": "The paragraph for empty search result"
366+
},
367+
"theme.SearchPage.fetchingNewResults": {
368+
"message": "新しい検索結果を取得しています...",
369+
"description": "The paragraph for fetching new search results"
370+
},
371+
"theme.SearchBar.label": {
372+
"message": "検索",
373+
"description": "The ARIA label and placeholder for search button"
374+
},
375+
"theme.SearchModal.searchBox.resetButtonTitle": {
376+
"message": "Clear the query",
377+
"description": "The label and ARIA label for search box reset button"
378+
},
379+
"theme.SearchModal.searchBox.cancelButtonText": {
380+
"message": "Cancel",
381+
"description": "The label and ARIA label for search box cancel button"
382+
},
383+
"theme.SearchModal.startScreen.recentSearchesTitle": {
384+
"message": "Recent",
385+
"description": "The title for recent searches"
386+
},
387+
"theme.SearchModal.startScreen.noRecentSearchesText": {
388+
"message": "No recent searches",
389+
"description": "The text when no recent searches"
390+
},
391+
"theme.SearchModal.startScreen.saveRecentSearchButtonTitle": {
392+
"message": "Save this search",
393+
"description": "The label for save recent search button"
394+
},
395+
"theme.SearchModal.startScreen.removeRecentSearchButtonTitle": {
396+
"message": "Remove this search from history",
397+
"description": "The label for remove recent search button"
398+
},
399+
"theme.SearchModal.startScreen.favoriteSearchesTitle": {
400+
"message": "Favorite",
401+
"description": "The title for favorite searches"
402+
},
403+
"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": {
404+
"message": "Remove this search from favorites",
405+
"description": "The label for remove favorite search button"
406+
},
407+
"theme.SearchModal.errorScreen.titleText": {
408+
"message": "Unable to fetch results",
409+
"description": "The title for error screen of search modal"
410+
},
411+
"theme.SearchModal.errorScreen.helpText": {
412+
"message": "You might want to check your network connection.",
413+
"description": "The help text for error screen of search modal"
414+
},
415+
"theme.SearchModal.footer.selectText": {
416+
"message": "to select",
417+
"description": "The explanatory text of the action for the enter key"
418+
},
419+
"theme.SearchModal.footer.selectKeyAriaLabel": {
420+
"message": "Enter key",
421+
"description": "The ARIA label for the Enter key button that makes the selection"
422+
},
423+
"theme.SearchModal.footer.navigateText": {
424+
"message": "to navigate",
425+
"description": "The explanatory text of the action for the Arrow up and Arrow down key"
426+
},
427+
"theme.SearchModal.footer.navigateUpKeyAriaLabel": {
428+
"message": "Arrow up",
429+
"description": "The ARIA label for the Arrow up key button that makes the navigation"
430+
},
431+
"theme.SearchModal.footer.navigateDownKeyAriaLabel": {
432+
"message": "Arrow down",
433+
"description": "The ARIA label for the Arrow down key button that makes the navigation"
434+
},
435+
"theme.SearchModal.footer.closeText": {
436+
"message": "to close",
437+
"description": "The explanatory text of the action for Escape key"
438+
},
439+
"theme.SearchModal.footer.closeKeyAriaLabel": {
440+
"message": "Escape key",
441+
"description": "The ARIA label for the Escape key button that close the modal"
442+
},
443+
"theme.SearchModal.footer.searchByText": {
444+
"message": "Search by",
445+
"description": "The text explain that the search is making by Algolia"
446+
},
447+
"theme.SearchModal.noResultsScreen.noResultsText": {
448+
"message": "No results for",
449+
"description": "The text explains that there are no results for the following search"
450+
},
451+
"theme.SearchModal.noResultsScreen.suggestedQueryText": {
452+
"message": "Try searching for",
453+
"description": "The text for the suggested query when no results are found for the following search"
454+
},
455+
"theme.SearchModal.noResultsScreen.reportMissingResultsText": {
456+
"message": "Believe this query should return results?",
457+
"description": "The text for the question where the user thinks there are missing results"
458+
},
459+
"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": {
460+
"message": "Let us know.",
461+
"description": "The text for the link to report missing results"
462+
},
463+
"theme.SearchModal.placeholder": {
464+
"message": "Search docs",
465+
"description": "The placeholder of the input of the DocSearch pop-up modal"
327466
}
328467
}

i18n/ja/docusaurus-plugin-content-docs-user-manual/current.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,21 @@
4646
"sidebar.mySidebar.category.3D data": {
4747
"message": "3D データ",
4848
"description": "The label for category 3D data in sidebar mySidebar"
49+
},
50+
"sidebar.mySidebar.category.Getting Started": {
51+
"message": "はじめかた",
52+
"description": "The label for category Getting Started in sidebar mySidebar"
53+
},
54+
"sidebar.mySidebar.category.Environment setting": {
55+
"message": "環境設定",
56+
"description": "The label for category Environment setting in sidebar mySidebar"
57+
},
58+
"sidebar.mySidebar.category.Making your first project": {
59+
"message": "最初のプロジェクトの作成",
60+
"description": "The label for category Making your first project in sidebar mySidebar"
61+
},
62+
"sidebar.mySidebar.category.Understanding Re:Earth UI": {
63+
"message": "Re:EarthのUIを理解する",
64+
"description": "The label for category Understanding Re:Earth UI in sidebar mySidebar"
4965
}
5066
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "はじめかた",
3+
"position": 2
4+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "環境設定",
3+
"position": 1
4+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Re:Earthの動作環境について
3+
sidebar_position: 1
4+
---
5+
6+
Re:EarthはWebブラウザ上で動作するアプリケーションです。
7+
8+
Webブラウザが動作する全てのデスクトップOS(Windows, macOS, Linux, Chrome OS)やモバイルOS(iOS、Andorid)に対応しています。
9+
## インターネット接続について
10+
11+
Re:Earthの動作には、インターネット接続を必要とします。また、現在はオフライン作業に対応していません。
12+
13+
利用中にインターネット接続が切断された場合、変更内容が正常に保存されないことがあります。
14+
15+
## 対応Webブラウザについて
16+
17+
- Chrome 58+
18+
- Firefox 57+
19+
- Safari 11+ (macOSのみ)
20+
- Microsoft Edge XX 以降
21+
- iOS(11+) Safari
22+
- Android(10+) Chrome
23+
24+
快適な動作とセキュリティを維持するため、Webブラウザのアップデートは定期的に行い、最新バージョンをご利用ください。
25+
26+
Internet Explorer には対応していません。全てのバージョンで動作しません。
27+
28+
## 対応OSについて
29+
30+
- Windows 10
31+
- Apple macOS 10.12 (macOS Sierra)+
32+
- 上記デスクトップWebブラウザが動作するLinux
33+
- ChromeOS
34+
- iOS 11+
35+
- Android 10+
36+
37+
Re:Earthは、主にWindows及びmacOSで動作確認を行なっています。
38+
39+
快適な動作とセキュリティを維持するため、OSのアップデートは定期的に行い、最新バージョンをご利用ください。
40+
## 対応ディスプレイモニタについて
41+
42+
Re:Earthでの効率的な編集作業には、解像度が1000x700ピクセル以上のモニタが必要です。
43+
44+
この解像度をサポートするモニタであれば、デスクトップPC、ラップトップPC、及びiPadなどのタブレット端末でも、問題なく利用することができます。
45+
46+
Re:Earthで作成・公開されたプロジェクトは、iPhoneなどのスマートフォン表示に対応しています。ただし、Re:Earthの編集画面は、スマートフォン表示に対応していません。
47+
48+
## グラフィックカードについて
49+
50+
Re:Earthでは、地球儀の表示等にWebGLを利用しています。
51+
52+
そのため、Re:Earthの動作には、WebGLをサポートするグラフィックカード及びグラフィックチップが必要です。近年のPCやタブレット端末で利用されているCPUやモバイル端末の多くはグラフィックチップを内蔵しており、多くの場合、問題なくRe:Earthが動作します。
53+
54+
デスクトップPCでより快適に作業を行いたい場合には、近年発売されたNvidia GeForceシリーズや、AMD Radeonシリーズなどのグラフィックカードを導入していただくことをお勧めします。
55+
56+
快適な動作のため、グラフィックカードやグラフィックチップのドライバアップデートは定期的に行い、最新バージョンをご利用ください。
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: カラーテーマの変更
3+
sidebar_position: 3
4+
---
5+
6+
Re:Earthシステムでは、**Light theme****Dark theme**という2つのUIカラーテーマを提供しており、用途に応じていつでも切り替えることができます。
7+
8+
UIカラーテーマの切り替え機能は、アカウント設定画面でも利用可能です。
9+
- ダッシュボードのヘッダー→アカウント設定
10+
11+
<Image path={require('./img/2-1.png').default} />
12+
<Image path={require('./img/2-2.png').default} />
13+
14+
import Image from "/src/components/Image/Image";
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: 言語切り替え
3+
sidebar_position: 2
4+
---
5+
6+
Re:Earthは現在、少なくとも英語と日本語の2ヶ国語をサポートしています。また、開発チームにも様々な言語背景を持つメンバーが増えており、将来的にはより多くの言語に対応する予定です。
7+
8+
言語機能の切り替えは、アカウントの設定ページで確認できます。
9+
- ダッシュボードのヘッダー→アカウント設定
10+
11+
<Image path={require('./img/1-1.png').default} />
12+
<Image path={require('./img/1-2.png').default} />
13+
14+
import Image from "/src/components/Image/Image";
15+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "最初のプロジェクトの作成",
3+
"position": 2
4+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: レイヤーを追加
3+
sidebar_position: 5
4+
---
5+
6+
Re:Earthでは、地図に素材を追加することができます。デジタルアース上に表示できる全てのアイテム ( [マーカー](/user-manual/property/overview#marker-properties-1), [3Dモデル](/user-manual/three-d-data/3d-model), [フォトオーバレイ](/user-manual/property/overview#photo-overlay-properties)など) はすべてレイヤーとして管理されています。
7+
8+
ここでは例として、地図にレイヤーとして目印を追加してみます。
9+
10+
## マーカーレイヤーの追加
11+
12+
<Image path={require('./img/4-1.png').default} />
13+
14+
<Image path={require('./img/4-2.png').default} />
15+
16+
<Order>
17+
<ListByNumber>
18+
<a target="_self" href="/user-manual/getting-started/understanding-reearth-ui/editor#tool-bar">ツールバー</a>から「マーカー」ボタンをクリックします。
19+
</ListByNumber>
20+
<ListByNumber>
21+
マーカーアイコンを地図上の配置したい場所にドラッグする
22+
</ListByNumber>
23+
<ListByNumber>
24+
<a target="_self" herf="/user-manual/getting-started/understanding-reearth-ui/editor#outline">アウトライン</a>レイヤーリストに、マーカーという新しいレイヤーが作成されます。
25+
</ListByNumber>
26+
</Order>
27+
28+
## レイヤーのプロパティを変更する
29+
30+
レイヤーを選択することで、そのレイヤーの様々なプロパティを変更し、以下の例のように状態や形状を変化させることができます。
31+
32+
### ポジション変更
33+
34+
<Image path={require('./img/4-3.gif').default} />
35+
36+
レイヤーを1秒以上長押しすると、地図上の位置を移動させることができます。
37+
38+
### 外観の変更
39+
40+
<Image path={require('./img/4-4.gif').default} />
41+
42+
このマーカーレイヤのスタイル、サイズ、色などを変更することができます。
43+
44+
### ラベルの追加
45+
46+
<Image path={require('./img/4-5.gif').default} />
47+
48+
また、マーカーレイヤにラベルを追加し、フォントの種類を調整することなども可能です。
49+
50+
マーカレイヤーについては、カスタマイズ可能な多くのアイテムを用意していますので、[こちら](/user-manual/property/overview#marker-properties) をご覧ください。レイヤーの種類によって、それぞれ異なるパラメータや機能があり、 [こちら](/user-manual/property/overview)よりご確認頂けます。
51+
52+
他のレイヤーの設定を変更することで、異なる効果が得られます。
53+
54+
import Image from "/src/components/Image/Image";
55+
import ListByNumber from "/src/components/List/ListByNumber";
56+
import Order from "/src/components/List/Order";
57+
58+
59+
60+
61+
62+

0 commit comments

Comments
 (0)