OpenWrt Forum Archive

Topic: Improve the Wiki Table of Hardware?

The content of this topic has been archived between 12 Sep 2015 and 6 May 2018. Unfortunately there are posts – most likely complete pages – missing.

zo0ok wrote:

Now it is (I think) exactly as in the template. If you are happy I am happy. Let me know if/when you want other changes.

Almost happy smile

1) Can you implement the columns "Detachable Antennas", Serial, JTAG in both, your list and the datapages?
2) Set "Device Techdata Page_pageid : Techdata" for all devices
(Background: "Techdata" is the name of the link to the dataentry page; we can name this as we like)
3) factory-img_factory + sysupgrade-img_sysupgrade: replace '_factory' + '_sysupgrade' by simple '_url'
The method with '_factory' + '_sysupgrade' has performance issues. We need to shorten the URLs via CSS.

@drawz: good to see that someone else is following this topic. Sometimes it makes me worried we are three people in a bubble wink

I totally agree. Would be good to have more eyes looking at what we are doing here.

a) Thank you for the Antennass correction... it would have kept me sleepless otherwise.
b) I will implement Detachable Antennas, Serial, JTAG.
c) The Techdata thing is of course trivial.
d) The factory/sysupgrade... I think I will get it right wink

Well, the Supported/Current Supported Rel was actually better than I thought. But...
If it says RXXXX, do you want me to automatically add the correct Release? In that case I need to know the threshold values.

One more thing:

''Device Page_page            : .:iomega:iconnect''

-> toh is missing, i.e. ''toh:brand:model''

(Last edited by tmo26 on 11 Jun 2015, 22:27)

tmo26 wrote:

1) .toh:hwdata:brand:model <--- new namespace "hwdata" in the wiki root

I'd go for 1), in order to keep the namespace hierarchie flat.

Good with me.
I will keep the form

.toh:hwdata:brand:brand_model

Ok?

(Last edited by zo0ok on 11 Jun 2015, 22:29)

RXXXXX: Leave it this way. If we change this by automatism, we're making more wrong than right IMHO.
There's a reason why there still are RXXXXX's in the toh: Some devices have a revision in the toh, but you can not find an image in the following release.

We can clean this up when adding the urls for factory/sysupgrade.

Your reply was too fast, I edited my posting heavily smile

Wired Ports dont need to be Wired Portss?

tmo26 wrote:

The permanent note makes me think about modularizing it, in order not to repeat it 921 times in the source.
I think I somewhere read about this... need to search a bit.

Found the solution: See Infoboxes and how they are included in other pages: http://wiki.openwrt.org/meta/infoboxes

-> create new infobox "meta:infobox:dataentry_permanote"
-> put "{{page>meta:infobox:dataentry_permanote&noheader&nofooter&noeditbtn}}" in dataentry pages

This way we have only one page for the permanent note which we can easily use on as many dataentry pages as we like.
We want to change the permanent note? Do it once, and it will be done for all devices.

@zo0ok: Coool, including the new columns was a quick one smile Thanks for that!
Now we see: Roughly 90% of the devices have no information about detachable antennas, serial or JTAG.
I expected more devices with useful information...

tmo26 wrote:
zo0ok wrote:

Wired Ports dont need to be Wired Portss?

Uhm... they are already like this (2x s): http://wiki.openwrt.org/toh/dataentry_template

Yes, but I deleted the second s becuase I dont know why it is there?
Can we use ß instead?

I also added the modem column.

tmo26 wrote:

Now we see: Roughly 90% of the devices have no information about detachable antennas, serial or JTAG.
I expected more devices with useful information...

I actually thought something was wrong since we got so few hits. And I have been doing some hacking to allow different spellings of Antenna and different Serial headers. If something is still missing just correct the table header.

Now we need to set up an algorithm to decide device type:
- Dev board
- Router
- Modem
- Unknown
- Other

LOL, no, we can not replace 'ss' by 'ß' smile
Keep in mind, that for computers, it even makes a difference if you use . or ,

Meaning of Wired Portss: The second 's' tells the plugin, that multiple values are allowed in this case.
Well, we could also have Ports_, depending on how we want to show the different possibilities for the Wired Ports.

1) Portss: We list different wired ports separated by comma, e.g. "4x Gbit, ADSL2+" -> multiple values
2) Ports_: We list different wired ports 'separated' by '+', e.g. "4x Gbit + ADSL2+" -> only a single value
(Not really separated by '+', since it's not recognized as separator)

Confusion complete? %-)

zo0ok wrote:

I also added the modem column.

Wow, also very few with useful input.
How comes there are so few devices with modem?
I threw out my separate modem years ago...

zo0ok wrote:

But
Ports == Portss
??? since they both end in s???

OK, let me explain it this way:
The plugin assumes, that every word ending in 's' means: multiple values allowed.
Since the plugin recognizes the s as a marker only, it removes the s when you normally view the page, hence "Ports" becoming "Port". If you want to keep the s (since it's part of the word you want to show) AND allow multiple values, you have to add a second s: "Portss" in the wikisource becomes "Ports" in the displayed page.

Status_: We want a single value only, therefore we need to tell the plugin, that the s in Status does not mean "multiple values allowed", but rather "the s belongs to  the word, do not remove it!"


wikisource vs. displayed page:
"Status" becomes "Statu" (s=multiple values allowed)
"Status_" becomes "Status" (_=s is part of the word; single value allowed)
"Statuss" becomes "Status" (1st s belongs to word, 2nd s=multiple values allowed)

if ( $last_character == 's' ); then
remove_s_in_displayed_page && multiple_values=true
fi

(Last edited by tmo26 on 11 Jun 2015, 23:54)

NOW I get it!

I will fix Wired Portß tomorrow.
You probably come up with more things to change.

Hmpf, with all that writing, I missed my 1000th posting. Damn.
But 2^10 is coming... ;-)

zo0ok wrote:

@drawz: good to see that someone else is following this topic. Sometimes it makes me worried we are three people in a bubble wink

I contribute where I can. I have the same goal as all of you smile

Keep up the great work!

(Last edited by drawz on 12 Jun 2015, 06:34)

tmo26 wrote:

Hmpf, with all that writing, I missed my 1000th posting. Damn.
But 2^10 is coming... ;-)

I was about to remind you when you were on 999. Perhaps on 1023 then.

I updated (with Wired Portss):
  https://dl.dropboxusercontent.com/u/906 … index.html
  https://dl.dropboxusercontent.com/u/906 … ikitxt.tgz

The only thing I am aware of that I need to do with the Data Entry generation is to fix reasonable default values for Device Type:
  Modem (Modem Colum has a meaningful value)
  Single Card Computer (Perhaps the brands give it away, or the target. 1 wired port)
  Router (2+ wired ports, no WiFi)
  WiFi Router (2+ wired ports, WiFi)
  Other (PC, Qemu, Printservers, etc)
Is this a reasonable start?

Anything else I have forgotten that needs to be done (with the Data Entry generation)?

zo0ok wrote:

The only thing I am aware of that I need to do with the Data Entry generation is to fix reasonable default values for Device Type:
  Modem (Modem Colum has a meaningful value)
  Single Card Computer (Perhaps the brands give it away, or the target. 1 wired port)
  Router (2+ wired ports, no WiFi)
  WiFi Router (2+ wired ports, WiFi)
  Other (PC, Qemu, Printservers, etc)
Is this a reasonable start?

I have no better proposal. If richb or anybody else has no more change requests: Lets start with this.

I have started to work on a details page for a couple routers, WNDR3700 & WNDR3800 from Netgear. The work is nowhere near complete, but you can see what I have so far:

http://wiki.openwrt.org/playground/testpage and
http://wiki.openwrt.org/toh/netgear/wndr3800

The first is my playground for trying a few variations of creating a datatable with various columns and filter criteria. The second is the current WNDR3800 page, with its dataentry saved at the end.

I have come to a few conclusions regarding the field names for the dataentry template:

  1. Question: Brand vs Vendor vs Manufacturer... "Brand" feels a little imprecise in English; I'd be happier with "Vendor". That term is also used in "Vendor Device_url" field name, and is used quite widely throughout the Wiki.

  2. I am going to recommend that we switch to using these field names in the template. They're short and sensible, and people will get the column names right when they build their own datatables.
        - Device Page_page : 
        - Device Techdata_pageid :
        - Forum Topic_urls  :  <-- Plural, because people might list several topics. "s" goes on end of type
        - WikiDevi_url  :
        - Vendor Device_url  :
        - Stock Firmware_url :
        - OpenWrt factory-img_url :
        - OpenWrt sysupgrade-img_url :
        - Pictures_urls :       <-- plural - "s" is the final letter

  3. re: including "URL" in the field name. The dataentry template allows a comment that can give guidance for the kind of info to enter. (This addresses the concern of limited attention and people not knowing what to add. We don't need to add it to the field name itself.) To see what I mean, go to http://wiki.openwrt.org/playground/testpage and edit the dataentry there. The comments appear on the right.

  4. re: s/ss/s_/ß I think that only fields with the _page and _url types need to worry about plurals/multiples. Other things like wired ports, etc. are simply strings that don't require any special processing by Dokuwiki or people.

  5. Do we have a field that contains a link back to its dataentry? This would be convenient for a device page to be able to link to the dataentry page, so that a person could edit it.

Update: dataentry pages are at:

WNDR3700v1: http://wiki.openwrt.org/playground/wndr3700
WNDR3700v2: http://wiki.openwrt.org/playground/wndr3700v2
WNDR3700v3: http://wiki.openwrt.org/playground/wndr3700v3
WNDR3700v4: http://wiki.openwrt.org/playground/wndr3700v4
WNDR3700v5: http://wiki.openwrt.org/playground/wndr3700v5
WNDR3800: http://wiki.openwrt.org/toh/netgear/wndr3800

(Last edited by richbhanover on 12 Jun 2015, 23:00)

Imported into my demowiki, now updating the searchindex (needed to get the contents of the pages into the data-plugins sqliste db, or in short: needed to get this whole thing working smile). Will take approx. 20min time on my rpi2 - and this is only 929 pages to update.

I assume, the openwrt wiki has lots more pages, hence taking longer time for the searchindex update -> The real openwrt wiki import of the datapages should be done in the nightly low traffic hours, presumably 0200 GMT (or @admins choice, he knows better than me smile)

@tmo26 - the forum server has seemed slow today. I reported to jow, nbd, and glp that it had stopped this morning. It's up, but seems to be laboring mightily. Is there a better e-mail address to send reports to?