Difference between revisions of "Help:Device Page"

From postmarketOS
Jump to: navigation, search
(Template: Add links to device and kernel packages in template)
(Tags: Mobile edit, Mobile web edit)
(sorry :( Undo revision 12906 by Jaykru (talk))
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== How to add a new device page to the wiki ==
 
== How to add a new device page to the wiki ==
# Paste the content from below into the new wiki page and adjust it for your device (edit all CHANGE_MEs, fill out the blanks etc.)
+
{{Note|To create a new wiki page, enter the name of the new page into the search field, press enter and you will be asked to create the new page.}}
 +
 
 +
# Paste the content from below into the new wiki page, for device-specific pages, we are using the naming convention "Manufacturer Device Name (codename)", so for example "HTC Desire (htc-bravo)"
 +
# Adjust the template for your device (edit all CHANGE_MEs, fill out the blanks etc.)
 
# [[Making_good_photos|Take a good photo of your phone]] and upload it, then put it into the infobox
 
# [[Making_good_photos|Take a good photo of your phone]] and upload it, then put it into the infobox
# Take a look at the [[devices]] page, your device should get listed automatically after creating the device page.
+
# You are done! You can now take a look at the [[devices]] page, your device should appear automatically.
  
 
== Template ==
 
== Template ==
Line 13: Line 16:
  
 
Thank you!
 
Thank you!
 +
 +
{{Note|You can find information about CPU, GPU, Display on websites such as gsmarena.com . You can also enter your device name with the word "specs" into your favorite search engine and you should find the information as well.}}
  
 
<syntaxhighlight lang="moin">
 
<syntaxhighlight lang="moin">
 
{{Infobox device
 
{{Infobox device
 
| manufacturer = <!-- e.g. HTC -->
 
| manufacturer = <!-- e.g. HTC -->
| name = CHANGE_ME <!-- e.g. Desire -->
+
| name = CHANGE_ME <!-- e.g. Desire -->
 
| codename = CHANGE_ME <!-- e.g. htc-bravo -->
 
| codename = CHANGE_ME <!-- e.g. htc-bravo -->
 
| image = File:CHANGE_ME_TO_DEVICE_CODENAME.jpg
 
| image = File:CHANGE_ME_TO_DEVICE_CODENAME.jpg
 
| imagecaption = CHANGE_ME
 
| imagecaption = CHANGE_ME
 
| releaseyear = CHANGE_ME
 
| releaseyear = CHANGE_ME
| originalsoftware = CHANGE_ME <!-- e.g. Android 2 -->
+
| originalsoftware = CHANGE_ME <!-- e.g. Android 2.1 -->
 
| chipset = CHANGE_ME <!-- e.g. Qualcomm QSD8250 Snapdragon S1 -->
 
| chipset = CHANGE_ME <!-- e.g. Qualcomm QSD8250 Snapdragon S1 -->
 
| cpu = CHANGE_ME <!-- e.g. 1.0 GHz Scorpion -->
 
| cpu = CHANGE_ME <!-- e.g. 1.0 GHz Scorpion -->
Line 74: Line 79:
 
{{Device owners}}
 
{{Device owners}}
 
<!-- autogenerated, use {{Owns device|devicepage|notes}} on your profile page -->
 
<!-- autogenerated, use {{Owns device|devicepage|notes}} on your profile page -->
<!-- use _ instead of spaces in device page name, e.g. {{Owns device|Nokia_N900|broken screen}}-->
+
<!-- use _ instead of spaces in device page name, e.g. {{Owns device|HTC_Desire_(htc-bravo)|custom notes}}-->
 
<!-- you may need to purge page cache to see changes (more->purge cache)-->
 
<!-- you may need to purge page cache to see changes (more->purge cache)-->
 
<!-- you can use {{My devices}} on your profile page to show table with all your devices -->
 
<!-- you can use {{My devices}} on your profile page to show table with all your devices -->
Line 81: Line 86:
  
 
== Installation ==
 
== Installation ==
<!-- add more sections below as necessary, e.g. Wifi, photos, ... -->
+
<!-- add more sections below as necessary, e.g. WiFi, photos, ... -->
  
 
== See also ==
 
== See also ==
 
<!--
 
<!--
Link to related gitlab issues or merge requests like the following (replace CHANGEME with the ID, e.g. 1234):
+
Link to related GitLab issues or merge requests like the following (replace CHANGEME with the ID, e.g. 1234):
 
* {{MR|CHANGEME|pmaports}} Initial merge request
 
* {{MR|CHANGEME|pmaports}} Initial merge request
 
* {{issue|CHANGEME|pmaports}} Some related issue
 
* {{issue|CHANGEME|pmaports}} Some related issue
Line 93: Line 98:
 
<!--
 
<!--
 
If you manage to get your device packages merged, uncomment links below and change DEVICE_CODENAME with the actual one.
 
If you manage to get your device packages merged, uncomment links below and change DEVICE_CODENAME with the actual one.
* [https://gitlab.com/postmarketOS/pmaports/tree/master/device/device-DEVICE_CODENAME Device package]
+
* {{Device package|DEVICE_CODENAME}}
* [https://gitlab.com/postmarketOS/pmaports/tree/master/device/linux-DEVICE_CODENAME Kernel package]
+
* {{Kernel package|DEVICE_CODENAME}}
 
-->
 
-->
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 02:38, 29 June 2020

How to add a new device page to the wiki

To create a new wiki page, enter the name of the new page into the search field, press enter and you will be asked to create the new page.
  1. Paste the content from below into the new wiki page, for device-specific pages, we are using the naming convention "Manufacturer Device Name (codename)", so for example "HTC Desire (htc-bravo)"
  2. Adjust the template for your device (edit all CHANGE_MEs, fill out the blanks etc.)
  3. Take a good photo of your phone and upload it, then put it into the infobox
  4. You are done! You can now take a look at the devices page, your device should appear automatically.

Template

Please take the time to fill out this template properly.

With good documentation, more contributors come, and they will be able to build upon your work.

It's really worth it.

Thank you!

You can find information about CPU, GPU, Display on websites such as gsmarena.com . You can also enter your device name with the word "specs" into your favorite search engine and you should find the information as well.
{{Infobox device
| manufacturer = <!-- e.g. HTC -->
| name = CHANGE_ME <!-- e.g. Desire -->
| codename = CHANGE_ME <!-- e.g. htc-bravo -->
| image = File:CHANGE_ME_TO_DEVICE_CODENAME.jpg
| imagecaption = CHANGE_ME
| releaseyear = CHANGE_ME
| originalsoftware = CHANGE_ME <!-- e.g. Android 2.1 -->
| chipset = CHANGE_ME <!-- e.g. Qualcomm QSD8250 Snapdragon S1 -->
| cpu = CHANGE_ME <!-- e.g. 1.0 GHz Scorpion -->
| gpu = CHANGE_ME <!-- e.g. Adreno 200 -->
| storage = CHANGE_ME <!-- e.g. 512 MB -->
| display = CHANGE_ME <!-- e.g. 480x800 AMOLED -->
| memory = CHANGE_ME <!-- e.g. 576 MB -->
| architecture = <!-- One of these: armhf, armv7, aarch64, x86, x86_64 -->
<!-- the following status_* questions should be answered with Y - yes, P - partial, N - no, or left blank (for untested or unknown) -->
| status_usbnet = <!-- USB networking does work? then put Y here and delete this comment -->
| status_flashing = <!-- Flashing with "pmbootstrap flasher" works? Put Y here. It works the same for everything coming below. -->
| status_touch = <!-- Touch screen is working? You can also answer these questions with P for partially. -->
| status_screen = <!-- The display is working? -->
| status_wifi = <!-- Wireless network works? -->
| status_xwayland = <!-- Showing X11 applications in a Wayland compositor (Weston, KWin, ...) works? -->
| status_fde = <!-- When installing with full disk encryption, can you type in the password with the on screen keyboard? -->
| status_mainline = <!-- Instead of a Linux kernel fork, it is possible to run mainline. -->
| status_battery = <!-- Charging the battery with charging-sdl is possible -->
| status_3d = <!-- Hardware accelerated 3D graphics (e.g. with freedreno) -->
| status_accel = <!-- The sensor that measures proper acceleration works -->
| status_audio = <!-- Using the device's speakers/headphone jack works -->
| status_bluetooth = <!-- It's possible to pair and use other devices via the bluetooth protocol -->
| status_camera = <!-- Taking photos and videos works. -->
| status_gps = <!-- The Global Positioning System sensor works.  -->
| status_mobiledata = <!-- Connecting to the Internet via cellular network. -->
| status_sms = <!-- Sending and receiving short messages works as intended. -->
| status_calls = <!-- Talking to other people over the cellular network. -->
| status = <!-- Text displayed in the "not booting" table on the Devices page , e.g "kernel compiles, doesn't boot" -->
| booting = no <!-- The device is booting at all, can be yes/no *IMPORTANT* -->

<!-- you can also use these lines if you need to:
if the device haven't originally ran Android OS, e.g. Nokia N900
| n-android =  ✔
Version of the kernel that pmos is running
| pmoskernel = 3.x.x
see Unixbench page on wiki
| whet_dhry = 0.0
Is OTG available, not used in wiki
| status_otg = -
-->
}}

== Contributors ==
* CHANGE_ME (put your username here!)

== Maintainer(s) ==
<!-- Only if this device doesn't run on linux-postmarketos yet! -->
<!-- This person needs to be willing to answer questions from users of this device -->

== Users owning this device ==
{{Device owners}}
<!-- autogenerated, use {{Owns device|devicepage|notes}} on your profile page -->
<!-- use _ instead of spaces in device page name, e.g. {{Owns device|HTC_Desire_(htc-bravo)|custom notes}}-->
<!-- you may need to purge page cache to see changes (more->purge cache)-->
<!-- you can use {{My devices}} on your profile page to show table with all your devices -->

== How to enter flash mode ==

== Installation ==
<!-- add more sections below as necessary, e.g. WiFi, photos, ... -->

== See also ==
<!--
Link to related GitLab issues or merge requests like the following (replace CHANGEME with the ID, e.g. 1234):
* {{MR|CHANGEME|pmaports}} Initial merge request
* {{issue|CHANGEME|pmaports}} Some related issue
You can also add normal web links:
* [https://redmine.replicant.us/projects/replicant/wiki/GalaxyS2I9100 Replicant wiki page]
-->
<!--
If you manage to get your device packages merged, uncomment links below and change DEVICE_CODENAME with the actual one.
* {{Device package|DEVICE_CODENAME}}
* {{Kernel package|DEVICE_CODENAME}}
-->


Almost done! Don't forget the photo and looking at the automatically generated devices page.